CSocket project page

CSocket home page

---

SimpleSocket.h

Go to the documentation of this file.

/*---------------------------------------------------------------------------*/
/*                                                                           */
/* SimpleSocket.h - Simple Socket base class decleration.                    */
/*                                                                           */
/* Author : Mark Carrier (mark@carrierlabs.com)                              */
/*                                                                           */
/*---------------------------------------------------------------------------*/
/* Copyright (c) 2007-2009 CarrierLabs, LLC.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * 4. The name "CarrierLabs" must not be used to
 *    endorse or promote products derived from this software without
 *    prior written permission. For written permission, please contact
 *    mark@carrierlabs.com.
 *
 * THIS SOFTWARE IS PROVIDED BY MARK CARRIER ``AS IS'' AND ANY
 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL MARK CARRIER OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 *----------------------------------------------------------------------------*/
#ifndef __SOCKET_H__
#define __SOCKET_H__

#include <sys/stat.h>
#include <stdlib.h>
#include <stdio.h>
#include <stdarg.h>
#include <errno.h>

#if defined(_LINUX) || defined (_DARWIN)
  #include <sys/socket.h>
  #include <netinet/in.h>
  #include <arpa/inet.h>
  #include <netinet/tcp.h>
  #include <netinet/ip.h>
  #include <netdb.h>
#endif
#ifdef _LINUX
  #include <linux/if_packet.h>
  #include <linux/if_packet.h>
  #include <linux/if_ether.h>
  #include <linux/if.h>
  #include <sys/sendfile.h>
#endif
#if defined(_LINUX) || defined (_DARWIN)
  #include <sys/time.h>
  #include <sys/uio.h>
  #include <unistd.h>   
  #include <fcntl.h>
#endif
#ifdef WIN32
  #include <io.h>
  #include <winsock2.h>
  #include <Ws2tcpip.h>

  #define IPTOS_LOWDELAY  0x10  

#endif
#include "Host.h"
#include "StatTimer.h"

//-----------------------------------------------------------------------------
// General class macro definitions and typedefs
//-----------------------------------------------------------------------------
#ifndef INVALID_SOCKET
  #define INVALID_SOCKET    ~(0)
#endif

#define SOCKET_SENDFILE_BLOCKSIZE 8192

class CSimpleSocket {
public:
    typedef enum 
    {
        Receives = SHUT_RD, 
        Sends = SHUT_WR,    
        Both = SHUT_RDWR    
    } CShutdownMode; 

    typedef enum  
    {
        SocketTypeInvalid,   
        SocketTypeTcp,       
        SocketTypeUdp,       
        SocketTypeTcp6,      
        SocketTypeUdp6,      
        SocketTypeRaw        
    } CSocketType;

    typedef enum 
    {
        SocketError = -1,          
        SocketSuccess = 0,         
        SocketInvalidSocket,       
        SocketInvalidAddress,      
        SocketInvalidPort,         
        SocketConnectionRefused,   
        SocketTimedout,            
        SocketEwouldblock,         
        SocketNotconnected,        
        SocketEinprogress,         
        SocketInterrupted,         
        SocketConnectionAborted,   
        SocketProtocolError,       
        SocketFirewallError,       
        SocketInvalidSocketBuffer, 
        SocketConnectionReset,     
        SocketAddressInUse,        
        SocketInvalidPointer,      
        SocketEunknown             
    } CSocketError;

public:
    CSimpleSocket(CSocketType type = SocketTypeTcp);
    CSimpleSocket(CSimpleSocket &socket);

    virtual ~CSimpleSocket() 
    {
        if (m_pBuffer != NULL)
        {
            delete [] m_pBuffer;
            m_pBuffer = NULL;
        }
    };

    virtual bool Initialize(void);

    virtual bool Close(void);

    virtual bool Shutdown(CShutdownMode nShutdown);

    virtual bool Select(void) { return Select(0,0); };

    virtual bool Select(int32 nTimeoutSec, int32 nTimeoutUSec);

    virtual bool IsSocketValid(void) { return (m_socket != SocketError); };

    void TranslateSocketError(void);

    virtual int32 Receive(int32 nMaxBytes = 1);

    virtual int32 Send(const uint8 *pBuf, size_t bytesToSend);

    virtual int32 Send(const struct iovec *sendVector, int32 nNumItems);

    virtual int32 SendFile(int32 nOutFd, int32 nInFd, off_t *pOffset, int32 nCount);

    bool IsNonblocking(void) { return (m_bIsBlocking == false); };

    bool SetBlocking(void);

    bool SetNonblocking(void);

    uint8 *GetData(void)  { return m_pBuffer; };

    int32 GetBytesReceived(void) { return m_nBytesReceived; };

    int32 GetBytesSent(void) { return m_nBytesSent; };

    bool SetOptionLinger(bool bEnable, uint16 nTime);

    bool SetOptionReuseAddr();

    int32 GetConnectTimeoutSec(void) { return  m_stConnectTimeout.tv_sec; };

    int32 GetConnectTimeoutUSec(void) { return  m_stConnectTimeout.tv_usec; };

    void SetConnectTimeout(int32 nConnectTimeoutSec, int32 nConnectTimeoutUsec = 0) 
    { 
        m_stConnectTimeout.tv_sec = nConnectTimeoutSec; 
        m_stConnectTimeout.tv_usec = nConnectTimeoutUsec; 
    };

    int32 GetReceiveTimeoutSec(void) { return  m_stRecvTimeout.tv_sec; };

    int32 GetReceiveTimeoutUSec(void) { return  m_stRecvTimeout.tv_usec; };

    bool SetReceiveTimeout(int32 nRecvTimeoutSec, int32 nRecvTimeoutUsec = 0);

    bool SetMulticast(bool bEnable, uint8 multicastTTL = 1);

    bool GetMulticast() { return m_bIsMulticast; };

    bool BindInterface(uint8 *pInterface);

    int32 GetSendTimeoutSec(void) { return  m_stSendTimeout.tv_sec; };

    int32 GetSendTimeoutUSec(void) { return  m_stSendTimeout.tv_usec; };

    bool SetSendTimeout(int32 nSendTimeoutSec, int32 nSendTimeoutUsec = 0);

    CSocketError GetSocketError(void) { return m_socketErrno; };

    uint32 GetTotalTimeMs() { return m_timer.GetMilliSeconds(); };

    uint32 GetTotalTimeUsec() { return m_timer.GetMicroSeconds(); };

    int GetSocketDscp(void);

    bool SetSocketDscp(int nDscp);

    SOCKET GetSocketDescriptor() { return m_socket; };

    CSocketType GetSocketType() { return m_nSocketType; };

    uint8 *GetClientAddr() { return (uint8 *)inet_ntoa(m_stClientSockaddr.sin_addr); };

    int16 GetClientPort() { return m_stClientSockaddr.sin_port; };

    uint8 *GetServerAddr() { return (uint8 *)inet_ntoa(m_stServerSockaddr.sin_addr); };

    int16 GetServerPort() { return ntohs(m_stServerSockaddr.sin_port); };

    uint16 GetReceiveWindowSize() { return GetWindowSize(SO_RCVBUF); };

    uint16 GetSendWindowSize() { return GetWindowSize(SO_SNDBUF); };

    uint16 SetReceiveWindowSize(uint16 nWindowSize) { return SetWindowSize(SO_RCVBUF, nWindowSize); };

    uint16 SetSendWindowSize(uint16 nWindowSize) { return SetWindowSize(SO_SNDBUF, nWindowSize); };

    bool DisableNagleAlgoritm();

    bool EnableNagleAlgoritm();


protected:
    void SetSocketError(CSimpleSocket::CSocketError error) { m_socketErrno = error; };

    void SetSocketHandle(SOCKET socket) { m_socket = socket; };

private:
    uint16 GetWindowSize(uint32 nOptionName);

    uint16 SetWindowSize(uint32 nOptionName, uint32 nWindowSize);


    int32 Writev(const struct iovec *pVector, size_t nCount);

    bool Flush();

    CSimpleSocket *operator=(CSimpleSocket &socket);

protected:
    SOCKET               m_socket;            
    CSocketError         m_socketErrno;       
    uint8               *m_pBuffer;           
    int32                m_nBufferSize;       
    int32                m_nSocketDomain;     
    CSocketType          m_nSocketType;       
    int32                m_nBytesReceived;    
    int32                m_nBytesSent;        
    uint32               m_nFlags;            
    bool                 m_bIsBlocking;       
    bool                 m_bIsMulticast;      
    struct timeval       m_stConnectTimeout;  
    struct timeval       m_stRecvTimeout;     
    struct timeval       m_stSendTimeout;     
    struct sockaddr_in   m_stServerSockaddr;  
    struct sockaddr_in   m_stClientSockaddr;  
    struct sockaddr_in   m_stMulticastGroup;  
    struct linger        m_stLinger;          
    CStatTimer           m_timer;             
#ifdef WIN32
    WSADATA              m_hWSAData;          
#endif 
    fd_set               m_writeFds;          
    fd_set               m_readFds;           
    fd_set               m_errorFds;          
};


#endif /*  __SOCKET_H__  */

---

hosts this site.

Send comments to: CarrierLabs Developers