/dep/acelite/ace/INET_Addr.h
C++ Header | 390 lines | 139 code | 69 blank | 182 comment | 4 complexity | b0c9092d779230d90e945a4d5f42808a MD5 | raw file
Possible License(s): BSD-2-Clause, BSD-3-Clause, GPL-2.0, CC-BY-SA-3.0
- /* -*- C++ -*- */
- //=============================================================================
- /**
- * @file INET_Addr.h
- *
- * $Id: INET_Addr.h 95533 2012-02-14 22:59:17Z wotte $
- *
- * @author Douglas C. Schmidt <schmidt@cs.wustl.edu>
- */
- //=============================================================================
- #ifndef ACE_INET_ADDR_H
- #define ACE_INET_ADDR_H
- #include /**/ "ace/pre.h"
- #include "ace/Sock_Connect.h"
- #if !defined (ACE_LACKS_PRAGMA_ONCE)
- # pragma once
- #endif /* ACE_LACKS_PRAGMA_ONCE */
- #include "ace/Addr.h"
- ACE_BEGIN_VERSIONED_NAMESPACE_DECL
- /**
- * @class ACE_INET_Addr
- *
- * @brief Defines a C++ wrapper facade for the Internet domain address
- * family format.
- */
- class ACE_Export ACE_INET_Addr : public ACE_Addr
- {
- public:
- // = Initialization methods.
- /// Default constructor.
- ACE_INET_Addr (void);
- /// Copy constructor.
- ACE_INET_Addr (const ACE_INET_Addr &);
- /// Creates an ACE_INET_Addr from a sockaddr_in structure.
- ACE_INET_Addr (const sockaddr_in *addr, int len);
- /// Creates an ACE_INET_Addr from a @a port_number and the remote
- /// @a host_name. The port number is assumed to be in host byte order.
- /// To set a port already in network byte order, please @see set().
- /// Use address_family to select IPv6 (PF_INET6) vs. IPv4 (PF_INET).
- ACE_INET_Addr (u_short port_number,
- const char host_name[],
- int address_family = AF_UNSPEC);
- /**
- * Initializes an ACE_INET_Addr from the @a address, which can be
- * "ip-number:port-number" (e.g., "tango.cs.wustl.edu:1234" or
- * "128.252.166.57:1234"). If there is no ':' in the @a address it
- * is assumed to be a port number, with the IP address being
- * INADDR_ANY.
- */
- explicit ACE_INET_Addr (const char address[],
- int address_family = AF_UNSPEC);
- /**
- * Creates an ACE_INET_Addr from a @a port_number and an Internet
- * @a ip_addr. This method assumes that @a port_number and @a ip_addr
- * are in host byte order. If you have addressing information in
- * network byte order, @see set().
- */
- explicit ACE_INET_Addr (u_short port_number,
- ACE_UINT32 ip_addr = INADDR_ANY);
- /// Uses getservbyname() to create an ACE_INET_Addr from a
- /// @a port_name, the remote @a host_name, and the @a protocol.
- ACE_INET_Addr (const char port_name[],
- const char host_name[],
- const char protocol[] = "tcp");
- /**
- * Uses getservbyname() to create an ACE_INET_Addr from a
- * @a port_name, an Internet @a ip_addr, and the @a protocol. This
- * method assumes that @a ip_addr is in host byte order.
- */
- ACE_INET_Addr (const char port_name[],
- ACE_UINT32 ip_addr,
- const char protocol[] = "tcp");
- #if defined (ACE_HAS_WCHAR)
- ACE_INET_Addr (u_short port_number,
- const wchar_t host_name[],
- int address_family = AF_UNSPEC);
- explicit ACE_INET_Addr (const wchar_t address[],
- int address_family = AF_UNSPEC);
- ACE_INET_Addr (const wchar_t port_name[],
- const wchar_t host_name[],
- const wchar_t protocol[] = ACE_TEXT_WIDE ("tcp"));
- ACE_INET_Addr (const wchar_t port_name[],
- ACE_UINT32 ip_addr,
- const wchar_t protocol[] = ACE_TEXT_WIDE ("tcp"));
- #endif /* ACE_HAS_WCHAR */
- /// Default dtor.
- ~ACE_INET_Addr (void);
- // = Direct initialization methods.
- // These methods are useful after the object has been constructed.
- /// Initializes from another ACE_INET_Addr.
- int set (const ACE_INET_Addr &);
- /**
- * Initializes an ACE_INET_Addr from a @a port_number and the
- * remote @a host_name. If @a encode is non-zero then @a port_number is
- * converted into network byte order, otherwise it is assumed to be
- * in network byte order already and are passed straight through.
- * address_family can be used to select IPv4/IPv6 if the OS has
- * IPv6 capability (ACE_HAS_IPV6 is defined). To specify IPv6, use
- * the value AF_INET6. To specify IPv4, use AF_INET.
- */
- int set (u_short port_number,
- const char host_name[],
- int encode = 1,
- int address_family = AF_UNSPEC);
- /**
- * Initializes an ACE_INET_Addr from a @a port_number and an Internet
- * @a ip_addr. If @a encode is non-zero then the port number and IP address
- * are converted into network byte order, otherwise they are assumed to be
- * in network byte order already and are passed straight through.
- *
- * If @a map is non-zero and IPv6 support has been compiled in,
- * then this address will be set to the IPv4-mapped IPv6 address of it.
- */
- int set (u_short port_number,
- ACE_UINT32 ip_addr = INADDR_ANY,
- int encode = 1,
- int map = 0);
- /// Uses getservbyname() to initialize an ACE_INET_Addr from a
- /// @a port_name, the remote @a host_name, and the @a protocol.
- int set (const char port_name[],
- const char host_name[],
- const char protocol[] = "tcp");
- /**
- * Uses getservbyname() to initialize an ACE_INET_Addr from a
- * @a port_name, an @a ip_addr, and the @a protocol. This assumes that
- * @a ip_addr is already in network byte order.
- */
- int set (const char port_name[],
- ACE_UINT32 ip_addr,
- const char protocol[] = "tcp");
- /**
- * Initializes an ACE_INET_Addr from the @a addr, which can be
- * "ip-number:port-number" (e.g., "tango.cs.wustl.edu:1234" or
- * "128.252.166.57:1234"). If there is no ':' in the @a address it
- * is assumed to be a port number, with the IP address being
- * INADDR_ANY.
- */
- int set (const char addr[], int address_family = AF_UNSPEC);
- /// Creates an ACE_INET_Addr from a sockaddr_in structure.
- int set (const sockaddr_in *,
- int len);
- #if defined (ACE_HAS_WCHAR)
- int set (u_short port_number,
- const wchar_t host_name[],
- int encode = 1,
- int address_family = AF_UNSPEC);
- int set (const wchar_t port_name[],
- const wchar_t host_name[],
- const wchar_t protocol[] = ACE_TEXT_WIDE ("tcp"));
- int set (const wchar_t port_name[],
- ACE_UINT32 ip_addr,
- const wchar_t protocol[] = ACE_TEXT_WIDE ("tcp"));
- int set (const wchar_t addr[], int address_family = AF_UNSPEC);
- #endif /* ACE_HAS_WCHAR */
- /// Return a pointer to the underlying network address.
- virtual void *get_addr (void) const;
- int get_addr_size(void) const;
- /// Set a pointer to the address.
- virtual void set_addr (void *, int len);
- /// Set a pointer to the address.
- virtual void set_addr (void *, int len, int map);
- /**
- * Transform the current ACE_INET_Addr address into string format.
- * If @a ipaddr_format is ttrue this produces "ip-number:port-number"
- * (e.g., "128.252.166.57:1234"), whereas if @a ipaddr_format is false
- * this produces "ip-name:port-number" (e.g.,
- * "tango.cs.wustl.edu:1234"). Returns -1 if the @a size of the
- * @a buffer is too small, else 0.
- */
- virtual int addr_to_string (ACE_TCHAR buffer[],
- size_t size,
- int ipaddr_format = 1) const;
- /**
- * Initializes an ACE_INET_Addr from the @a address, which can be
- * "ip-addr:port-number" (e.g., "tango.cs.wustl.edu:1234"),
- * "ip-addr:port-name" (e.g., "tango.cs.wustl.edu:telnet"),
- * "ip-number:port-number" (e.g., "128.252.166.57:1234"), or
- * "ip-number:port-name" (e.g., "128.252.166.57:telnet"). If there
- * is no ':' in the @a address it is assumed to be a port number,
- * with the IP address being INADDR_ANY.
- */
- virtual int string_to_addr (const char address[],
- int address_family = AF_UNSPEC);
- #if defined (ACE_HAS_WCHAR)
- /*
- virtual int string_to_addr (const char address[]);
- */
- #endif /* ACE_HAS_WCHAR */
- /**
- * Sets the port number without affecting the host name. If
- * @a encode is enabled then @a port_number is converted into network
- * byte order, otherwise it is assumed to be in network byte order
- * already and are passed straight through.
- */
- void set_port_number (u_short,
- int encode = 1);
- /**
- * Sets the address without affecting the port number. If
- * @a encode is enabled then @a ip_addr is converted into network
- * byte order, otherwise it is assumed to be in network byte order
- * already and are passed straight through. The size of the address
- * is specified in the @a len parameter.
- * If @a map is non-zero, IPv6 support has been compiled in, and
- * @a ip_addr is an IPv4 address, then this address is set to the IPv4-mapped
- * IPv6 address of it.
- */
- int set_address (const char *ip_addr,
- int len,
- int encode = 1,
- int map = 0);
- #if (defined (ACE_LINUX) || defined (ACE_WIN32)) && defined (ACE_HAS_IPV6)
- /**
- * Sets the interface that should be used for this address. This only has
- * an effect when the address is link local, otherwise it does nothing.
- */
- int set_interface (const char *intf_name);
- #endif /* (ACE_LINUX || ACE_WIN32) && ACE_HAS_IPV6 */
- /// Return the port number, converting it into host byte-order.
- u_short get_port_number (void) const;
- /**
- * Return the character representation of the name of the host,
- * storing it in the @a hostname (which is assumed to be
- * @a hostnamelen bytes long). This version is reentrant. If
- * @a hostnamelen is greater than 0 then @a hostname will be
- * NUL-terminated even if -1 is returned.
- */
- int get_host_name (char hostname[],
- size_t hostnamelen) const;
- #if defined (ACE_HAS_WCHAR)
- int get_host_name (wchar_t hostname[],
- size_t hostnamelen) const;
- #endif /* ACE_HAS_WCHAR */
- /**
- * Return the character representation of the hostname. This
- * version is non-reentrant since it returns a pointer to a static
- * data area. You should therefore either (1) do a "deep copy" of
- * the address returned by get_host_name(), e.g., using strdup() or
- * (2) use the "reentrant" version of get_host_name() described
- * above.
- */
- const char *get_host_name (void) const;
- /**
- * Return the "dotted decimal" Internet address representation of
- * the hostname storing it in the @a addr (which is assumed to be
- * @a addr_size bytes long). This version is reentrant.
- */
- const char *get_host_addr (char *addr, int addr_size) const;
- /**
- * Return the "dotted decimal" Internet address representation of
- * the hostname. This version is non-reentrant since it returns a
- * pointer to a static data area. You should therefore either
- * (1) do a "deep copy" of the address returned by get_host_addr(), e.g.,
- * using strdup() or (2) use the "reentrant" version of
- * get_host_addr() described above.
- */
- const char *get_host_addr (void) const;
- /// Return the 4-byte IP address, converting it into host byte
- /// order.
- ACE_UINT32 get_ip_address (void) const;
- /// Return @c true if the IP address is INADDR_ANY or IN6ADDR_ANY.
- bool is_any (void) const;
- /// Return @c true if the IP address is IPv4/IPv6 loopback address.
- bool is_loopback (void) const;
- /// Return @c true if the IP address is IPv4/IPv6 multicast address.
- bool is_multicast (void) const;
- #if defined (ACE_HAS_IPV6)
- /// Return @c true if the IP address is IPv6 linklocal address.
- bool is_linklocal (void) const;
- /// Return @c true if the IP address is IPv4-mapped IPv6 address.
- bool is_ipv4_mapped_ipv6 (void) const;
- /// Return @c true if the IP address is IPv4-compatible IPv6 address.
- bool is_ipv4_compat_ipv6 (void) const;
- #endif /* ACE_HAS_IPV6 */
- /**
- * Returns @c true if @c this is less than @a rhs. In this context,
- * "less than" is defined in terms of IP address and TCP port
- * number. This operator makes it possible to use @c ACE_INET_Addrs
- * in STL maps.
- */
- bool operator < (const ACE_INET_Addr &rhs) const;
- /// Compare two addresses for equality. The addresses are considered
- /// equal if they contain the same IP address and port number.
- bool operator == (const ACE_INET_Addr &SAP) const;
- /// Compare two addresses for inequality.
- bool operator != (const ACE_INET_Addr &SAP) const;
- /// A variation of the equality operator, this method only compares the
- /// IP address and ignores the port number.
- bool is_ip_equal (const ACE_INET_Addr &SAP) const;
- /// Computes and returns hash value.
- virtual u_long hash (void) const;
- /// Dump the state of an object.
- void dump (void) const;
- /// Declare the dynamic allocation hooks.
- ACE_ALLOC_HOOK_DECLARE;
- private:
- /// Insure that @a hostname is properly null-terminated.
- int get_host_name_i (char hostname[], size_t hostnamelen) const;
- // Methods to gain access to the actual address of
- // the underlying internet address structure.
- void *ip_addr_pointer (void) const;
- int ip_addr_size (void) const;
- int determine_type (void) const;
- /// Initialize underlying inet_addr_ to default values
- void reset (void);
- /// Underlying representation.
- /// This union uses the knowledge that the two structures share the
- /// first member, sa_family (as all sockaddr structures do).
- union
- {
- sockaddr_in in4_;
- #if defined (ACE_HAS_IPV6)
- sockaddr_in6 in6_;
- #endif /* ACE_HAS_IPV6 */
- } inet_addr_;
- };
- ACE_END_VERSIONED_NAMESPACE_DECL
- #if defined (__ACE_INLINE__)
- #include "ace/INET_Addr.inl"
- #endif /* __ACE_INLINE__ */
- #include /**/ "ace/post.h"
- #endif /* ACE_INET_ADDR_H */