CASocket.hpp

Go to the documentation of this file.

#ifndef __CASOCKET__
#define __CASOCKET__
/*
Copyright (c) 2000, The JAP-Team 
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, 
are permitted provided that the following conditions are met:
 
  - Redistributions of source code must retain the above copyright notice, 
    this list of conditions and the following disclaimer.
 
  - 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.
 
  - Neither the name of the University of Technology Dresden, Germany nor the names of its contributors 
    may be used to endorse or promote products derived from this software without specific 
    prior written permission. 
 
  
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS 
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 THE REGENTS OR 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
*/
#include "CASocketAddr.hpp"
#include "CAClientSocket.hpp"
#include "CAMutex.hpp"
#include "CAMsg.hpp"
 
class CASingleSocketGroup;
 
class CASocket:public CAClientSocket
  {
    public:
      CASocket(bool bIsReserved=false);
      ~CASocket(){close();}
 
      static SINT32 init()
        {
          m_pcsClose=new CAMutex();
          return E_SUCCESS;
        }
 
      static SINT32 cleanup()
        {
          delete m_pcsClose;
          m_pcsClose=NULL;
          return E_SUCCESS;
        }
 
      virtual SINT32 create();            
      virtual SINT32 create(bool a_bShowTypicalError);
      virtual SINT32 create(SINT32 type);
 
      virtual SINT32 listen(const CASocketAddr& psa);
      virtual SINT32 listen(UINT16 port);
      virtual SINT32 accept(CASocket &s);
      
      virtual SINT32 connect(const CASocketAddr& psa)
      {
        return connect(psa,1,0);
      }
      virtual SINT32 connect(const CASocketAddr& psa,UINT32 retry,UINT32 sWaitTime);
      virtual SINT32 connect(const CASocketAddr& psa,UINT32 msTimeOut);
      
      virtual SINT32 close();
/* it seems that this function is not used:
      virtual SINT32 close(UINT32 mode);*/
      virtual SINT32 send(const UINT8* buff,UINT32 len);
      virtual SINT32 sendFully(const UINT8* buff,UINT32 len);
      virtual SINT32 sendFullyTimeOut(const UINT8* buff,UINT32 len, UINT32 msTimeOut, UINT32 msTimeOutSingleSend);
      virtual SINT32 sendTimeOut(const UINT8* buff,UINT32 len,UINT32 msTimeOut);
      virtual SINT32 receive(UINT8* buff,UINT32 len);
      virtual SINT32 receiveFullyT(UINT8* buff,UINT32 len,UINT32 msTimeOut);
      virtual SINT32 receiveLine(UINT8* line, UINT32 maxLen, UINT32 msTimeOut);
      virtual SINT32 peek(UINT8* buff,UINT32 len);
      SOCKET getSocket()
        {
          return m_Socket;
        }
 
 
      virtual SINT32 getLocalIP(UINT8 r_Ip[4]);
      virtual SINT32 getLocalPort();
      virtual SINT32 getPeerIP(UINT8 ip[4]);
      virtual SINT32 getPeerPort();
      virtual SINT32 setReuseAddr(bool b);
      //SINT32 setRecvLowWat(UINT32 r);
      //SINT32 setSendLowWat(UINT32 r);
      //SINT32 getSendLowWat();
      virtual SINT32 setSendTimeOut(UINT32 msTimeOut);
      virtual SINT32 getSendTimeOut();
      virtual SINT32 setRecvBuff(UINT32 r);
      virtual SINT32 getRecvBuff();
      virtual SINT32 setSendBuff(SINT32 r);
      virtual SINT32 getSendBuff();
      virtual SINT32 setKeepAlive(bool b);
      virtual SINT32 setKeepAlive(UINT32 sec);
      virtual SINT32 setNonBlocking(bool b);
      virtual SINT32 getNonBlocking(bool* b);
      
      static SINT32 setMaxNormalSockets(UINT32 u)
        {
        m_u32MaxNormalSockets=u;
        return E_SUCCESS;
        }
      
      static SINT32 getMaxOpenSockets();
      static UINT32 countOpenSockets()
      {
        return m_u32NormalSocketsOpen;
      }
      virtual bool isClosed()
      {
        return m_bSocketIsClosed;
      }
    
    protected:
/*      CASocket* getSocket()
      {
        return this;
      }
*/    
      volatile bool m_bSocketIsClosed; //this is a flag, which shows, if the m_Socket is valid
                          //we should not set m_Socket to -1 or so after close,
                          //because the Socket value ist needed sometimes even after close!!!
                          // (because it is used as a Key in lookups for instance as a HashValue etc.)
 
      SOCKET m_Socket;
      CASingleSocketGroup *m_pSingleSocketGroupRead; //A single socke group which contains this socket for helping in reading from this socket...
    
 
    private:      
      
      virtual SINT32 setSocket(SOCKET s);
      virtual SINT32 create(SINT32 type, bool a_bShowTypicalError);
    
      static CAMutex* m_pcsClose;
      volatile static UINT32 m_u32NormalSocketsOpen; //how many "normal" sockets are open
      static UINT32 m_u32MaxNormalSockets; //how many "normal" sockets are allowed at max
      bool m_bIsReservedSocket; 
  };  
#endif