-// Copyright (C) 2007
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
+// $Id$
+//
+// Copyright (C) 2007
+// 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
#include <iostream>
#include <string>
#include <boost/cstdint.hpp>
-#include "Utils/SafeBool.hh"
+#include <boost/array.hpp>
+#include <boost/operators.hpp>
+#include "../../../Utils/safe_bool.hh"
+#include "../../../Utils/Tags.hh"
//#include "INet4Address.mpp"
///////////////////////////////hh.p////////////////////////////////////////
namespace senf {
- /** \brief
+ /** \brief IPv4 Internet address
+
+ INet4Address represents a simple IP address. It is modelled as a fixed-size
+ container/sequence of 4 bytes.
+
+ \see CheckINet4Network \n INet4Network
+
+ \implementation We awkwardly need to use static named constructors (<tt>from_</tt> members)
+ instead of ordinarily overloaded constructors for one simple reason: <tt>char *</tt>
+ doubles as string literal and as arbitrary data iterator. The iterator constructor can
+ therefore not be distinguished from initialization with a string literal. Therefore we
+ need to disambiguate using the named constructors.
+
+ \ingroup addr_group
*/
class INet4Address
- : public ComparableSafeBool<INet4Address>
+ : public boost::array<boost::uint8_t,4>,
+ public comparable_safe_bool<INet4Address>
{
public:
- typedef uint32_t address_type;
+ ///////////////////////////////////////////////////////////////////////////
+ // Types
+
+ typedef uint32_t address_type; ///< Address representation as number in host byte order
+ typedef uint32_t inaddr_type; ///< Legacy address representation in network byte order
- static INet4Address const None;
- static INet4Address const Loopback;
- static INet4Address const Broadcast;
+ static INet4Address const None; ///< The empty (0) address
+ static INet4Address const Loopback; ///< The loopback (127.0.0.1) address
+ static INet4Address const Broadcast; ////< The global broadcast (255.255.255.255) address
- INet4Address();
+ ///////////////////////////////////////////////////////////////////////////
+ ///\name Structors and default members
+ ///@{
+
+ INet4Address(); ///< Construct an empty address
+ explicit INet4Address(senf::NoInit_t); ///< Construct uninitialized (!) address
explicit INet4Address(address_type value);
+ ///< Construct an address constant
static INet4Address from_string(std::string const & s);
+ ///< Convert string to address
+ /**< This member will try to convert the given string into
+ an IP address. from_string() supports all standard IP
+ literal representations as well es hostnames.
+ \attention This call may block if \a s represents a
+ hostname which must be looked up via some network
+ protocol like DNS or NIS
+ \throws SyntaxException if the address cannot be
+ converted for some reason
+ \param[in] s Address literal or hostname */
+
template <class InputIterator>
static INet4Address from_data(InputIterator i);
- static INet4Address from_inaddr(unsigned long v);
+ ///< Construct address from 4 bytes of raw data
+ /**< from_data will build an address from 4 bytes of raw
+ data as accessed by the iterator. The data must be in
+ network byte order. */
+ static INet4Address from_inaddr(inaddr_type v);
+ ///< Construct address from integer in network byte order
+ /**< This call is used when interfacing with other legacy
+ code to convert a network byte order address in an
+ integer number into an INet4Address. */
+
+ ///@}
+ ///////////////////////////////////////////////////////////////////////////
+ ///\name Accessors
+ ///@{
+
+ bool local() const; ///< \c true, if address is locally administered
+ /**< This call checks, if the address is within one of the
+ IANA private ranges. */
+ bool loopback() const; ///< \c true, if address is within the loopback network
+ /**< Checks, whether the address is in the IANA loopback
+ network 10.0.0.0/8 */
+ bool multicast() const; ///< \c true, if address is a multicast address
+ /**< Checks, whether the address is in the 224.0.0.0/4
+ network reserved for multicast addresses by the
+ IANA. */
+ bool broadcast() const; ///< \c true, if address is 255.255.255.255
+ bool boolean_test() const; ///< \c true, if address is non-empty (!= 0.0.0.0)
+
+ inaddr_type inaddr() const; ///< Return the raw network byte order address
+ /**< This member is used to interact with legacy code.
+ \return */
+ address_type address() const; ///< Return address represented as integer number
+ /**< This member returns the address as an integer number in
+ host byte order. This representation allows simple
+ network math operations. */
- bool local() const;
- bool loopback() const;
- bool multicast() const;
- bool broadcast() const;
- bool boolean_test() const;
+ ////@}
- unsigned long raw() const;
+ /** \brief Base-class for INet4Address exceptions */
+ struct AddressException : public std::exception {};
- struct SyntaxException : public std::exception
- { virtual char const * what() const throw() { return "invalid INet4 address syntax"; } };
+ /** \brief Invalid INet4 address syntax */
+ struct SyntaxException : public AddressException
+ { virtual char const * what() const throw()
+ { return "invalid INet4 address syntax"; } };
+ /** \brief Resolver failure */
+ struct UnknownHostnameException : public AddressException
+ { virtual char const * what() const throw()
+ { return "failed to resolve INet4 hostname"; } };
+
private:
- // Hmm ... address_type or unsigned long? I'd use address_type but the man pages for in_addr
- // have sa_addr as unsigned long
- unsigned long addr_;
+ enum InAddr_t { IsInAddr };
+ INet4Address(inaddr_type addr, InAddr_t);
+ inaddr_type & iref();
+ inaddr_type iref() const;
};
+ /** \brief Output INet4Address instance as it's string representation
+ \related INet4Address
+ */
std::ostream & operator<<(std::ostream & os, INet4Address const & addr);
+ /** \brief CHeck INet4Address against a fixed network prefix
+
+ This helper allows to easily and efficiently check an INet4Address against an arbitrary but
+ constant network prefix. The network prefix is represented by
+
+ \par ""
+ <tt>senf::CheckINet4Network<</tt> <i>addr</i> <tt>,</tt> <i>prefix-len</i> <tt>></tt>
+
+ Where \a addr is the v4 Internet address as a 32-bit unsigned integer number in host byte
+ order and \a prefix_len is the length of the network prefix. The class exposes a single
+ static member <tt>match(</tt> <i>addr</i> <tt>)</tt> which matches the INet4Address \a addr
+ against the prefix:
+
+ \code
+ if (senf::CheckINet4Network<0x7F000000u,8u>::match(addr)) {
+ // 'addr' is within the 127.0.0.0/8 loopback network
+ ...
+ }
+ \endcode
+
+ \implementation This is implemented the way it is so the syntax is identical to the
+ CheckINet6Network syntax.
+ */
+ template <boost::uint32_t address, unsigned prefix_len>
+ class CheckINet4Network
+ {
+ public:
+ static bool match(INet4Address const & addr);
+ };
+
+ /** \brief IPv4 network prefix
+
+ This class represents an IPv4 network prefix in CIDR notation.
+ */
+ class INet4Network
+ : public boost::equality_comparable<INet4Network>,
+ public comparable_safe_bool<INet4Network>
+ {
+ public:
+ ///////////////////////////////////////////////////////////////////////////
+ ///\name Structors and default members
+ ///@{
+
+ INet4Network(); ///< Construct empty (0.0.0.0/0) network
+ INet4Network(INet4Address address, unsigned prefix_len);
+ ///< Construct network from given address and prefix length
+ explicit INet4Network(std::string s); ///< Construct network from CIDR notation
+
+ ///@}
+ ///////////////////////////////////////////////////////////////////////////
+
+ INet4Address const & address() const; ///< Get the networks address
+ unsigned prefix_len() const; ///< Get the networks prefix length
+
+ bool boolean_test() const; ///< \c true, if INet4Network is non-empty
+ bool operator==(INet4Network const & other) const;
+ ///< Compare to networks for equality
+
+ bool match(INet4Address addr) const; ///< \c true, if the network includes \a addr
+ bool match(INet4Network net) const; ///< \c true, if the network includes \a net
+ /**< The is true, if \a net is sub-network (or the same as)
+ \c this. */
+
+ INet4Address host(boost::uint32_t number); ///< Return the host with the given number
+ /**< Returns the host with the given number within the
+ network. If the number is larger than the maximum
+ host number in the network, it is truncated. So \c
+ host(0) is the networks own address, \c host(1)
+ customarily is the default router and \c host(-1) is
+ the broadcast address. */
+
+ INet4Network subnet(boost::uint32_t net, unsigned prefix_len);
+ ///< Return the given subnet of \c this
+ /**< The returned INet4Network will be a subnet of \c this
+ with the given network number. The network number is
+ comprised by the bits above \a prefix_len:
+ \code
+ INet4Network("192.168.0.0/16").subnet(111u,24u) == INet4Network("192.168.111.0/24")
+ INet4Network("192.168.111.0/24").subnet(1u,28u) == INet4Network("192.168.111.16/28")
+ \endcode
+ \param[in] net network number
+ \param[in] prefix_len length of subnet prefix */
+
+ protected:
+
+ private:
+ boost::uint32_t mask() const;
+
+ unsigned prefix_len_;
+ INet4Address address_;
+ };
+
+ /** \brief Output INet4Network instance as it's string representation
+ \related INet4Network
+ */
+ std::ostream & operator<<(std::ostream & os, INet4Network const & addr);
+
}
///////////////////////////////hh.e////////////////////////////////////////
#include "INet4Address.cci"
-//#include "INet4Address.ct"
+#include "INet4Address.ct"
#include "INet4Address.cti"
#endif
projects / senf.git / blobdiff