HLH_Sock.h

   1 /*******************************************************************************
   2  *         File : HLH_Sock.h
   3  *
   4  *       Author : Henry He
   5  *      Created : 2009-10-8 13:55:48
   6  *  Description :
   7  ******************************************************************************/
   8
   9 #ifndef __HLH_SOCK_INC_20091008_135548_HENRY__
  10 #define __HLH_SOCK_INC_20091008_135548_HENRY__
  11
  12
  13 /*******************************************************************************
  14  * Desc : Includes Files
  15  ******************************************************************************/
  16
  17 #include "HLH_utils/typedef.h"
  18 #include "HLH_utils/HLH_Time.h"
  19 #include "HLH_utils/HLH_Thread.h"
  20
  21
  22 /*******************************************************************************
  23  * Desc : Macro Definations
  24  ******************************************************************************/
  25
  26
  27 ////////////////////////////////////////////////////////////////////////////////
  28 // Poll Types
  29
  30 #define HLH_SOCK_POLL_READ                              0x01
  31 #define HLH_SOCK_POLL_WRITE                             0x02
  32 #define HLH_SOCK_POLL_ERROR                             0x04
  33
  34 ////////////////////////////////////////////////////////////////////////////////
  35 // Error Types
  36
  37 #define HLH_SOCK_ERR_FAILED                             (-1)
  38 #define HLH_SOCK_ERR_ALREADY_CREATED                    (-2)
  39 #define HLH_SOCK_ERR_CANT_CREATE                        (-3)
  40 #define HLH_SOCK_ERR_NOT_CREATED                        (-4)
  41
  42 ////////////////////////////////////////////////////////////////////////////////
  43 // Default Values
  44
  45 #define HLH_SOCK_DEFAULT_LISTEN_QUEUE_NUM               10
  46
  47
  48 /*******************************************************************************
  49  * Desc : Type Definations
  50  ******************************************************************************/
  51
  52 ////////////////////////////////////////////////////////////////////////////////
  53 // Socket type
  54
  55 typedef enum HLH_SockType
  56 {
  57         HLH_SOCK_TYPE_STREAM = 0x01,
  58         HLH_SOCK_TYPE_DGRAM  = 0x02
  59 } HLH_SockType;
  60
  61
  62
  63 /*******************************************************************************
  64  * Desc : Global Variables
  65  ******************************************************************************/
  66
  67
  68 /*******************************************************************************
  69  * Desc : Classes
  70  ******************************************************************************/
  71
  72
  73
  74
  75 ////////////////////////////////////////////////////////////////////////////////
  76 // Socket Address : simple wrapper of sockaddr_t
  77
  78 class HLH_SockAddr
  79 {
  80         friend class HLH_Sock;
  81
  82         public:
  83
  84         /******************************************************************************
  85          * Desc : Constructor / Deconstructor
  86          ******************************************************************************/
  87
  88         HLH_SockAddr () {
  89                 m_saAddr.sin_addr.s_addr = htonl ( INADDR_ANY );
  90                 m_saAddr.sin_port        = htons ( rand() & 0xFFFF );
  91                 m_saAddr.sin_family      = AF_INET;
  92         }
  93
  94         HLH_SockAddr (UINT32 unIP, UINT16 usPort, sa_family_t sfFamily = AF_INET) {
  95                 m_saAddr.sin_addr.s_addr = htonl ( unIP );
  96                 m_saAddr.sin_port        = htons ( usPort );
  97                 m_saAddr.sin_family      = sfFamily;
  98         }
  99
 100         HLH_SockAddr (const char *pcIP, UINT16 usPort, sa_family_t sfFamily = AF_INET) {
 101                 m_saAddr.sin_addr.s_addr = inet_addr ( pcIP );
 102                 m_saAddr.sin_port        = htons ( usPort );
 103                 m_saAddr.sin_family      = sfFamily;
 104         }
 105
 106         ~HLH_SockAddr () { }
 107
 108         /******************************************************************************
 109          * Desc : Operations
 110          ******************************************************************************/
 111
 112         struct sockaddr * GetAddrPointer () const  { return (struct sockaddr *)(&m_saAddr); }
 113
 114         UINT32 GetAddrLen  () const                { return sizeof (m_saAddr); }
 115
 116         void SetAddr (struct sockaddr_in &saAddr) {
 117                 m_saAddr = saAddr;
 118         }
 119
 120         void SetAddr (UINT32 unIP, UINT16 usPort, sa_family_t sfFamily = AF_INET) {
 121                 m_saAddr.sin_addr.s_addr = htonl ( unIP );
 122                 m_saAddr.sin_port        = htons ( usPort );
 123                 m_saAddr.sin_family      = sfFamily;
 124         }
 125
 126         void SetAddr (const char *pcIP, UINT16 usPort, sa_family_t sfFamily = AF_INET) {
 127                 m_saAddr.sin_addr.s_addr = inet_addr (pcIP);
 128                 m_saAddr.sin_port        = htons ( usPort );
 129                 m_saAddr.sin_family      = sfFamily;
 130         }
 131
 132         void SetAddrFamily (sa_family_t sfFamily) {
 133                 m_saAddr.sin_family      = sfFamily;
 134         }
 135
 136         void SetAddrPort (UINT16 usPort) {
 137                 m_saAddr.sin_port        = htons ( usPort );
 138         }
 139
 140         void SetAddrIP (UINT32 unIP) {
 141                 m_saAddr.sin_addr.s_addr = htonl ( unIP );
 142         }
 143
 144         int SetAddrIP (const char *pcIP) {
 145     in_addr_t s_addr;
 146
 147                 s_addr = inet_addr (pcIP);
 148     if ( s_addr == (in_addr_t)(-1) ) {
 149       return -1;
 150     }
 151                 m_saAddr.sin_addr.s_addr = inet_addr (pcIP);
 152     return 0;
 153         }
 154
 155
 156   bool operator == (const HLH_SockAddr &zhsAddr) const {
 157     return ( m_saAddr.sin_addr.s_addr == zhsAddr.m_saAddr.sin_addr.s_addr
 158         &&   m_saAddr.sin_port        == zhsAddr.m_saAddr.sin_port
 159         &&   m_saAddr.sin_family      == zhsAddr.m_saAddr.sin_family );
 160   }
 161
 162         private:
 163         struct sockaddr_in m_saAddr;
 164 };
 165
 166
 167
 168 ////////////////////////////////////////////////////////////////////////////////
 169 // Class of HLH_Sock: simple wrapper of socket funtions
 170
 171 class HLH_Sock
 172 {
 173
 174         public:
 175                 /******************************************************************************
 176                  * Desc : Constructor / Deconstructor
 177                  ******************************************************************************/
 178                 HLH_Sock ();
 179                 ~HLH_Sock ();
 180
 181         public:
 182                 /******************************************************************************
 183                  * Desc : Common Operations
 184                  ******************************************************************************/
 185
 186                 // Initialize the socket and bind it
 187                 int Create (HLH_SockType zhsSockType,
 188                                 const HLH_SockAddr &zhsSockAddr, bool bNonblocking = false);
 189
 190                 // Initialize the socket from a initialized socket
 191                 int Create (int fdSock, bool bNonblocking = false);
 192
 193                 // Whether this socket created
 194                 bool IsCreated ();
 195
 196                 // Listen for socket connections and limit the queue of incoming connections
 197                 int Listen (UINT32 unQueue = HLH_SOCK_DEFAULT_LISTEN_QUEUE_NUM);
 198
 199                 // Requests a connection to be made on a socket
 200                 int Connect (const HLH_SockAddr &zhsSockAddr);
 201
 202                 // Extracts the first connection on the queue of pending connections,
 203                 // creates a new socket with the same socket type protocol and address family as the specified socket,
 204                 // and allocates a new file descriptor for that socket
 205                 int Accept (HLH_SockAddr &zhsSockAddr);
 206
 207                 // Initiates transmission of a message from the specified socket to its peer
 208                 int Send (const void *pvBuf, UINT32 unLen, UINT32 unFlags = 0);
 209
 210                 // Receives a message from a connection-mode or connectionless-mode socket
 211                 int Recv (void *pvBuf, UINT32 unLen, UINT32 unFlags = 0);
 212
 213                 // Sends a message through a connection-mode or connectionless-mode socket
 214                 int SendTo (const void *pvBuf, UINT32 unLen,
 215                                 const HLH_SockAddr &zhsSockAddr, UINT32 unFlags);
 216
 217                 // Receives a message from a connection-mode or connectionless-mode socket
 218                 int RecvFrom (void *pvBuf, UINT32 unLen,
 219                                 HLH_SockAddr &zhsSockAddr, UINT32 unFlags = 0);
 220
 221                 // Destroy the socket (wait until send/pollwait operations finished)
 222                 int Destroy ();
 223
 224
 225
 226
 227                 /******************************************************************************
 228                  * Desc : Poll Operations
 229                  ******************************************************************************/
 230
 231                 // Poll for specific events
 232                 int Poll (UINT32 &unPollType);
 233
 234                 // Poll for specific events until time eclipsed
 235                 int PollWait (UINT32 &unPollType, HLH_Time &zhtTime);
 236
 237
 238         private:
 239                 /******************************************************************************
 240                  * Desc : Private Data
 241                  ******************************************************************************/
 242
 243                 // socket file descriptor
 244                 int             m_fdSocket;
 245
 246                 // Whether this socket is created
 247                 bool            m_bCreated;
 248
 249
 250                 // Master Lock of HLH_Sock
 251                 HLH_Mutex       m_zhmMainMutex;
 252
 253                 // Read Lock
 254                 HLH_Mutex       m_zhmRecvMutex;
 255
 256                 // Write Lock
 257                 HLH_Mutex       m_zhmSendMutex;
 258
 259
 260                 // Poll file discriptor set: initialized when created
 261                 fd_set          m_fsReadSet;
 262                 fd_set          m_fsWriteSet;
 263                 fd_set          m_fsErrorSet;
 264
 265 };
 266
 267
 268
 269
 270
 271
 272 #endif /* __HLH_SOCK_INC_20091008_135548_HENRY__ */