// $Id$
//
// Copyright (C) 2006
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
-// Stefan Bund <stefan.bund@fokus.fraunhofer.de>
+// Fraunhofer Institute for Open Communication Systems (FOKUS)
+// Competence Center NETwork research (NET), St. Augustin, GERMANY
+// Stefan Bund <g0dil@berlios.de>
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
\brief INet[46]Address and INet[46]AddressingPolicy public header
*/
-#ifndef HH_INetAddressing_
-#define HH_INetAddressing_ 1
+#ifndef HH_SENF_Socket_Protocols_INet_INetAddressing_
+#define HH_SENF_Socket_Protocols_INet_INetAddressing_ 1
// Custom includes
#include <string>
#include <exception>
#include <netinet/in.h>
-#include <boost/operators.hpp>
-#include "Socket/SocketPolicy.hh"
-#include "Socket/ClientSocketHandle.hh"
-#include "Socket/CommunicationPolicy.hh"
-#include "Socket/Protocols/GenericAddressingPolicy.hh"
+#include "../../SocketPolicy.hh"
+#include "../../ClientSocketHandle.hh"
+#include "../../CommunicationPolicy.hh"
+#include "../BSDAddressingPolicy.hh"
+#include "../BSDSocketAddress.hh"
#include "INet4Address.hh"
#include "INet6Address.hh"
namespace senf {
- /// \addtogroup addr_group
- /// @{
-
/** \brief IPv4 socket address
INet4Address wraps the standard sockaddr_in datatype. It provides simple accessor methods
\implementation This implementation is based on sockaddr_in, which is needed since it needs
to provide a non-const struct sockaddr * for legacy compatibility.
+
+ \ingroup addr_group
*/
class INet4SocketAddress
- : public boost::equality_comparable<INet4SocketAddress>,
- public senf::ComparableSafeBool<INet4SocketAddress>
+ : public BSDSocketAddress
{
public:
+ static short const addressFamily = AF_INET;
+
+ ///////////////////////////////////////////////////////////////////////////
+ ///\name Structors and default members
+ ///@{
+
INet4SocketAddress();
- explicit INet4SocketAddress(std::string const & address); ///< Set address and port
+ explicit INet4SocketAddress(std::string const & addr); ///< Set address and port
/**< This constructor expects a string of the form
'host:port'. The constructor will use this value to
initialize the host and port members. Since it uses the
INet4Address::from_string constructor, this call may
block while waiting for the resolver.
- \throws SyntaxException if the 'host:port' syntax is
- not obeyed.
- \throws INet4Address::SyntaxException if the host part
- cannot be converted to an IP address. */
+ \throws AddressSyntaxException if the address syntax is
+ invalid
+ \throws UnknownHostnameException if the
+ address cannot be resolved. */
INet4SocketAddress(INet4Address const & addr, unsigned port);
///< Set address and port explicitly
/**< \param[in] addr IP address
\param[in] port port number */
- bool operator==(INet4SocketAddress const & other) const;
- ///< Check INet4SocketAddress for equality
+ explicit INet4SocketAddress(unsigned port);
+ ///< Set port, address is set to 0.0.0.0
+ /**< \param[in] port port number */
- INet4Address address() const; ///< Return address
- unsigned port() const; ///< Return port number
+ INet4SocketAddress(const INet4SocketAddress& other);
+ INet4SocketAddress& operator=(const INet4SocketAddress& other);
- bool boolean_test() const; ///< \c true, if address is empty (i.e. 0.0.0.0:0)
+ ///@}
+ ///////////////////////////////////////////////////////////////////////////
- void clear(); ///< Clear address/port to 0.0.0.0:0
+ INet4Address address() const; ///< Return address
+ unsigned port() const; ///< Return port number
void address(INet4Address const & addr); ///< Set address
void port(unsigned p); ///< Set port number
- /// \name Generic Address Interface
- /// @{
-
- struct sockaddr * sockaddr_p();
- struct sockaddr const * sockaddr_p() const;
- unsigned sockaddr_len() const;
-
- /// @}
-
- struct SyntaxException : public std::exception
- { virtual char const * what() const throw()
- { return "Invalid IpV4 socket address syntax"; } };
+ using BSDSocketAddress::sockaddr_p;
+ using BSDSocketAddress::socklen_p;
private:
struct ::sockaddr_in addr_;
\related INet4SocketAddress
*/
std::ostream & operator<<(std::ostream & os, INet4SocketAddress const & addr);
+ std::istream & operator>>(std::istream & is, INet4SocketAddress & addr);
/** \brief IPv6 socket address
This class wraps the standard \c sockaddr_in6 structure. INet6SocketAddress provides access
to all members of the sockaddr_in6 structure. Additionally, INet6SocketAddress supports the
- string representation
+ string representations
- \par "" <tt>[</tt> <i>address</i> [ <tt>\@</tt> <i>interface</i> ] <tt>]:</tt> <i>port</i>
+ \par ""
+ <tt>[</tt> <i>address</i> [ <tt>%</tt> <i>zone-id</i> ] <tt>]:</tt> <i>port</i> \n
+ <i>hostname</i> <tt>:</tt> <i>port</i>
- Where \e address is an arbitrary numeric IPv6 address, \e interface is an optional network
- interface name and \e port is the port number. The interface specification is only valid if
- \e address is link-local address. The URL representation of an IPv6 address is as above
- without the optional interface spec.
-
- INet6SocketAddress supports conversion constructors from it's string
- representation. Therefore, wherever a INet6SocketAddress instance is expected, a string may
- be used instead.
+ Where \e address is an arbitrary numeric IPv6 address, \e zone-id is an optional network
+ interface name and \e port is the port number. So some example addresses are
+
+ \par ""
+ <tt>[2001:db8:1::1]:80</tt> \n
+ <tt>www.6bone.net:80</tt> \n
+ <tt>[fe80::1\%eth0]:443</tt>
\implementation The sockaddr_in6 structure has an sin6_flowinfo member. However RFC3493 does
not give the use of this field and specifies, that the field should be ignored ... so
that's what we do. Furthermore, the GNU libc reference states, that this field is not
implemented in the library.
- \implementation We need to return the address in host() by value since we need to return a
- INet6Address. However, sockaddr_in6 does not have one ...
-
- \implementation The <tt>char const *</tt> constructor overload is needed to support
- string-literals where an INet6SocketAddress is expected (the C++ standard does not allow
- chaining conversion constructors like <tt>char const *</tt> -> \c std::string -> \c
- INet6SocketAddress)
-
\idea Implement a INet6Address_ref class which has an interface identical to INet6Address
- and is convertible to INet6Address (the latter has a conversion constructor taking the
- former as arg). This class however references an external in6_addr instead of containing one
- itself. This can be used in INet6SocketAddress to increase the performance of some
- operations.
+ and is convertible to INet6Address (the latter has a conversion constructor taking the
+ former as arg). This class however references an external in6_addr instead of containing
+ one itself. This can be used in INet6SocketAddress to increase the performance of some
+ operations.
+
+ \ingroup addr_group
*/
class INet6SocketAddress
+ : public BSDSocketAddress
{
public:
- ///////////////////////////////////////////////////////////////////////////
- // Types
+ static short const addressFamily = AF_INET6;
///////////////////////////////////////////////////////////////////////////
///\name Structors and default members
///@{
INet6SocketAddress(); ///< Create empty instance
- INet6SocketAddress(std::string const & addr);
+ explicit INet6SocketAddress(std::string const & addr,
+ INet6Address::Resolve_t resolve = INet6Address::ResolveINet6);
///< Initialize/convert from string representation
- INet6SocketAddress(char const * addr); ///< Same as above to support string literals
+ /**< \throws AddressSyntaxException if the address syntax is
+ invalid
+ \throws UnknownHostnameException if the
+ address cannot be resolved.
+ \param[in] addr Address to parse
+ \param[in] resolve If this is
+ INet6Address::ResolveINet4, support IPv4
+ addresses. See INet6Address. */
INet6SocketAddress(INet6Address const & addr, unsigned port);
///< Initialize from address and port
INet6SocketAddress(INet6Address const & addr, unsigned port, std::string const & iface);
///< Initialize explicitly from given parameters
- INet6SocketAddress(std::string const & addr, std::string const & iface);
- ///< Initialize from URL representation and explit interface
+ /**< \throws AddressSyntaxException if the
+ given iface cannot be resolved. */
+ explicit INet6SocketAddress(unsigned port);
+ ///< Initialize from port and set to 'unspecified' addr
+ /**< The address is set to [::]
+ \param[in] port port number */
+
+ INet6SocketAddress(const INet6SocketAddress& other);
+ INet6SocketAddress& operator=(const INet6SocketAddress& other);
///@}
///////////////////////////////////////////////////////////////////////////
- bool operator==(INet6SocketAddress const & other) const; ///< Check addresses for equality
- bool operator!=(INet6SocketAddress const & other) const; ///< Inverse of above
-
- void clear(); ///< Clear socket address
-
- std::string address() const; ///< Get printable address representation
-
- INet6Address host() const; ///< Get address
- void host(INet6Address const & addr); ///< Change address
+ INet6Address address() const; ///< Get printable address representation
+ void address(INet6Address const & addr); ///< Change address
unsigned port() const; ///< Get port number
- void port(unsigned poirt); ///< Change port number
+ void port(unsigned port); ///< Change port number
std::string iface() const; ///< Get interface name
void iface(std::string const & iface); ///< Change interface
+ /**< \throws AddressSyntaxException if the
+ given iface cannot be resolved. */
- ///\name Generic SocketAddress interface
- ///@{
-
- struct sockaddr * sockaddr_p();
- struct sockaddr const * sockaddr_p() const;
- unsigned sockaddr_len() const;
-
- ///@}
-
- struct SyntaxException : public std::exception
- { virtual char const * what() const throw()
- { return "Invalid IpV6 socket address syntax"; } };
+ using BSDSocketAddress::sockaddr_p;
+ using BSDSocketAddress::socklen_p;
protected:
private:
- void assignAddr(std::string const & addr);
void assignIface(std::string const & iface);
struct sockaddr_in6 sockaddr_;
};
/** \brief Output INet6SocketAddress instance as it's string representation
+ \related INet6SocketAddress
*/
std::ostream & operator<<(std::ostream & os, INet6SocketAddress const & addr);
-
- /// @}
+ std::istream & operator>>(std::istream & is, INet6SocketAddress & addr);
/// \addtogroup policy_impl_group
/// @{
/** \brief Addressing policy supporting IPv4 addressing
\par Address Type:
- INet4Address
+ INet4SocketAddress
This addressing policy implements addressing using Internet V4
addresses.
The various members are directly imported from
- GenericAddressingPolicy which see for a detailed
+ BSDAddressingPolicyMixin which see for a detailed
documentation.
*/
struct INet4AddressingPolicy
- : public AddressingPolicyBase,
- private GenericAddressingPolicy<INet4SocketAddress>
+ : public BSDAddressingPolicy,
+ private BSDAddressingPolicyMixin<INet4SocketAddress>
{
typedef INet4SocketAddress Address;
- using GenericAddressingPolicy<INet4SocketAddress>::peer;
- using GenericAddressingPolicy<INet4SocketAddress>::local;
- using GenericAddressingPolicy<INet4SocketAddress>::connect;
- using GenericAddressingPolicy<INet4SocketAddress>::bind;
+ using BSDAddressingPolicyMixin<INet4SocketAddress>::peer;
+ using BSDAddressingPolicyMixin<INet4SocketAddress>::local;
+ using BSDAddressingPolicyMixin<INet4SocketAddress>::connect;
+ using BSDAddressingPolicyMixin<INet4SocketAddress>::bind;
};
/** \brief Addressing policy supporting IPv6 addressing
addresses.
The various members are directly imported from
- GenericAddressingPolicy which see for a detailed
+ BSDAddressingPolicyMixin which see for a detailed
documentation.
*/
struct INet6AddressingPolicy
- : public AddressingPolicyBase,
- private GenericAddressingPolicy<INet6SocketAddress>
+ : public BSDAddressingPolicy,
+ private BSDAddressingPolicyMixin<INet6SocketAddress>
{
typedef INet6SocketAddress Address;
- using GenericAddressingPolicy<INet6SocketAddress>::peer;
- using GenericAddressingPolicy<INet6SocketAddress>::local;
- using GenericAddressingPolicy<INet6SocketAddress>::connect;
- using GenericAddressingPolicy<INet6SocketAddress>::bind;
+ using BSDAddressingPolicyMixin<INet6SocketAddress>::peer;
+ using BSDAddressingPolicyMixin<INet6SocketAddress>::local;
+ using BSDAddressingPolicyMixin<INet6SocketAddress>::connect;
+ using BSDAddressingPolicyMixin<INet6SocketAddress>::bind;
};
/// @}
projects / senf.git / blobdiff