# ACE_MEM_Addr Class Reference

Defines a C++ wrapper facade for the shared memory transport address family format. More...

`#include <MEM_Addr.h>`

Inheritance diagram for ACE_MEM_Addr:

[legend]
Collaboration diagram for ACE_MEM_Addr:

[legend]
List of all members.

## Public Member Functions

| ACE_MEM_Addr (void)
| Default constructor.
| ACE_MEM_Addr (const ACE_MEM_Addr &)
| Copy constructor.
| ACE_MEM_Addr (u_short port_number)
| Creates an ACE_MEM_Addr from a port_number.
| ACE_MEM_Addr (const ACE_TCHAR port_name[])
| Creates an ACE_MEM_Addr from a port_name.
| ~ACE_MEM_Addr (void)
| Default dtor.
int | initialize_local (u_short port)
| Default initialization routine.
int | same_host (const ACE_INET_Addr &sap)
| Check if sap designates an endpoint on the same host.
int | set (u_short port_number, int encode=1)
int | set (const ACE_TCHAR port_name[])
virtual void * | get_addr (void) const
| Return a pointer to the underlying network address.
virtual void | set_addr (void *, int len)
| Set a pointer to the address.
virtual int | addr_to_string (ACE_TCHAR buffer[], size_t size, int ipaddr_format=1) const
virtual int | string_to_addr (const ACE_TCHAR address[])
| Initializes the external ACE_MEM_Addr from the address.
void | set_port_number (u_short, int encode=1)
| Sets the port number.
u_short | get_port_number (void) const
| Return the port number, converting it into host byte order.
int | get_host_name (ACE_TCHAR hostname[], size_t hostnamelen) const
| Return the character representation of the hostname.
const char * | get_host_name (void) const
const char * | get_host_addr (void) const
| Return the "dotted decimal" external address.
ACE_UINT32 | get_ip_address (void) const
const ACE_INET_Addr & | get_remote_addr (void) const
const ACE_INET_Addr & | get_local_addr (void) const
bool | operator== (const ACE_MEM_Addr &SAP) const
bool | operator== (const ACE_INET_Addr &SAP) const
bool | operator!= (const ACE_MEM_Addr &SAP) const
| Compare two addresses for inequality.
bool | operator!= (const ACE_INET_Addr &SAP) const
virtual u_long | hash (void) const
| Computes and returns hash value.
void | dump (void) const
| Dump the state of an object.

## Public Attributes

| ACE_ALLOC_HOOK_DECLARE
| Declare the dynamic allocation hooks.

## Private Attributes

ACE_INET_Addr | external_
| External INET addr used for identifying host.
ACE_INET_Addr | internal_
| Internal INET addr for accepting/connecting.

## Detailed Description

Defines a C++ wrapper facade for the shared memory transport address family format.

## Constructor & Destructor Documentation

ACE_BEGIN_VERSIONED_NAMESPACE_DECL ACE_MEM_Addr::ACE_MEM_Addr | ( | void |  | ) |

| Default constructor.

ACE_MEM_Addr::ACE_MEM_Addr | ( | const ACE_MEM_Addr & |  | ) |

| Copy constructor.

ACE_MEM_Addr::ACE_MEM_Addr | ( | u_short | port_number | ) |

| Creates an ACE_MEM_Addr from a port_number.

ACE_MEM_Addr::ACE_MEM_Addr | ( | const ACE_TCHAR | port_name[] | ) | `[explicit]`

| Creates an ACE_MEM_Addr from a port_name.

ACE_MEM_Addr::~ACE_MEM_Addr | ( | void |  | ) |

| Default dtor.

## Member Function Documentation

int ACE_MEM_Addr::addr_to_string | ( | ACE_TCHAR | buffer[],
|  | size_t | size,
|  | int | ipaddr_format = `1`
| ) | const`[virtual]`

| Transform the external ACE_MEM_Addr address into string format.

void ACE_MEM_Addr::dump | ( | void |  | ) | const

| Dump the state of an object. Reimplemented from ACE_Addr.

void * ACE_MEM_Addr::get_addr | ( | void |  | ) | const`[virtual]`

| Return a pointer to the underlying network address. Reimplemented from ACE_Addr.

ACE_INLINE const char * ACE_MEM_Addr::get_host_addr | ( | void |  | ) | const

| Return the "dotted decimal" external address.

const char * ACE_MEM_Addr::get_host_name | ( | void |  | ) | const

| Return the character representation of the hostname (this version is non-reentrant since it returns a pointer to a static data area).

int ACE_MEM_Addr::get_host_name | ( | ACE_TCHAR | hostname[],
|  | size_t | hostnamelen
| ) | const

| Return the character representation of the hostname.

ACE_INLINE ACE_UINT32 ACE_MEM_Addr::get_ip_address | ( | void |  | ) | const

| Return the 4-byte external IP address, converting it into host byte order.

ACE_INLINE const ACE_INET_Addr & ACE_MEM_Addr::get_local_addr | ( | void |  | ) | const

ACE_INLINE u_short ACE_MEM_Addr::get_port_number | ( | void |  | ) | const

| Return the port number, converting it into host byte order.

ACE_INLINE const ACE_INET_Addr & ACE_MEM_Addr::get_remote_addr | ( | void |  | ) | const

u_long ACE_MEM_Addr::hash | ( | void |  | ) | const`[virtual]`

| Computes and returns hash value. Reimplemented from ACE_Addr.

int ACE_MEM_Addr::initialize_local | ( | u_short | port | ) |

| Default initialization routine.

ACE_INLINE bool ACE_MEM_Addr::operator!= | ( | const ACE_INET_Addr & | SAP | ) | const

ACE_INLINE bool ACE_MEM_Addr::operator!= | ( | const ACE_MEM_Addr & | SAP | ) | const

| Compare two addresses for inequality.

ACE_INLINE bool ACE_MEM_Addr::operator== | ( | const ACE_INET_Addr & | SAP | ) | const

ACE_INLINE bool ACE_MEM_Addr::operator== | ( | const ACE_MEM_Addr & | SAP | ) | const

| Compare two addresses for equality. The addresses are considered equal if they contain the same IP address and port number.

int ACE_MEM_Addr::same_host | ( | const ACE_INET_Addr & | sap | ) |

| Check if sap designates an endpoint on the same host.

ACE_INLINE int ACE_MEM_Addr::set | ( | const ACE_TCHAR | port_name[] | ) |

| Uses <getservbyname> to initialize an ACE_MEM_Addr from a <port_name>, the remote <host_name>, and the <protocol>.

ACE_INLINE int ACE_MEM_Addr::set | ( | u_short | port_number,
|  | int | encode = `1`
| ) |

| Initializes an ACE_MEM_Addr from a port_number. If encode is enabled then 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 ACE_MEM_Addr::set_addr | ( | void * | ,
|  | int | len
| ) | `[virtual]`

| Set a pointer to the address. Reimplemented from ACE_Addr.

ACE_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE void ACE_MEM_Addr::set_port_number | ( | u_short | ,
|  | int | encode = `1`
| ) |

| Sets the port number.

int ACE_MEM_Addr::string_to_addr | ( | const ACE_TCHAR | address[] | ) | `[virtual]`

| Initializes the external ACE_MEM_Addr from the address.

## Member Data Documentation

ACE_MEM_Addr::ACE_ALLOC_HOOK_DECLARE

| Declare the dynamic allocation hooks. Reimplemented from ACE_Addr.

ACE_INET_Addr ACE_MEM_Addr::external_`[private]`

| External INET addr used for identifying host.

ACE_INET_Addr ACE_MEM_Addr::internal_`[private]`

| Internal INET addr for accepting/connecting.

The documentation for this class was generated from the following files:

- MEM_Addr.h
- MEM_Addr.cpp
- MEM_Addr.inl