summaryrefslogtreecommitdiff
path: root/ace/MEM_Acceptor.h
blob: efcdb813e3c51353fe8499a56891486d48f37dff (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
/* -*- C++ -*- */
// $Id$

// ============================================================================
//
// = LIBRARY
//    ace
//
// = FILENAME
//    MEM_Aceeptor.h
//
// = AUTHOR
//    Nanbor Wang <nanbor@cs.wustl.edu>
//
// ============================================================================

#ifndef ACE_MEM_ACCEPTOR_H
#include "ace/pre.h"
#define ACE_MEM_ACCEPTOR_H

#include "ace/SOCK_Acceptor.h"

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

#include "ace/MEM_Stream.h"
#include "ace/MEM_Addr.h"

// Forward decl.
class ACE_Reactor;

class ACE_Export ACE_MEM_Acceptor : public ACE_SOCK_Acceptor
{
  // = TITLE
  //     Defines the format and interface for the acceptor side of the
  //     local mmap stream.
  //
  // = DESCRIPTION
  //     This class should be modified to prevent user passing a
  //     non-localhost endpoint as the acceptor listen point because
  //     it doesn't make any sense at all to make the listening
  //     endpoint visible (or connectable) anywhere outside of this
  //     machine.  However, the type of endpoint is left as <ACE_Addr>
  //     so we can later changed to use UNIX sockets with mmap stream
  //     if so desired.  (Currently, using UNIX socket with this class
  //     will not work.)
public:
  // = Initialization methods.
  ACE_MEM_Acceptor (void);
  // Default constructor.

  ~ACE_MEM_Acceptor (void);
  // destructor.

  ACE_MEM_Acceptor (const ACE_MEM_Addr &remote_sap,
                    int reuse_addr = 0,
                    int backlog = ACE_DEFAULT_BACKLOG,
                    int protocol = 0);
  // Initiate a passive mode socket.

  int open (const ACE_MEM_Addr &local_sap,
            int reuse_addr = 0,
            int backlog = ACE_DEFAULT_BACKLOG,
            int protocol = 0);
  // Initialize a passive-mode BSD-style acceptor socket (no QoS).
  // <local_sap> is the address that we're going to listen for
  // connections on.  If <reuse_addr> is 1 then we'll use the
  // <SO_REUSEADDR> to reuse this address.  Returns 0 on success and
  // -1 on failure.

  int accept (ACE_MEM_Stream &new_ipc_sap,
              ACE_MEM_Addr *remote_addr = 0,
              ACE_Time_Value *timeout = 0,
              int restart = 1,
              int reset_new_handle = 0);
  // Accept a new data transfer connection.

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

  const ASYS_TCHAR *mmap_prefix (void) const;
  void mmap_prefix (ASYS_TCHAR *prefix);
  // Accessor/mutator of mmap filename prefix.  By default, the
  // <mmap_prefix_> is not set and the mmap filename is
  // ${(TMP|TEMP)}//ACE_MEM_Acceptor_(port-number)_(&stream),
  // otherwise, it is <mmap_prefix_>_(port-number)_(&stream),
  // <mmap_prefix_> should include _absolute_ path so the connector
  // within the same host can located the mmap file.  Example:
  // /tmp/mmapfile.

  int get_local_addr (ACE_MEM_Addr &) const;
  // Return the local endpoint address in the referenced <ACE_Addr>.
  // Returns 0 if successful, else -1.

  ACE_MEM_SAP::MALLOC_OPTIONS& malloc_options (void);
  // Accessor to the mmap options.

  // = Meta-type info
  typedef ACE_MEM_Addr PEER_ADDR;
  typedef ACE_MEM_Stream PEER_STREAM;

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

  ACE_ALLOC_HOOK_DECLARE;
  // Declare the dynamic allocation hooks.

protected:
  // = The following methods should not be accessable externally
  //   because MEM_Acceptor do not support their semantics.
  int open (const ACE_Addr &local_sap,
            int reuse_addr = 0,
            int protocol_family = PF_INET,
            int backlog = ACE_DEFAULT_BACKLOG,
            int protocol = 0);

  int open (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);

  int accept (ACE_SOCK_Stream &new_stream,
              ACE_Addr *remote_addr = 0,
              ACE_Time_Value *timeout = 0,
              int restart = 1,
              int reset_new_handle = 0) const;

  int accept (ACE_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;

private:
  ASYS_TCHAR *mmap_prefix_;
  // The filename prefix of the created mmap files.  It should
  // contains the absolute path name of the file.

  ACE_MEM_SAP::MALLOC_OPTIONS malloc_options_;
  // A cached MALLOC_OPTIONS.  MEM_Accaptor use it to create the shared
  // mamory malloc upon every incoming connection.
};

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

#include "ace/post.h"
#endif /* ACE_MEM_ACCEPTOR_H */