ACE  6.4.1
Public Types | Public Member Functions | Public Attributes | Private Attributes | List of all members
ACE_MEM_Connector Class Reference

Defines the format and interface for connecting to a peer on a ACE_MEM_Stream object. More...

#include <MEM_Connector.h>

Inheritance diagram for ACE_MEM_Connector:
Inheritance graph
[legend]
Collaboration diagram for ACE_MEM_Connector:
Collaboration graph
[legend]

Public Types

typedef ACE_INET_Addr PEER_ADDR
 
typedef ACE_MEM_Stream PEER_STREAM
 
- Public Types inherited from ACE_SOCK_Connector
typedef ACE_INET_Addr PEER_ADDR
 
typedef ACE_SOCK_Stream PEER_STREAM
 

Public Member Functions

 ACE_MEM_Connector (void)
 Default constructor. More...
 
 ACE_MEM_Connector (ACE_MEM_Stream &new_stream, const ACE_INET_Addr &remote_sap, ACE_Time_Value *timeout=0, const ACE_Addr &local_sap=ACE_Addr::sap_any, int reuse_addr=0, int flags=0, int perms=0)
 
int connect (ACE_MEM_Stream &new_stream, const ACE_INET_Addr &remote_sap, ACE_Time_Value *timeout=0, const ACE_Addr &local_sap=ACE_Addr::sap_any, int reuse_addr=0, int flags=0, int perms=0)
 
ACE_MEM_IO::Signal_Strategy preferred_strategy (void) const
 Get the preferred signaling strategy. More...
 
void preferred_strategy (ACE_MEM_IO::Signal_Strategy strategy)
 Set the preferred signaling strategy. More...
 
void dump (void) const
 Dump the state of an object. More...
 
- Public Member Functions inherited from ACE_SOCK_Connector
 ACE_SOCK_Connector (void)
 Default constructor. More...
 
 ACE_SOCK_Connector (ACE_SOCK_Stream &new_stream, const ACE_Addr &remote_sap, const ACE_Time_Value *timeout=0, const ACE_Addr &local_sap=ACE_Addr::sap_any, int reuse_addr=0, int flags=0, int perms=0, int protocol=0)
 
 ACE_SOCK_Connector (ACE_SOCK_Stream &new_stream, const ACE_Addr &remote_sap, ACE_QoS_Params qos_params, const ACE_Time_Value *timeout=0, const ACE_Addr &local_sap=ACE_Addr::sap_any, ACE_Protocol_Info *protocolinfo=0, ACE_SOCK_GROUP g=0, u_long flags=0, int reuse_addr=0, int perms=0)
 
int connect (ACE_SOCK_Stream &new_stream, const ACE_Addr &remote_sap, const ACE_Time_Value *timeout=0, const ACE_Addr &local_sap=ACE_Addr::sap_any, int reuse_addr=0, int flags=0, int perms=0, int protocol=0)
 
int connect (ACE_SOCK_Stream &new_stream, const ACE_Addr &remote_sap, ACE_QoS_Params qos_params, const ACE_Time_Value *timeout=0, const ACE_Addr &local_sap=ACE_Addr::sap_any, ACE_Protocol_Info *protocolinfo=0, ACE_SOCK_GROUP g=0, u_long flags=0, int reuse_addr=0, int perms=0)
 
 ~ACE_SOCK_Connector (void)
 Default destructor. More...
 
int complete (ACE_SOCK_Stream &new_stream, ACE_Addr *remote_sap=0, const ACE_Time_Value *timeout=0)
 
bool reset_new_handle (ACE_HANDLE handle)
 Resets any event associations on this handle. 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_SOCK_Connector
 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks. More...
 

Private Attributes

ACE_MEM_Addr address_
 The acceptor address this connector is connecting to. More...
 
ACE_MEM_SAP::MALLOC_OPTIONS malloc_options_
 
ACE_MEM_IO::Signal_Strategy preferred_strategy_
 Preferred signaling strategy. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ACE_SOCK_Connector
int shared_open (ACE_SOCK_Stream &new_stream, int protocol_family, int protocol, int reuse_addr)
 
int shared_open (ACE_SOCK_Stream &new_stream, int protocol_family, int protocol, ACE_Protocol_Info *protocolinfo, ACE_SOCK_GROUP g, u_long flags, int reuse_addr)
 
int shared_connect_start (ACE_SOCK_Stream &new_stream, const ACE_Time_Value *timeout, const ACE_Addr &local_sap)
 Perform operations that must be called before <ACE_OS::connect>. More...
 
int shared_connect_finish (ACE_SOCK_Stream &new_stream, const ACE_Time_Value *timeout, int result)
 Perform operations that must be called after <ACE_OS::connect>. More...
 

Detailed Description

Defines the format and interface for connecting to a peer on a ACE_MEM_Stream object.

Member Typedef Documentation

Constructor & Destructor Documentation

ACE_MEM_Connector::ACE_MEM_Connector ( void  )

Default constructor.

ACE_MEM_Connector::ACE_MEM_Connector ( ACE_MEM_Stream new_stream,
const ACE_INET_Addr remote_sap,
ACE_Time_Value timeout = 0,
const ACE_Addr local_sap = ACE_Addr::sap_any,
int  reuse_addr = 0,
int  flags = 0,
int  perms = 0 
)

Actively connect to a peer, producing a connected ACE_MEM_Stream object if the connection succeeds.

Parameters
new_streamThe ACE_MEM_Stream object that will be connected to the peer.
remote_sapThe address that we are trying to connect to. The protocol family of remote_sap is used for the connected socket. That is, if remote_sap contains an IPv6 address, a socket with family PF_INET6 will be used, else it will be PF_INET.
Note
remote_sap must be an address on the local host.
Parameters
timeoutPointer to an ACE_Time_Value object with amount of time to wait to connect. If the pointer is 0 then the call blocks until the connection attempt is complete, whether it succeeds or fails. If *timeout == {0, 0} then the connection is done using nonblocking mode. In this case, if the connection can't be made immediately, this method returns -1 and errno == EWOULDBLOCK. If *timeout > {0, 0} then this is the maximum amount of time to wait before timing out; if the specified amount of time passes before the connection is made, this method returns -1 and errno == ETIME. Note the difference between this case and when a blocking connect is attempted that TCP times out - in the latter case, errno will be ETIMEDOUT.
local_sap(optional) The local address to bind to. If it's the default value of ACE_Addr::sap_any then the OS will choose an unused port.
reuse_addr(optional) If the value is 1, the local address (local_sap) is reused, even if it hasn't been cleaned up yet.
flagsIgnored.
permsIgnored.

Member Function Documentation

int ACE_MEM_Connector::connect ( ACE_MEM_Stream new_stream,
const ACE_INET_Addr remote_sap,
ACE_Time_Value timeout = 0,
const ACE_Addr local_sap = ACE_Addr::sap_any,
int  reuse_addr = 0,
int  flags = 0,
int  perms = 0 
)

Actively connect to a peer, producing a connected ACE_MEM_Stream object if the connection succeeds.

Parameters
new_streamThe ACE_MEM_Stream object that will be connected to the peer.
remote_sapThe address that we are trying to connect to. The protocol family of remote_sap is used for the connected socket. That is, if remote_sap contains an IPv6 address, a socket with family PF_INET6 will be used, else it will be PF_INET.
Note
remote_sap must be an address on the local host.
Parameters
timeoutPointer to an ACE_Time_Value object with amount of time to wait to connect. If the pointer is 0 then the call blocks until the connection attempt is complete, whether it succeeds or fails. If *timeout == {0, 0} then the connection is done using nonblocking mode. In this case, if the connection can't be made immediately, this method returns -1 and errno == EWOULDBLOCK. If *timeout > {0, 0} then this is the maximum amount of time to wait before timing out; if the specified amount of time passes before the connection is made, this method returns -1 and errno == ETIME. Note the difference between this case and when a blocking connect is attempted that TCP times out - in the latter case, errno will be ETIMEDOUT.
local_sap(optional) The local address to bind to. If it's the default value of ACE_Addr::sap_any then the OS will choose an unused port.
reuse_addr(optional) If the value is 1, the local address (local_sap) is reused, even if it hasn't been cleaned up yet.
flagsIgnored.
permsIgnored.
Returns
Returns 0 if the connection succeeds. If it fails, -1 is returned and errno contains a specific error code.
void ACE_MEM_Connector::dump ( void  ) const

Dump the state of an object.

ACE_MEM_IO::Signal_Strategy ACE_MEM_Connector::preferred_strategy ( void  ) const
inline

Get the preferred signaling strategy.

void ACE_MEM_Connector::preferred_strategy ( ACE_MEM_IO::Signal_Strategy  strategy)
inline

Set the preferred signaling strategy.

Member Data Documentation

ACE_MEM_Connector::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

ACE_MEM_Addr ACE_MEM_Connector::address_
private

The acceptor address this connector is connecting to.

ACE_MEM_SAP::MALLOC_OPTIONS ACE_MEM_Connector::malloc_options_
private

A cached MALLOC_OPTIONS that the MEM_Connector used to initialize the shared memory malloc update connection establishment.

ACE_MEM_IO::Signal_Strategy ACE_MEM_Connector::preferred_strategy_
private

Preferred signaling strategy.


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