summaryrefslogtreecommitdiff
path: root/ace/ATM_Connector.h
blob: 62739b9cde517124ad6bd05ce1232a7b098bc975 (plain)
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
118
119
120
121
122
123
124
125
126
127
128
129
130
/* -*- C++ -*- */
// $Id$

// ============================================================================
//
// = LIBRARY
//    ace
//
// = FILENAME
//    ATM_Connector.h
//
// = AUTHOR
//    Joe Hoffert
//
// ============================================================================

#ifndef ACE_ATM_CONNECTOR_H
#define ACE_ATM_CONNECTOR_H

#include "ace/ATM_Stream.h"
#include "ace/ATM_Params.h"
#include "ace/ATM_QoS.h"

#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */

#if defined (ACE_HAS_ATM)

#if defined (ACE_WIN32)
#include "SOCK_Connector.h"
typedef ACE_SOCK_Connector ATM_Connector;
#else
#include "XTI_ATM_Mcast.h"
typedef ACE_XTI_ATM_Mcast ATM_Connector;
#endif

class ACE_Export ACE_ATM_Connector 
{
  // = TITLE
  //     Defines an active connection factory for the ACE_ATM C++
  //     wrappers.
public:
  // = Initialization methods.
  ACE_ATM_Connector (void);
  // Default constructor.

  ACE_ATM_Connector (ACE_ATM_Stream &new_stream,
                     const ACE_Addr &remote_sap,
                     ACE_ATM_Params params = ACE_ATM_Params(),
                     ACE_ATM_QoS options = ACE_ATM_QoS(),
                     ACE_Time_Value *timeout = 0,
                     const ACE_Addr &local_sap = ACE_Addr::sap_any,
                     int reuse_addr = 0,
#if defined (ACE_WIN32)
                     int flags = 0,
#else
                     int flags = O_RDWR,
#endif /* ACE_WIN32 */
                     int perms = 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 <params> are the parameters needed for either socket
  // or XTI/ATM connections.  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.

  connect (ACE_ATM_Stream &new_stream,
           const ACE_Addr &remote_sap,
           ACE_ATM_Params params = ACE_ATM_Params(),
           ACE_ATM_QoS options = ACE_ATM_QoS(),
           ACE_Time_Value *timeout = 0,
           const ACE_Addr &local_sap = ACE_Addr::sap_any,
           int reuse_addr = 0,
#if defined (ACE_WIN32)
           int flags = 0,
#else
           int flags = O_RDWR,
#endif /* ACE_WIN32 */
           int perms = 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 <params> are the parameters needed for either socket
  // or XTI/ATM connections.  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.

  int complete (ACE_ATM_Stream &new_stream,
                ACE_Addr *remote_sap,
                ACE_Time_Value *tv);
  // 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

  void dump (void) const;
  // Dump the state of an object.

  ACE_ALLOC_HOOK_DECLARE;
  // Declare the dynamic allocation hooks.

private:
  ATM_Connector connector_;
};

#if defined (__ACE_INLINE__)
#include "ace/ATM_Connector.i"
#endif /* __ACE_INLINE__ */

#endif /* ACE_HAS_ATM */
#endif /* ACE_ATM_CONNECTOR_H */