OW_Socket.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2001-2004 Vintela, 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 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 Vintela, Inc. OR THE 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 OW_SOCKET_HPP_INCLUDE_GUARD_
#define OW_SOCKET_HPP_INCLUDE_GUARD_
#include "OW_config.h"
#include "OW_SelectableIFC.hpp"
#include "OW_SocketBaseImpl.hpp"
#include "OW_String.hpp"
#include "OW_Types.hpp"
#include "OW_UnnamedPipe.hpp"
#include "OW_SocketFlags.hpp"
#include "OW_NetworkTypes.hpp"
#include "OW_SocketAddress.hpp"
#include "OW_IntrusiveReference.hpp"
#include "OW_SSLCtxMgr.hpp"


// TODO: This is duplicated in OW_ConfigOpts.hpp.  Figure out a way to merge the 2 without drastically increasing header dependencies.
#ifdef OW_DEFAULT_HTTP_SERVER_UDS_FILENAME
#define OW_DOMAIN_SOCKET_NAME OW_DEFAULT_HTTP_SERVER_UDS_FILENAME
#endif

#ifndef OW_DOMAIN_SOCKET_NAME
#define OW_DOMAIN_SOCKET_NAME "/tmp/OW@LCL@APIIPC_72859_Xq47Bf_P9r761-5_J-7_Q"OW_PACKAGE_PREFIX
#endif

namespace OW_NAMESPACE
{

OW_DECLARE_APIEXCEPTION(SocketTimeout, OW_COMMON_API)
class OW_COMMON_API Socket : public SelectableIFC, public IOIFC
{
public:
   Socket();
   Socket(const SSLClientCtxRef& sslCtx);
   Socket(SocketFlags::ESSLFlag isSSL) OW_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 = -1;
   void setReceiveTimeout(int seconds) { m_impl->setReceiveTimeout(seconds);}
   int getReceiveTimeout() const { return m_impl->getReceiveTimeout(); }
   void setSendTimeout(int seconds) { m_impl->setSendTimeout(seconds); }
   int getSendTimeout() const { return m_impl->getSendTimeout(); }
   void setConnectTimeout(int seconds) { m_impl->setConnectTimeout(seconds); }
   int getConnectTimeout() const { return m_impl->getConnectTimeout(); }
   void setTimeouts(int seconds) { m_impl->setTimeouts(seconds); }
   bool receiveTimeOutExpired() const { return m_impl->receiveTimeOutExpired(); }
   int write(const void* dataOut, int dataOutLen, bool errorAsException=false)
      { return m_impl->write(dataOut, dataOutLen, errorAsException); }
   int read(void* dataIn, int dataInLen, bool errorAsException=false)
      { return m_impl->read(dataIn, dataInLen, errorAsException); }
   bool waitForInput(int timeOutSecs=INFINITE_TIMEOUT)
      { return m_impl->waitForInput(timeOutSecs); }
   bool waitForOutput(int timeOutSecs=INFINITE_TIMEOUT)
      { return m_impl->waitForOutput(timeOutSecs); }

   SocketAddress getLocalAddress() const { return m_impl->getLocalAddress(); }
   SocketAddress getPeerAddress() const { return m_impl->getPeerAddress(); }
   std::istream& getInputStream() // TODO: OW_DEPRECATED in 3.2.0
      { return m_impl->getInputStream(); }
   std::ostream& getOutputStream() // TODO: OW_DEPRECATED in 3.2.0
      { return m_impl->getOutputStream(); }
   OW_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() OW_DEPRECATED; // deprecated in 3.1.0
   static void deleteShutDownMechanism();

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

   static ShutDownMechanism_t getShutDownMechanism()
   {
      return s_shutDownMechanism;
   }

#ifndef OW_NO_SSL

   SSL* getSSL() const;

   bool peerCertVerified() const;
#endif

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

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

   SocketBaseImplRef m_impl;

#ifdef OW_WIN32
#pragma warning (pop)
#endif

   static ShutDownMechanism_t s_shutDownMechanism;

   friend class ServerSocketImpl;

};

} // end namespace OW_NAMESPACE

#endif

---