Socket.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2005, Vintela, Inc. All rights reserved.
* Copyright (C) 2006, Novell, Inc. 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 
*       Vintela, Inc., 
*       nor Novell, Inc., 
*       nor the names of its contributors or employees 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 COPYRIGHT OWNER 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.
*******************************************************************************/


#ifndef BLOCXX_SOCKET_HPP_INCLUDE_GUARD_
#define BLOCXX_SOCKET_HPP_INCLUDE_GUARD_
#include "blocxx/BLOCXX_config.h"
#include "blocxx/CommonFwd.hpp"
#include "blocxx/SelectableIFC.hpp"
#include "blocxx/IOIFC.hpp"
#include "blocxx/SocketBaseImpl.hpp"
#include "blocxx/Types.hpp"
#include "blocxx/UnnamedPipe.hpp"
#include "blocxx/SocketFlags.hpp"
#include "blocxx/NetworkTypes.hpp"
#include "blocxx/SocketAddress.hpp"
#include "blocxx/IntrusiveReference.hpp"
#include "blocxx/Timeout.hpp"
#include "blocxx/Exception.hpp"
#include "blocxx/LazyGlobal.hpp"

#ifndef BLOCXX_NO_SSL
#include <openssl/ssl.h>
#endif


namespace BLOCXX_NAMESPACE
{

BLOCXX_DECLARE_APIEXCEPTION(SocketTimeout, BLOCXX_COMMON_API)
class BLOCXX_COMMON_API Socket : public SelectableIFC, public IOIFC
{
public:
   Socket();
   Socket(const SSLClientCtxRef& sslCtx);
   Socket(SocketFlags::ESSLFlag isSSL) BLOCXX_DEPRECATED;
   Socket(SocketHandle_t fd, SocketAddress::AddressType addrType,
      SocketFlags::ESSLFlag isSSL = SocketFlags::E_NOT_SSL);
   Socket(const SocketAddress& addr, SocketFlags::ESSLFlag isSSL = SocketFlags::E_NOT_SSL);
   void connect(const SocketAddress& addr)
      { m_impl->connect(addr); }
   void disconnect() { m_impl->disconnect(); }

   static const int INFINITE_TIMEOUT BLOCXX_DEPRECATED = -1;
   BLOCXX_DEPRECATED void setReceiveTimeout(int seconds) { m_impl->setReceiveTimeout(Timeout::relative(seconds));}
   void setReceiveTimeout(const Timeout& timeout) { m_impl->setReceiveTimeout(timeout);}
   Timeout getReceiveTimeout() const { return m_impl->getReceiveTimeout(); }
   BLOCXX_DEPRECATED void setSendTimeout(int seconds) { m_impl->setSendTimeout(Timeout::relative(seconds)); }
   void setSendTimeout(const Timeout& timeout) { m_impl->setSendTimeout(timeout); }
   Timeout getSendTimeout() const { return m_impl->getSendTimeout(); }
   BLOCXX_DEPRECATED void setConnectTimeout(int seconds) { m_impl->setConnectTimeout(Timeout::relative(seconds)); }
   void setConnectTimeout(const Timeout& timeout) { m_impl->setConnectTimeout(timeout); }
   Timeout getConnectTimeout() const { return m_impl->getConnectTimeout(); }
   BLOCXX_DEPRECATED void setTimeouts(int seconds) { m_impl->setTimeouts(Timeout::relative(seconds)); }
   void setTimeouts(const Timeout& timeout) { m_impl->setTimeouts(timeout); }
   bool receiveTimeOutExpired() const { return m_impl->receiveTimeOutExpired(); }
   int write(const void* dataOut, int dataOutLen, ErrorAction errorAsException = E_RETURN_ON_ERROR)
      { return m_impl->write(dataOut, dataOutLen, errorAsException); }
   int read(void* dataIn, int dataInLen, ErrorAction errorAsException = E_RETURN_ON_ERROR)
      { return m_impl->read(dataIn, dataInLen, errorAsException); }
   
   BLOCXX_DEPRECATED bool waitForInput(int timeOutSecs)
      { return m_impl->waitForInput(Timeout::relative(timeOutSecs)); }
   
   bool waitForInput(const Timeout& timeout = Timeout::infinite)
      { return m_impl->waitForInput(timeout); }
   
   BLOCXX_DEPRECATED bool waitForOutput(int timeOutSecs)
      { return m_impl->waitForOutput(Timeout::relative(timeOutSecs)); }
   
   bool waitForOutput(const Timeout& timeout = Timeout::infinite)
      { return m_impl->waitForOutput(timeout); }

   SocketAddress getLocalAddress() const { return m_impl->getLocalAddress(); }
   SocketAddress getPeerAddress() const { return m_impl->getPeerAddress(); }
   std::istream& getInputStream() // TODO: BLOCXX_DEPRECATED in 3.2.0
      { return m_impl->getInputStream(); }
   std::ostream& getOutputStream() // TODO: BLOCXX_DEPRECATED in 3.2.0
      { return m_impl->getOutputStream(); }
   BLOCXX_DEPRECATED std::iostream& getIOStream() // in 3.2.0
      { return m_impl->getIOStream(); }
   Select_t getSelectObj() const { return m_impl->getSelectObj(); }
   SocketHandle_t getfd() { return m_impl->getfd(); }

   bool isConnected() const { return m_impl->isConnected(); }

   static void createShutDownMechanism();
   static void shutdownAllSockets();
   static bool gotShutDown() BLOCXX_DEPRECATED; // deprecated in 3.1.0
   static void deleteShutDownMechanism();

#if defined(BLOCXX_WIN32)
   typedef HANDLE ShutDownMechanism_t;
#else
   typedef UnnamedPipeRef ShutDownMechanism_t;
#endif

   static ShutDownMechanism_t getShutDownMechanism()
   {
      return s_shutDownMechanism;
   }

#ifndef BLOCXX_NO_SSL

   SSL* getSSL() const;

   bool peerCertVerified() const;
#endif

private:
   Socket(SocketHandle_t fd, SocketAddress::AddressType addrType,
      const SSLServerCtxRef& sslCtx);

#ifdef BLOCXX_WIN32
#pragma warning (push)
#pragma warning (disable: 4251)
#endif

   SocketBaseImplRef m_impl;

#ifdef BLOCXX_WIN32
#pragma warning (pop)
#endif

   struct ShutDownMechanismFactory
   {
      static Socket::ShutDownMechanism_t* create(int initVal)
      {
         return new Socket::ShutDownMechanism_t();
      }
   };
   static LazyGlobal<Socket::ShutDownMechanism_t, int, ShutDownMechanismFactory> s_shutDownMechanism;

   friend class ServerSocketImpl;

};

} // end namespace BLOCXX_NAMESPACE

#endif