socket.h

Go to the documentation of this file.

 
#ifndef _SOCKET_BASE_CLASS_HEADER_
#define _SOCKET_BASE_CLASS_HEADER_
 
namespace A_UTILS_NS
{
 
 
class DOEXPORT cSocket
{
    A_UTILS_D(cSocket)
 
    private:
        static std::atomic<tInt>   m_nSocketLibInitCounter;
 
    public:
        static const tUInt32    SOCKET_NO_ADDRESS;
 
    protected:
        tSocketHandle           m_hSocket;
        tUInt32                 m_ui32Address;
        tInt                    m_nPort;
 
    public:
 
        typedef enum
        {
            OM_Block = 0x0,     //< Standard blocking mode
            OM_NonBlock = 0x01   //< Non-blocking mode.
        } tOpenMode;
 
        typedef enum
        {
            SM_Read        = 0, //< Shutdown in read-direction only.
            SM_Write       = 1, //< Shutdown in write-direction only.
            SM_ReadWrite   = 2  //< Shutdown in both directions (clean shutdown).
        } tShutdownMode;
 
    public:
        static tVoid AddLibraryRef();
        static tVoid ReleaseLibraryRef();
 
    public:
        cSocket();
        virtual ~cSocket();
 
        tVoid Close();
 
        tVoid Close(tShutdownMode nHow);
 
        tUInt32 GetAddress() const;
 
        tInt GetPort() const;
 
        tSocketHandle GetHandle() const;
 
        static cString GetHostName(tUInt32 dwHostAddress=0);
        static tUInt32 GetHostAddress(const cString& strHostName=cString());
 
        static tUInt32 AddressToUInt32(const cString& strAddress);
 
        static cString UInt32ToAddress(tUInt32 ui32Address);
 
        static tInt GetLastErrorCode();
 
        static tResult GetLocalAddresses(std::set< tUInt32, std::less< tUInt32 >, std::allocator< tUInt32 > >& oAddresses);
 
        static tResult SocketError(tInt nSocketError);
 
        static tResult FindInterfaceForAddress(tUInt32  ui32FarAddress,
                                               tUInt32& ui32LocalAddress);
 
    public:
        typedef enum {
            OL_SOCKET = 1,
            OL_IPPROTO_TCP = 2,
            OL_IPPROTO_IP = 3,
        } tOptionLevel;
 
        typedef enum {
            OI_DEBUG,
            OI_BROADCAST,
            OI_REUSEADDR,
            OI_KEEPALIVE,
            OI_LINGER,
            OI_SNDBUF,
            OI_RCVBUF,
            OI_DONTROUTE,
            OI_TCP_NODELAY,
            OI_IP_MULTICAST_LOOP
        } tOptionId;
 
        tBool SetTimeout(tTimeStamp nReadTimeout=-1, tTimeStamp nWriteTimeout=-1);
 
 
        virtual tBool IsConnected(tTimeStamp nTimeout = 0);
 
        tBool DataAvailable();
 
        tBool WaitForData(tTimeStamp nTimeout=-1);
 
        static tResult WaitForData(const std::list<cSocket*>& i_lstSockets,
                                   cSocket** o_ppSocket,
                                   tTimeStamp tmTimeOut = -1);
 
        tInt SetOption(tInt nLevel, tInt nOptionId, const tVoid* pValue, tInt nValueLen);
 
        tInt SetOption(cSocket::tOptionLevel eLevel, cSocket::tOptionId eId, const tVoid* pValue, tInt nValueLen);
 
        tResult GetOption(tInt nLevel, tInt nOptionId, tVoid* o_pValue, tInt* o_pValueLen);
 
 
        tResult GetOption(cSocket::tOptionLevel eLevel, cSocket::tOptionId eId, tVoid* o_pValue, tInt* o_pValueLen);
 
    protected:
        tBool Initialize();
 
        tInt ResolveOptionLevel(tOptionLevel level) const;
 
        tInt ResolveOptionId(tOptionId id) const;
};
 
} // namespace A_UTILS_NS
 
#endif // _SOCKET_BASE_CLASS_HEADER_