1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
/* -*- C++ -*- */
// $Id$
// ============================================================================
//
// = LIBRARY
// ace
//
// = FILENAME
// SOCK_Connector.h
//
// = AUTHOR
// Doug Schmidt
//
// ============================================================================
#ifndef ACE_SOCK_CONNECTOR_H
#define ACE_SOCK_CONNECTOR_H
#include "ace/SOCK_Stream.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
#include "ace/Time_Value.h"
class ACE_Export ACE_SOCK_Connector
{
// = TITLE
// Defines an active connection factory for the socket wrappers.
//
// = DESCRIPTION
// Objects of this class do not store state so they can be used
// reentrantly in multi-threaded programs...
public:
// = Initialization routines.
ACE_SOCK_Connector (void);
// Default constructor.
ACE_SOCK_Connector (ACE_SOCK_Stream &new_stream,
const ACE_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 protocol_family = PF_INET,
int protocol = 0);
// Actively connect and produce a <new_stream> if things go well.
// The <remote_sap> is the address that we are trying to connect
// with. The <timeout> is the amount of time to wait to connect.
// If it's 0 then we block indefinitely. If *timeout == {0, 0} then
// the connection is done using non-blocking mode. In this case, if
// the connection can't be made immediately the value of -1 is
// returned with <errno == EWOULDBLOCK>. If *timeout > {0, 0} then
// this is the amount of time to wait before timing out. If the
// time expires before the connection is made <errno == ETIME>. The
// <local_sap> is the value of local address to bind to. If it's
// the default value of <ACE_Addr::sap_any> then the user is letting
// the OS do the binding. If <reuse_addr> == 1 then the
// <local_addr> is reused, even if it hasn't been cleanedup yet.
~ACE_SOCK_Connector (void);
// Default dtor.
int connect (ACE_SOCK_Stream &new_stream,
const ACE_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 protocol_family = PF_INET,
int protocol = 0);
// Actively connect and produce a <new_stream> if things go well.
// The <remote_sap> is the address that we are trying to connect
// with. The <timeout> is the amount of time to wait to connect.
// If it's 0 then we block indefinitely. If *timeout == {0, 0} then
// the connection is done using non-blocking mode. In this case, if
// the connection can't be made immediately the value of -1 is
// returned with <errno == EWOULDBLOCK>. If *timeout > {0, 0} then
// this is the amount of time to wait before timing out. If the
// time expires before the connection is made <errno == ETIME>. The
// <local_sap> is the value of local address to bind to. If it's
// the default value of <ACE_Addr::sap_any> then the user is letting
// the OS do the binding. If <reuse_addr> == 1 then the
// <local_addr> is reused, even if it hasn't been cleanedup yet.
// = Completion routine.
int complete (ACE_SOCK_Stream &new_stream,
ACE_Addr *remote_sap = 0,
ACE_Time_Value *timeout = 0);
// Try to complete a non-blocking connection.
// If connection completion is successful then <new_stream> contains
// the connected ACE_SOCK_Stream. If <remote_sap> is non-NULL then it
// will contain the address of the connected peer.
int reset_new_handle (ACE_HANDLE handle);
// Resets any event associations on this handle
// = Meta-type info
typedef ACE_INET_Addr PEER_ADDR;
typedef ACE_SOCK_Stream PEER_STREAM;
void dump (void) const;
// Dump the state of an object.
ACE_ALLOC_HOOK_DECLARE;
// Declare the dynamic allocation hooks.
};
#if !defined (ACE_LACKS_INLINE_FUNCTIONS)
#include "ace/SOCK_Connector.i"
#endif
#endif /* ACE_SOCK_CONNECTOR_H */
|
