---

serversocket.h

Go to the documentation of this file.

/********************************************************************
       Copyright (c) 2001, Lee Patterson & Ant Works Software
       http://ssobjects.sourceforge.net

       created  :  November 21, 2000
       filename :  serversocket.h
       author   :  Lee Patterson (lee@antws.com)

       purpose  :  Handles buffered socket operations.

*********************************************************************/

#ifndef SERVERSOCKET_H
#define SERVERSOCKET_H

#ifdef _WIN32
#   include <time.h>
#else
#   include <sys/time.h>
#   include <unistd.h>
#endif

#include "packetbuffer.h"
#include "flags.h"
#include "linkedlist.h"
#include "bufferedsocket.h"
#include "threadutils.h"
#include "packetmessageque.h"

namespace ssobjects
{

#define throwServerSocketException(m) (throw ServerSocketException(m,__FILE__,__LINE__))

class ServerSocketException : public GeneralException
{
  public: // Constructor/destructor
    ServerSocketException(char* pchMessage,const char* pFname,const int iLine) 
      : GeneralException(pchMessage,pFname,iLine){};
};

class ServerHandler;

class ServerSocket : public SocketInstance
{
  public:   //enums
    enum
      {
      modeInvalid         = 0,

      modeWriteOkay = 1,    //it is okay for the write thread to write to this socket
      modeSendOkay  = 2,    //it is okay to send more packets to this socket (send
      modeReadOkay  = 4,    //it is okay to read data from this socket
      modeClosing   = 8,    //socket should be closed next call to CleanSockets 
      modeNotified  = 16,   //a message to have this socket removed has been sent to server
      modeClosed    = 32,   //this socket has been closed, and is now free

      modeValid=modeSendOkay|modeWriteOkay|modeReadOkay,        //socket is connected, and everything is okay

      modeAll=0xFFFFFFFF
      };

  public:
    ServerSocket(const unsigned32 nBufferSize=18000,const int iTimeout=DEFAULT_SOCKET_TIMEOUT);
    ServerSocket(const SocketInstance& socket,const SockAddr& sa,const unsigned32 nBuffSize,const int iTimeout);
    virtual ~ServerSocket();

    void            sendPacket(const PacketBuffer& packet);             
    void            sendPacket(const PacketBuffer* const ppacket);      
    void            sendBuffer();                                   
    int             readData();                                     
    PacketBuffer*       extractPacket();                                
    const Flags&    flags() const {return m_flags;}                         
    unsigned32      getOutBufferSize() const {return m_nBytesOut;}          
    unsigned32      getOutBufferSizeMax() const {return m_nBufferSizeMax;}  
    unsigned32      getInBufferSize() const  {return m_nBytesIn;}           
    unsigned32      getBufferSizeMax() const {return m_nBufferSizeMax;}     
    SockAddr        getAddr() const {return m_socketAddr;}                  
    int             socketTimeout() const {return m_iTimeout;}              
    ServerHandler* serverHandler() const {return m_pserverHandler;}             
    void            setServerHandler(ServerHandler* s) {m_pserverHandler = s;}  

  protected:
    char*           getOutBuffer() const {return m_pOutBuff;}
    char*           getInBuffer() const {return m_pInBuff;}
    void            rotateBuffer(char* pbuffer,unsigned32 nBuffSize,unsigned32 nBytesRotatingOut);
    void            addPacketBuffer(const PacketBuffer* const ppacket);

  protected:
    ServerHandler*  m_pserverHandler;
    SockAddr        m_socketAddr;
    unsigned32      m_nID;
    int             m_iTimeout;
    Flags           m_flags;
    char*           m_pInBuff;      //buffer that contains data that was read from socket
    char*           m_pOutBuff;     //buffer that contains data that will be sent to socket
    char*           m_pOutPtr;      //pointer to first free byte in outgoing buffer
    char*           m_pInPtr;       //pointer to first free byte in incoming buffer
    unsigned32      m_nBytesIn;     //#bytes in the incoming buffer
    unsigned32      m_nBytesOut;    //#bytes in the outgoing buffer
    unsigned32      m_nBufferSizeMax;       //how big the in/out buffer is

  protected:
    //unused overloads
    ServerSocket(const ServerSocket&);
    ServerSocket& operator=(const ServerSocket&);
};

};

#endif  //SERVERSOCKET_H

---