Socket.h++

Go to the documentation of this file.

/* ---------------------------------------------------------------------------
   commonc++ - A C++ Common Class Library
   Copyright (C) 2005-2012  Mark A Lindner

   This file is part of commonc++.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   ---------------------------------------------------------------------------
*/

#ifndef __ccxx_Socket_hxx
#define __ccxx_Socket_hxx

#include <commonc++/Common.h++>
#include <commonc++/SocketException.h++>
#include <commonc++/Network.h++>
#include <commonc++/SocketAddress.h++>

#ifdef CCXX_OS_WINDOWS
typedef int socklen_t;
typedef char FAR* sockbufptr_t;
#endif

#ifdef CCXX_OS_POSIX
#include <netinet/in.h>
#include <sys/socket.h>
typedef void * sockbufptr_t;
#endif

#ifndef MSG_NOSIGNAL
#define MSG_NOSIGNAL 0
#endif // MSG_NOSIGNAL

namespace ccxx {

#ifdef CCXX_OS_WINDOWS
typedef SOCKET SocketHandle;
#define INVALID_SOCKET_HANDLE INVALID_SOCKET
#else
typedef int SocketHandle;
#define INVALID_SOCKET_HANDLE (-1)
#endif

class COMMONCPP_API Socket
{
  friend class ServerSocket;
  friend class SocketMuxer;

  protected:

  Socket(NetProtocol type = ProtoTCP) throw();

  public:

  virtual ~Socket() throw();

  virtual void init() throw(SocketException);

  virtual void connect(const String &addr, uint16_t port) throw(IOException);

  virtual void connect(const SocketAddress &addr) throw(IOException);

  virtual void shutdown() throw();

  void setTimeout(timespan_ms_t timeout) throw(SocketException);

  void setReceiveBufSize(size_t size) throw(SocketException);

  size_t getReceiveBufSize() const throw(SocketException);

  void setSendBufSize(size_t size) throw(SocketException);

  size_t getSendBufSize() const throw(SocketException);

  void setLingerTime(timespan_s_t timeout) throw(SocketException);

  timespan_s_t getLingerTime() const throw(SocketException);

  void setReuseAddress(bool enable) throw(SocketException);

  bool getReuseAddress() const throw(SocketException);

  void setKeepAlive(bool enable) throw(SocketException);

  bool getKeepAlive() throw(SocketException);

  void setTCPDelay(bool enable) throw(SocketException);

  bool getTCPDelay() throw(SocketException);

  inline bool isInitialized() const throw()
  { return(_socket != INVALID_SOCKET_HANDLE); }

  inline bool isConnected() const throw()
  { return(_connected); }

  inline NetProtocol getType() const throw()
  { return(_type); }

  inline const SocketAddress& getLocalAddress() const throw()
  { return(_laddr); }

  inline const SocketAddress& getRemoteAddress() const throw()
  { return(_raddr); }

  protected:

  enum IOWaitMode { WaitWrite, WaitRead };

  inline SocketHandle getSocketHandle() const throw()
  { return(_socket); }

  void waitForIO(IOWaitMode mode) throw(IOException);

  NetProtocol _type;
  SocketHandle _socket;
  SocketAddress _raddr;
  SocketAddress _laddr;
  int _sotimeout;

  bool _connected;
  bool _reuseAddr;
  private:

  CCXX_COPY_DECLS(Socket);
};

}; // namespace ccxx

#endif // __ccxx_Socket_hxx

/* end of header file */