ACE_SOCK_Stream
object.
More...
#include <SOCK_Connector.h>
Public Types | |
typedef ACE_INET_Addr | PEER_ADDR |
typedef ACE_SOCK_Stream | PEER_STREAM |
Public Member Functions | |
ACE_SOCK_Connector (void) | |
Default constructor. | |
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 dtor. | |
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. | |
void | dump (void) const |
Dump the state of an object. | |
Public Attributes | |
ACE_ALLOC_HOOK_DECLARE | |
Declare the dynamic allocation hooks. | |
Protected Member Functions | |
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>. | |
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>. |
ACE_SOCK_Stream
object.
The ACE_SOCK_Connector
doesn't have a socket of its own, i.e., it simply "borrows" the one from the ACE_SOCK_Stream
that's being connected. The reason for this is that the underlying socket API doesn't use a factory socket to connect data mode sockets. Therefore, there's no need to inherit ACE_SOCK_Connector
from ACE_SOCK
. A nice side-effect of this is that ACE_SOCK_Connector
objects do not store state so they can be used reentrantly in multithreaded programs.
Reimplemented in ACE_LSOCK_Connector.
Reimplemented in ACE_LSOCK_Connector.
ACE_SOCK_Connector::ACE_SOCK_Connector | ( | void | ) |
Default constructor.
ACE_SOCK_Connector::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 | |||
) |
Actively connect to a peer, producing a connected ACE_SOCK_Stream
object if the connection succeeds.
new_stream | The ACE_SOCK_Stream object that will be connected to the peer. | |
remote_sap | The 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. | |
timeout | Pointer 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. | |
flags | Ignored. | |
perms | Ignored. | |
protocol | (optional) If value is 0, default SOCK_STREAM protocol is selected by kernel (typically TCP). |
ACE_SOCK_Connector::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 | |||
) |
Actively connect to a peer, producing a connected ACE_SOCK_Stream
object if the connection succeeds.
new_stream | The ACE_SOCK_Stream object that will be connected to the peer. | |
remote_sap | The 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. | |
qos_params | Contains QoS parameters that are passed to the IntServ (RSVP) and DiffServ protocols. |
timeout | Pointer 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. | |
flags | Ignored. | |
perms | Ignored. |
ACE_SOCK_Connector::~ACE_SOCK_Connector | ( | void | ) |
Default dtor.
int ACE_SOCK_Connector::complete | ( | ACE_SOCK_Stream & | new_stream, | |
ACE_Addr * | remote_sap = 0 , |
|||
const ACE_Time_Value * | timeout = 0 | |||
) |
Try to complete a nonblocking connection that was begun by a previous call to connect with a {0, 0} ACE_Time_Value timeout.
new_stream | The ACE_SOCK_Stream object that will be connected to the peer. | |
remote_sap | If non-0, it points to the ACE_INET_Addr object that will contain the address of the connected peer. | |
timeout | Same values and return value possibilites as for connect(). |
int ACE_SOCK_Connector::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 | |||
) |
Actively connect to a peer, producing a connected ACE_SOCK_Stream
object if the connection succeeds.
new_stream | The ACE_SOCK_Stream object that will be connected to the peer. | |
remote_sap | The 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. | |
qos_params | Contains QoS parameters that are passed to the IntServ (RSVP) and DiffServ protocols. |
timeout | Pointer 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. | |
flags | Ignored. | |
perms | Ignored. |
int ACE_SOCK_Connector::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 | |||
) |
Actively connect to a peer, producing a connected ACE_SOCK_Stream
object if the connection succeeds.
new_stream | The ACE_SOCK_Stream object that will be connected to the peer. | |
remote_sap | The 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. | |
timeout | Pointer 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. | |
flags | Ignored. | |
perms | Ignored. | |
protocol | (optional) If value is 0, default SOCK_STREAM protocol is selected by kernel (typically TCP). |
void ACE_SOCK_Connector::dump | ( | void | ) | const |
bool ACE_SOCK_Connector::reset_new_handle | ( | ACE_HANDLE | handle | ) |
Resets any event associations on this handle.
int ACE_SOCK_Connector::shared_connect_finish | ( | ACE_SOCK_Stream & | new_stream, | |
const ACE_Time_Value * | timeout, | |||
int | result | |||
) | [protected] |
Perform operations that must be called after <ACE_OS::connect>.
int ACE_SOCK_Connector::shared_connect_start | ( | ACE_SOCK_Stream & | new_stream, | |
const ACE_Time_Value * | timeout, | |||
const ACE_Addr & | local_sap | |||
) | [protected] |
Perform operations that must be called before <ACE_OS::connect>.
int ACE_SOCK_Connector::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 | |||
) | [protected] |
Perform operations that ensure the socket is opened using QoS-enabled semantics.
int ACE_SOCK_Connector::shared_open | ( | ACE_SOCK_Stream & | new_stream, | |
int | protocol_family, | |||
int | protocol, | |||
int | reuse_addr | |||
) | [protected] |
Perform operations that ensure the socket is opened using BSD-style semantics (no QoS).