ACE  6.5.8
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Public Attributes | Private Attributes | List of all members
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:
Inheritance graph
[legend]

Public Member Functions

 ACE_MEM_Addr (void)
 Default constructor. More...
 
 ACE_MEM_Addr (const ACE_MEM_Addr &)
 Copy constructor. More...
 
 ACE_MEM_Addr (u_short port_number)
 Creates an ACE_MEM_Addr from a port_number. More...
 
 ACE_MEM_Addr (const ACE_TCHAR port_name[])
 Creates an ACE_MEM_Addr from a port_name. More...
 
 ~ACE_MEM_Addr (void)
 Default dtor. More...
 
int initialize_local (u_short port)
 Default initialization routine. More...
 
int same_host (const ACE_INET_Addr &sap)
 Check if sap designates an endpoint on the same host. More...
 
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. More...
 
virtual void set_addr (const void *, int len)
 Set a pointer to the address. More...
 
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. More...
 
void set_port_number (u_short, int encode=1)
 Sets the port number. More...
 
u_short get_port_number (void) const
 Return the port number, converting it into host byte order. More...
 
int get_host_name (ACE_TCHAR hostname[], size_t hostnamelen) const
 Return the character representation of the hostname. More...
 
const char * get_host_name (void) const
 
const char * get_host_addr (char *addr, int addr_size) const
 Return the "dotted decimal" external address. More...
 
const char * get_host_addr (void) const
 Return the "dotted decimal" external address. More...
 
ACE_UINT32 get_ip_address (void) const
 Return the 4-byte IP address, converting it into host byte order. More...
 
const ACE_INET_Addrget_remote_addr (void) const
 
const ACE_INET_Addrget_local_addr (void) const
 
bool operator== (const ACE_MEM_Addr &SAP) const
 Compare two addresses for equality. More...
 
bool operator== (const ACE_INET_Addr &SAP) const
 
bool operator!= (const ACE_MEM_Addr &SAP) const
 Compare two addresses for inequality. More...
 
bool operator!= (const ACE_INET_Addr &SAP) const
 
virtual u_long hash (void) const
 Computes and returns hash value. More...
 
void dump (void) const
 Dump the state of an object. More...
 
- Public Member Functions inherited from ACE_Addr
 ACE_Addr (int type=-1, int size=-1)
 Initializes instance variables. More...
 
virtual ~ACE_Addr (void)
 Destructor. More...
 
int get_size (void) const
 Return the size of the address. More...
 
void set_size (int size)
 Sets the size of the address. More...
 
int get_type (void) const
 Get the type of the address. More...
 
void set_type (int type)
 Set the type of the address. More...
 
bool operator== (const ACE_Addr &sap) const
 Check for address equality. More...
 
bool operator!= (const ACE_Addr &sap) const
 Check for address inequality. More...
 
void base_set (int type, int size)
 Initializes instance variables. More...
 
void dump (void) const
 Dump the state of an object. More...
 

Public Attributes

 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks. More...
 
- Public Attributes inherited from ACE_Addr
 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks. More...
 

Private Attributes

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

Additional Inherited Members

- Static Public Attributes inherited from ACE_Addr
static const ACE_Addr sap_any
 Wild-card address. More...
 
- Protected Attributes inherited from ACE_Addr
int addr_type_
 e.g., AF_UNIX, AF_INET, AF_SPIPE, etc. More...
 
int addr_size_
 Number of bytes in the address. More...
 

Detailed Description

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

Constructor & Destructor Documentation

ACE_MEM_Addr::ACE_MEM_Addr ( void  )

Default constructor.

ACE_MEM_Addr::ACE_MEM_Addr ( const ACE_MEM_Addr sa)

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.

void * ACE_MEM_Addr::get_addr ( void  ) const
virtual

Return a pointer to the underlying network address.

Reimplemented from ACE_Addr.

const char * ACE_MEM_Addr::get_host_addr ( char *  addr,
int  addr_size 
) const
inline

Return the "dotted decimal" external address.

Return the "dotted decimal" external Internet address representation of the hostname storing it in the addr (which is assumed to be addr_size bytes long). This version is reentrant.

const char * ACE_MEM_Addr::get_host_addr ( void  ) const
inline

Return the "dotted decimal" external address.

Return the "dotted decimal" external 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.

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

Return the character representation of the hostname.

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).

ACE_UINT32 ACE_MEM_Addr::get_ip_address ( void  ) const
inline

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

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

const ACE_INET_Addr & ACE_MEM_Addr::get_local_addr ( void  ) const
inline
u_short ACE_MEM_Addr::get_port_number ( void  ) const
inline

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

Return the port number.

const ACE_INET_Addr & ACE_MEM_Addr::get_remote_addr ( void  ) const
inline
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.

bool ACE_MEM_Addr::operator!= ( const ACE_MEM_Addr SAP) const
inline

Compare two addresses for inequality.

bool ACE_MEM_Addr::operator!= ( const ACE_INET_Addr SAP) const
inline
bool ACE_MEM_Addr::operator== ( const ACE_MEM_Addr SAP) const
inline

Compare two addresses for equality.

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

bool ACE_MEM_Addr::operator== ( const ACE_INET_Addr SAP) const
inline
int ACE_MEM_Addr::same_host ( const ACE_INET_Addr sap)

Check if sap designates an endpoint on the same host.

int ACE_MEM_Addr::set ( u_short  port_number,
int  encode = 1 
)
inline

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.

int ACE_MEM_Addr::set ( const ACE_TCHAR  port_name[])
inline

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

void ACE_MEM_Addr::set_addr ( const void *  addr,
int  len 
)
virtual

Set a pointer to the address.

Reimplemented from ACE_Addr.

void ACE_MEM_Addr::set_port_number ( u_short  port_number,
int  encode = 1 
)
inline

Sets the port number.

Set 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.

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: