IpSocket.hpp

Go to the documentation of this file.

// ======================================================================
// \title  IpSocket.hpp
// \author mstarch
// \brief  hpp file for IpSocket core implementation classes
//
// \copyright
// Copyright 2009-2020, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================
#ifndef DRV_IP_IPHELPER_HPP_
#define DRV_IP_IPHELPER_HPP_

#include <Fw/FPrimeBasicTypes.hpp>
#include <Os/Mutex.hpp>
#include <config/IpCfg.hpp>

// MSG_NOSIGNAL must be visible when SEND_NO_SIGNAL_FLAGS is defined below, independent of what IpCfg.hpp includes
#ifdef TGT_OS_TYPE_VXWORKS
#include <sockLib.h>
#include <socket.h>
#elif defined(TGT_OS_TYPE_LINUX) || defined(TGT_OS_TYPE_DARWIN)
#include <sys/socket.h>
#endif

namespace Drv {

struct SocketDescriptor final {
    int fd = -1;        
    int serverFd = -1;  
};

enum SocketIpStatus {
    SOCK_SUCCESS = 0,                        
    SOCK_FAILED_TO_GET_SOCKET = -1,          
    SOCK_FAILED_TO_GET_HOST_IP = -2,         
    SOCK_INVALID_IP_ADDRESS = -3,            
    SOCK_FAILED_TO_CONNECT = -4,             
    SOCK_FAILED_TO_SET_SOCKET_OPTIONS = -5,  
    SOCK_INTERRUPTED_TRY_AGAIN = -6,         
    SOCK_READ_ERROR = -7,                    
    SOCK_DISCONNECTED = -8,                  
    SOCK_FAILED_TO_BIND = -9,                
    SOCK_FAILED_TO_LISTEN = -10,             
    SOCK_FAILED_TO_ACCEPT = -11,             
    SOCK_SEND_ERROR = -13,                   
    SOCK_NOT_STARTED = -14,                  
    SOCK_FAILED_TO_READ_BACK_PORT = -15,     
    SOCK_NO_DATA_AVAILABLE = -16,            
    SOCK_ANOTHER_THREAD_OPENING = -17,       
    SOCK_AUTO_CONNECT_DISABLED = -18,        
    SOCK_INVALID_CALL = -19                  
};

class IpSocket {
  public:
    IpSocket();
    virtual ~IpSocket() {};
    virtual SocketIpStatus configure(const char* const ipv4_address,
                                     const U16 port,
                                     const U32 send_timeout_seconds,
                                     const U32 send_timeout_microseconds);

    SocketIpStatus open(SocketDescriptor& socketDescriptor);
    virtual SocketIpStatus send(const SocketDescriptor& socketDescriptor, const U8* const data, const FwSizeType size);
    SocketIpStatus recv(const SocketDescriptor& fd, U8* const data, FwSizeType& size);

    void close(const SocketDescriptor& socketDescriptor);

    void shutdown(const SocketDescriptor& socketDescriptor);

  protected:
    virtual bool isValidPort(U16 port) const;

    SocketIpStatus setupTimeouts(int socketFd);

#ifdef MSG_NOSIGNAL
    static constexpr int SEND_NO_SIGNAL_FLAGS = MSG_NOSIGNAL;
#else
    static constexpr int SEND_NO_SIGNAL_FLAGS = 0;
#endif

    SocketIpStatus setupNoSigPipe(int socketFd);

    static SocketIpStatus addressToIp4(const char* const ipv4_address, void* const out);
    virtual SocketIpStatus openProtocol(SocketDescriptor& fd) = 0;
    virtual FwSignedSizeType sendProtocol(const SocketDescriptor& socketDescriptor,
                                          const U8* const data,
                                          const FwSizeType size) = 0;

    virtual FwSignedSizeType recvProtocol(const SocketDescriptor& socketDescriptor,
                                          U8* const data,
                                          const FwSizeType size) = 0;

    virtual SocketIpStatus handleZeroReturn();

    SocketIpStatus setupSocketOptions(int socketFd);

    U32 m_timeoutSeconds;
    U32 m_timeoutMicroseconds;
    U16 m_port;                                         
    char m_ipv4_address[SOCKET_MAX_IPV4_ADDRESS_SIZE];  
};
}  // namespace Drv

#endif /* DRV_SOCKETIPDRIVER_SOCKETHELPER_HPP_ */