OW_SocketAddress.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_SocketADDRESS_HPP_INCLUDE_GUARD_
#define OW_SocketADDRESS_HPP_INCLUDE_GUARD_
#include "OW_config.h"
#include "OW_Array.hpp"
#include "OW_Types.hpp"
#include "OW_NetworkTypes.hpp"
#include "OW_String.hpp"
#include "OW_Exception.hpp"

namespace OW_NAMESPACE
{

OW_DECLARE_APIEXCEPTION(UnknownHost, OW_COMMON_API);
OW_DECLARE_APIEXCEPTION(SocketAddress, OW_COMMON_API);
// TODO: This class needs to be rewritten to take into account the fact that a given hostname may have multiple 
// ip addresses, and a given ip address may have multiple hostnames & aliases..
class OW_COMMON_API SocketAddress
{
public:
   static const char* const ALL_LOCAL_ADDRESSES;

   enum AddressType
   {
      UNSET,
      INET,
      UDS
   };
   AddressType getType() const { return m_type; }
   static SocketAddress getByName(const String& host, unsigned short port = 0);
   static SocketAddress getAnyLocalHost(UInt16 port = 0);
   static SocketAddress allocEmptyAddress(AddressType type);
   UInt16 getPort() const;
   ~SocketAddress() {}
   const String getName() const;
   const String getAddress() const;
   const SocketAddress_t* getNativeForm() const;
   size_t getNativeFormSize() const;

   const InetSocketAddress_t* getInetAddress() const;

#if !defined(OW_WIN32)
   //static Array<SocketAddress> getAllByName(const String& hostName,
   //    unsigned short port = 0);
   static SocketAddress getUDS(const String& filename);

   const UnixSocketAddress_t* getUnixAddress() const;

   void assignFromNativeForm(const UnixSocketAddress_t* address, size_t len);
#endif

   const String toString() const;
   void assignFromNativeForm(const InetSocketAddress_t* address, size_t len);

   SocketAddress();
private:
   SocketAddress(const InetSocketAddress_t& nativeForm);

#if !defined(OW_WIN32)
   SocketAddress(const UnixSocketAddress_t& nativeForm);
#endif

   String m_name;
   String m_address;
   size_t m_nativeSize;
   
   InetSocketAddress_t m_inetNativeAddress;

#if !defined(OW_WIN32)
   UnixSocketAddress_t m_UDSNativeAddress;
#endif

   AddressType m_type;
   static SocketAddress getFromNativeForm(const InetAddress_t& nativeForm,
         UInt16 nativePort, const String& hostname );
   static SocketAddress getFromNativeForm(
      const InetSocketAddress_t& nativeForm);

#if !defined(OW_WIN32)
   static SocketAddress getFromNativeForm(
      const UnixSocketAddress_t& nativeForm);
#endif

};

} // end namespace OW_NAMESPACE

#endif

---