summaryrefslogtreecommitdiff
path: root/ace/SSL/SSL_SOCK_Acceptor.h
blob: 22653ccf8a8ed907668c36262c0160ec5945b372 (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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
// -*- C++ -*-

//=============================================================================
/**
 *  @file    SSL_SOCK_Acceptor.h
 *
 *  $Id$
 *
 *  @author John Heitmann
 *  @author Chris Zimman
 *  @author Ossama Othman <ossama@uci.edu>
 */
//=============================================================================


#ifndef ACE_SSL_SOCK_ACCEPTOR_H
#define ACE_SSL_SOCK_ACCEPTOR_H

#include "ace/pre.h"

#include "SSL_Export.h"

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

#include "SSL_SOCK_Stream.h"

#include "ace/SOCK_Acceptor.h"
#include "ace/Reactor.h"

/**
 * @class ACE_SSL_SOCK_Acceptor
 *
 * @brief Defines a factory that creates new <ACE_SSL_SOCK_Stream>s
 * passively.
 *
 * The ACE_SSL_SOCK_Acceptor has its own ACE_SOCK_Acceptor
 * which handles virtually all of the socket acceptance. This
 * class is a wrapper which only adds the SSL acceptance.
 */
class ACE_SSL_Export ACE_SSL_SOCK_Acceptor : public ACE_SSL_SOCK
{
public:

  /// Default constructor.
  ACE_SSL_SOCK_Acceptor (ACE_Reactor *reactor =
                           ACE_Reactor::instance ());

  /// Default dtor.
  ~ACE_SSL_SOCK_Acceptor (void);

  /**
   * Initiate a passive mode SSL/BSD-style acceptor socket.
   * "local_sap" is the address that we're going to listen for
   * connections on.
   */
  ACE_SSL_SOCK_Acceptor (const ACE_Addr &local_sap,
			 int reuse_addr = 0,
			 int protocol_family = PF_INET,
			 int backlog = ACE_DEFAULT_BACKLOG,
			 int protocol = 0,
                         ACE_Reactor *reactor =
                           ACE_Reactor::instance ()
);

  /// Initialize a passive-mode QoS-enabled acceptor socket.  Returns 0
  /// on success and -1 on failure.
  ACE_SSL_SOCK_Acceptor (const ACE_Addr &local_sap,
			 ACE_Protocol_Info *protocolinfo,
			 ACE_SOCK_GROUP g,
			 u_long flags,
			 int reuse_addr,
			 int protocol_family,
			 int backlog = ACE_DEFAULT_BACKLOG,
			 int protocol = 0,
                         ACE_Reactor *reactor =
                           ACE_Reactor::instance ());

  /**
   * Initiate a passive mode SSL/BSD-style acceptor socket.
   * "local_sap" is the address that we're going to listen for
   * connections on.
   */
  int open (const ACE_Addr &local_sap,
            int reuse_addr = 0,
            int protocol_family = PF_INET,
            int backlog = ACE_DEFAULT_BACKLOG,
            int protocol = 0);

  /// Close the listening socket.
  int close (void);

  /**
   * @name Passive Connection "accept" Methods
   */
  //@{
  /**
   * Accept a new <ACE_SSL_SOCK_Stream> connection.  A <timeout> of 0
   * means block forever, a <timeout> of {0, 0} means poll.  <restart>
   * == 1 means "restart if interrupted," i.e., if errno == EINTR.
   */
  int accept (ACE_SSL_SOCK_Stream &new_stream,
              ACE_Addr *remote_addr = 0,
              ACE_Time_Value *timeout = 0,
              int restart = 1,
              int reset_new_handle = 0) const;

  /**
   * Accept a new <ACE_SSL_SOCK_Stream> connection using the RVSP QoS
   * information in <qos_params>.  A <timeout> of 0 means block
   * forever, a <timeout> of {0, 0} means poll.  <restart> == 1 means
   * "restart if interrupted," i.e., if errno == EINTR.
   */
  int accept (ACE_SSL_SOCK_Stream &new_stream,
	      ACE_Accept_QoS_Params qos_params,
              ACE_Addr *remote_addr = 0,
              ACE_Time_Value *timeout = 0,
              int restart = 1,
              int reset_new_handle = 0) const;
  //@}

  /// Set the Reactor used when completing the SSL passive
  /// connection.
  void reactor (ACE_Reactor *r);

  /// Return the Reactor used when completing the SSL passive
  /// connection.
  ACE_Reactor *reactor (void) const;

  /// Meta-type info
  //@{
  typedef ACE_INET_Addr PEER_ADDR;
  typedef ACE_SSL_SOCK_Stream PEER_STREAM;
  //@}

  /// Declare the dynamic allocation hooks.
  ACE_ALLOC_HOOK_DECLARE;

protected:

  /// Perform operations that must occur before <ACE_OS::accept> is
  /// called.
  int shared_accept_start (ACE_Time_Value *timeout,
			   int restart,
			   int &in_blocking_mode) const;

  /// Perform operations that must occur after <ACE_OS::accept> is
  /// called.
  int shared_accept_finish (ACE_SSL_SOCK_Stream &new_stream,
			    int in_blocking_mode,
			    int reset_new_handle) const;

  /// Complete blocking SSL passive connection establishment.
  int ssl_accept (ACE_SSL_SOCK_Stream &new_stream) const;

  /// Complete non-blocking SSL passive connection establishment.
  int ssl_accept (ACE_SSL_SOCK_Stream &new_stream,
                  ACE_Time_Value *timeout) const;

private:

  /// The BSD-socket workhorse
  ACE_SOCK_Acceptor acceptor_;

  /// Pointer to the Reactor responsible for dispatching the event
  /// handler responsible for completing the SSL passive connection.
  ACE_Reactor *reactor_;

};

#if !defined (ACE_LACKS_INLINE_FUNCTIONS)
#include "SSL_SOCK_Acceptor.i"
#endif /* ACE_LACKS_INLINE_FUNCTIONS */

#include "ace/post.h"

#endif /* ACE_SSL_SOCK_ACCEPTOR_H */