blocxx
SocketAddress.hpp
Go to the documentation of this file.
1/*******************************************************************************
2* Copyright (C) 2005, Vintela, Inc. All rights reserved.
3* Copyright (C) 2006, Novell, Inc. All rights reserved.
4*
5* Redistribution and use in source and binary forms, with or without
6* modification, are permitted provided that the following conditions are met:
7*
8* * Redistributions of source code must retain the above copyright notice,
9* this list of conditions and the following disclaimer.
10* * Redistributions in binary form must reproduce the above copyright
11* notice, this list of conditions and the following disclaimer in the
12* documentation and/or other materials provided with the distribution.
13* * Neither the name of
14* Vintela, Inc.,
15* nor Novell, Inc.,
16* nor the names of its contributors or employees may be used to
17* endorse or promote products derived from this software without
18* specific prior written permission.
19*
20* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30* POSSIBILITY OF SUCH DAMAGE.
31*******************************************************************************/
32
33
38
39#ifndef BLOCXX_SocketADDRESS_HPP_INCLUDE_GUARD_
40#define BLOCXX_SocketADDRESS_HPP_INCLUDE_GUARD_
41#include "blocxx/BLOCXX_config.h"
42#include "blocxx/Array.hpp"
43#include "blocxx/Types.hpp"
45#include "blocxx/String.hpp"
46#include "blocxx/Exception.hpp"
47
48namespace BLOCXX_NAMESPACE
49{
50
51BLOCXX_DECLARE_APIEXCEPTION(UnknownHost, BLOCXX_COMMON_API);
53// TODO: This class needs to be rewritten to take into account the fact that a given hostname may have multiple
54// ip addresses, and a given ip address may have multiple hostnames & aliases..
55class BLOCXX_COMMON_API SocketAddress
56{
57public:
58 static const char* const ALL_LOCAL_ADDRESSES;
59
66 AddressType getType() const { return m_type; }
76 static SocketAddress getByName(const String& host, unsigned short port = 0);
86
92 static SocketAddress getAnyLocalHost(UInt16 port = 0);
97 static SocketAddress allocEmptyAddress(AddressType type);
102 UInt16 getPort() const;
109 const String getName() const;
115 const String getAddress() const;
116 const SocketAddress_t* getNativeForm() const;
117 size_t getNativeFormSize() const;
118
123 const InetSocketAddress_t* getInetAddress() const;
124
125#if !defined(BLOCXX_WIN32)
126 //static Array<SocketAddress> getAllByName(const String& hostName,
127 // unsigned short port = 0);
128 static SocketAddress getUDS(const String& filename);
129
134 const UnixSocketAddress_t* getUnixAddress() const;
135
136 void assignFromNativeForm(const UnixSocketAddress_t* address, size_t len);
137#endif
138
144 const String toString() const;
145 void assignFromNativeForm(const InetSocketAddress_t* address, size_t len);
146
148private:
149 SocketAddress(const InetSocketAddress_t& nativeForm);
150
151#if !defined(BLOCXX_WIN32)
152 SocketAddress(const UnixSocketAddress_t& nativeForm);
153#endif
154
158
160
161#if !defined(BLOCXX_WIN32)
163#endif
164
166 static SocketAddress getFromNativeForm(const InetAddress_t& nativeForm,
167 UInt16 nativePort, const String& hostname );
169 const InetSocketAddress_t& nativeForm);
170
171#if !defined(BLOCXX_WIN32)
173 const UnixSocketAddress_t& nativeForm);
174#endif
175
176#ifdef BLOCXX_WIN32
177const char *inet_ntop(int af, const void *src, char *dst, socklen_t cnt);
178#endif
179
180};
181
182} // end namespace BLOCXX_NAMESPACE
183
184#endif
#define BLOCXX_DECLARE_APIEXCEPTION(NAME, LINKAGE_SPEC)
Declare a new exception class named <NAME>Exception that derives from Exception This macro is typical...
unsigned socklen_t
InetSocketAddress_t m_inetNativeAddress
static const char *const ALL_LOCAL_ADDRESSES
static SocketAddress getFromNativeForm(const InetAddress_t &nativeForm, UInt16 nativePort, const String &hostname)
UnixSocketAddress_t m_UDSNativeAddress
This String class is an abstract data type that represents as NULL terminated string of characters.
Definition String.hpp:67
Taken from RFC 1321.
sockaddr_in InetSocketAddress_t
sockaddr SocketAddress_t
sockaddr_un UnixSocketAddress_t