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 <FpConfig.hpp>
#include <IpCfg.hpp>
#include <Os/Mutex.hpp>
 
namespace Drv {
 
struct SocketDescriptor final {
    PlatformIntType fd = -1; 
    PlatformIntType 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        
};
 
class IpSocket {
  public:
    IpSocket();
    virtual ~IpSocket(){};
    SocketIpStatus configure(const char* hostname, const U16 port, const U32 send_timeout_seconds,
                             const U32 send_timeout_microseconds);
 
    SocketIpStatus open(SocketDescriptor& socketDescriptor);
    SocketIpStatus send(const SocketDescriptor& socketDescriptor, const U8* const data, const U32 size);
    SocketIpStatus recv(const SocketDescriptor& fd, U8* const data, U32& size);
 
    void close(const SocketDescriptor& socketDescriptor);
 
    void shutdown(const SocketDescriptor& socketDescriptor);
 
  PROTECTED:
    virtual bool isValidPort(U16 port);
 
    SocketIpStatus setupTimeouts(PlatformIntType socketFd);
 
    static SocketIpStatus addressToIp4(const char* address, void* ip4);
    virtual SocketIpStatus openProtocol(SocketDescriptor& fd) = 0;
    virtual I32 sendProtocol(const SocketDescriptor& socketDescriptor, const U8* const data, const U32 size) = 0;
 
    virtual I32 recvProtocol(const SocketDescriptor& socketDescriptor, U8* const data, const U32 size) = 0;
 
    U32 m_timeoutSeconds;
    U32 m_timeoutMicroseconds;
    U16 m_port;  
    char m_hostname[SOCKET_MAX_HOSTNAME_SIZE];  
};
}  // namespace Drv
 
#endif /* DRV_SOCKETIPDRIVER_SOCKETHELPER_HPP_ */