AbstractSocket.h

Go to the documentation of this file.

/***************************************************************************
 * Copyright (C) 2009 by Benjamin Hadorn (b_hadorn@bluewin.ch)             *
 ***************************************************************************
 * Projekt : Zeus Base Library
 * Module  : AbstractSocket
 * Package : Net
 * Author  : Benjamin Hadorn
 * Datum   : $Date: 4.06.09 6:24 $
 * Ablage  : $File$
 * System  : Cell Computing Model
 ***************************************************************************
 * Licence:                                                                *
 *   This library is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU Lesser General Public License as        *
 *   published by the Free Software Foundation; either version             *
 *   2.1 of the License, or (at your option) any later version.            *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the          *
 *   GNU Lesser General Public License for more details.                   *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA  *
 ***************************************************************************/

/***************************************************************************
 Changes :
 $Log: /Development_F/StuderWIN/dev/Zeus/src/zeusbase/Net/AbstractSocket.h $
** 
** 2     4.06.09 6:24 Bha
** option setting and getting extended with type information
** 
** 1     27.03.09 13:27 Bha
** created
***************************************************************************/
//---------------------------------------------------------------------------

#ifndef AbstractSocketH
#define AbstractSocketH
//---------------------------------------------------------------------------

#include <zeusbase/System/ZObject.h>

#if defined(ENABLE_LINUX_BINDING)
  #include <sys/types.h>
  #include <sys/socket.h>
  #include <netinet/in.h>
  #include <arpa/inet.h>
#elif defined(ENABLE_WIN32_BINDING)
  #if defined(USE_WINDOWS_H)
    #include <windows.h>
    #if __BCPLUSPLUS__ < 0x0570
      #include <winsock.h>  //should be included by windows.h
    #endif
  #endif
#endif


BEGIN_NAMESPACE_Zeus

class TIPAddress;
class TCriticalSection;

/***************************************************************************/
/***************************************************************************/
zeusbase_class TAbstractSocket : public TZObject
{
  public:
    TAbstractSocket(TIPAddress& rAddress);
    TAbstractSocket(const TString& rstrAddr, Uint uiPort);
    TAbstractSocket(Int iFD, struct sockaddr_in& rAddress);

    virtual Retval connect() = 0;
    virtual Retval disconnect();

    TString getAddress() const;
    TString getHostName() const;
    Uint getPort() const;
    Int getReceiveBufferSize() const;
    Int getSendBufferSize() const;
    bool isConnected() const;
    bool isBlockable() const;
    bool isReUsable() const;
    bool isValid() const;

    void setBlockable(bool bMode);
    void setReceiveBufferSize(Int iSize);
    void setReUsable(bool bMode);
    void setSendBufferSize(Int iSize);

  protected:
    TAbstractSocket();
    virtual ~TAbstractSocket();

    static Retval getErrorCode(bool bHandleBlockedAsError);
    static bool getBoolSocketOption(Int iFD, Int iOption, Int iLevel);
    static Int getIntSocketOption(Int iFD, Int iOption, Int iLevel);
    static void setBoolSocketOption(Int iFD, Int iOption, Int iLevel, bool bValue);
    static void setIntSocketOption(Int iFD, Int iOption, Int iLevel, Int iValue);

    TIPAddress* m_pAddress;
    bool m_bConnected;
    bool m_bBlockable;

    Int m_iSocketFD;
    TCriticalSection& m_rSocketLock;

  private:
    static Int m_iObjectCount;

    void initSocket();
};


//INLINE METHODS
/***************************************************************************/
/***************************************************************************/
inline Int TAbstractSocket::getReceiveBufferSize() const
{
  return TAbstractSocket::getIntSocketOption(m_iSocketFD, SO_RCVBUF, SOL_SOCKET);
}

/***************************************************************************/
/***************************************************************************/
inline Int TAbstractSocket::getSendBufferSize() const
{
  return TAbstractSocket::getIntSocketOption(m_iSocketFD, SO_SNDBUF, SOL_SOCKET);
}

/**************************************************************************/
/**************************************************************************/
inline bool TAbstractSocket::isBlockable() const
{
  return m_bBlockable;
}

/**************************************************************************/
/**************************************************************************/
inline bool TAbstractSocket::isReUsable() const
{
  return  TAbstractSocket::getBoolSocketOption(m_iSocketFD, SO_REUSEADDR, SOL_SOCKET);
}

/**************************************************************************/
/**************************************************************************/
inline void TAbstractSocket::setReceiveBufferSize(Int iSize)
{
  if (iSize > 0)
  {
    TAbstractSocket::setIntSocketOption(m_iSocketFD, SO_RCVBUF, SOL_SOCKET, iSize);
  }
}

/**************************************************************************/
/**************************************************************************/
inline void TAbstractSocket::setReUsable(bool bMode)
{
  TAbstractSocket::setBoolSocketOption(m_iSocketFD, SO_REUSEADDR, SOL_SOCKET, bMode);
}

/**************************************************************************/
/**************************************************************************/
inline void TAbstractSocket::setSendBufferSize(Int iSize)
{
  if (iSize > 0)
  {
    TAbstractSocket::setIntSocketOption(m_iSocketFD, SO_SNDBUF, SOL_SOCKET, iSize);
  }
}


END_NAMESPACE_Zeus


#endif

---

Written by Benjamin Hadorn http://www.xatlantis.ch.
Last change made on Wed Oct 28 21:42:29 2009