summaryrefslogtreecommitdiff
path: root/docs/tutorials/001/page03.html
blob: e6d0b708c169538a8c0e306d54f4e7e4e976cac6 (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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
<HTML>
<HEAD>
   <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
   <META NAME="GENERATOR" CONTENT="Mozilla/4.04 [en] (X11; I; Linux 2.0.32 i486) [Netscape]">
   <META NAME="Author" CONTENT="James CE Johnson">
   <META NAME="Description" CONTENT="A first step towards using ACE productively">
   <TITLE>ACE Tutorial 001</TITLE>
</HEAD>
<BODY TEXT="#000000" BGCOLOR="#FFFFFF" LINK="#000FFF" VLINK="#FF0F0F">

<CENTER><B><FONT SIZE=+2>ACE Tutorial 001</FONT></B></CENTER>

<CENTER><B><FONT SIZE=+2>A Beginners Guide to Using the ACE Toolkit</FONT></B></CENTER>


<P>
<HR WIDTH="100%">

<P>Now we begin to look at the <A HREF="acceptor.h">acceptor</A> object.

<P>
<HR WIDTH="100%">
<PRE>
#if !defined (_CLIENT_ACCEPTOR_H)
#define _CLIENT_ACCEPTOR_H

/*
  A SOCK_Acceptor knows how to accept socket connections.  We'll use
  one of those at the heart of our Logging_Acceptor.
 */
#include "ace/SOCK_Acceptor.h"

/*
  An Event_Handler is what you register with ACE_Reactor.  When events occur,
  the reactor will callback on the Event_Handler.  More on that in a few lines.
 */
#include "ace/Event_Handler.h"

/*
  When a client connects, we'll create a Logging_Handler to deal with the
  connection.  Here, we bring in that declaration.
 */
#include "logger.h"

/*
  Our Logging_Acceptor is derived from ACE_Event_Handler.  That lets the
  reactor treat our acceptor just like every other handler.
 */
class Logging_Acceptor : public ACE_Event_Handler
{

friend class Logging_Handler;

public:

  /*
    For this simple case we won't bother with either constructor or
    destructor.  In a real application you would certainly have them.
   */

  /*
    Here's the open() method we called from main().  We have two things
    to accomplish here:  (1)  Open the acceptor so that we can hear
    client requests and (2) register ourselves with the reactor so that
    we can respond to those requests.
   */
  int open (const ACE_INET_Addr &amp;_addr, ACE_Reactor * _reactor )
  {
    /*
      Perform the open() on the acceptor.  We pass through the address
      at which main() wants us to listen.  The second parameter tells
      the acceptor it is OK to reuse the address.  This is necessary
      sometimes to get around closed connections that haven't timed out.
     */
     if (this->peer_acceptor_.open (_addr, 1) == -1)
       return -1;

    /*
      Remember the reactor we're using.  We'll need it later when we
      create a client connection handler.
     */
    reactor_ = _reactor;

    /*
      Now we can register with the reactor we were given.  Since the reactor
      pointer is global, we could have just used that but it's gross enough
      already.
      Notice that we can pass 'this' right into the registration since we're
      derived from ACE_Event_Handler.  We also provide ACCEPT_MASK to tell
      the reactor that we want to know about accept requests from clients.
     */
    return _reactor->register_handler( this, ACE_Event_Handler::ACCEPT_MASK );
  }
        
private:

  /*
    To provide multi-OS abstraction, ACE uses the concept of "handles" for
    connection endpoints.  In Unix, this is a traditional file descriptor
    (or integer).  On other OS's, it may be something else.
    The reactor will need to get the handle (file descriptor) to satisfy
    it's own internal needs.  Our relevant handle is the handle of the
    acceptor object, so that's what we provide.
   */
  ACE_HANDLE get_handle (void) const
  { 
    return this->peer_acceptor_.get_handle (); 
  }

  /*
    When an accept request arrives, the reactor will invoke the handle_input()
    callback.  This is where we deal with the connection request.
   */
  int handle_input (ACE_HANDLE)
  {
    /*
      In response to the connection request, we create a new Logging_Handler.
      This new object will be used to interact with the client until it
      disconnects.
     */
    Logging_Handler *svc_handler = new Logging_Handler;
        
    /*
      To complete the connection, we invoke the accept() method call on
      the acceptor object and provide it with the connection handler instance.
      This transfers "ownership" of the connection from the acceptor to the
      connection handler.
     */
    if (this->peer_acceptor_.accept (*svc_handler) == -1)
      ACE_ERROR_RETURN ((LM_ERROR, "%p", "accept failed"), -1);

    /*
      Again, most objects need to be open()ed before they are useful.  We'll
      give the handler our reactor pointer so that it can register for
      events as well.  If the open fails, we'll force a close().
     */
    if (svc_handler->open (reactor_) == -1)
      svc_handler->close ();
        
    return 0;
  }

protected:

  /*
    Our acceptor object instance
   */
  ACE_SOCK_Acceptor peer_acceptor_;     

  /*
    A place to remember our reactor pointer
   */
  ACE_Reactor * reactor_;
};

#endif /* _CLIENT_ACCEPTOR_H */


<HR WIDTH="100%"></PRE>
It is important to notice here that we have done very little application-specifc
code in developing this object. In fact, if we take out the progress information,
the only app-specific code is when we create the new <I>Logging_Handler</I>
object to give to the <I>accept</I> function. You may begin to wonder why
there isn't a C++ template that does all of this coding for you. Actually,
the ACE toolkit happens to have one handy:
<UL>typedef ACE_Acceptor &lt;<I>YourHandlerClass</I>, ACE_SOCK_ACCEPTOR>
<I>YourAcceptorClass</I>;</UL>
We would have used it like this:
<UL>typedef ACE_Acceptor &lt;Logging_Handler, ACE_SOCK_ACCEPTOR> Client_Acceptor;</UL>
This will create a piece of code similar to what I've shown above. The
primary difference is that the <I>handle_input </I>function created by
the template does NOT register the handler with the reactor. In the long-run,
that is good for us because we can then move that logic into the <I>open</I>
function of the <I>Logging_Handler</I> and use a completely-generic acceptor.

<P>Now that we know how to accept a connection request, let's move on to
the next page where we learn how to handle the actual connection. Even
though we just learned about this cool template thing, we will continue
to use the "hand-written" acceptor developed above. As I mentioned, the
only difference will be in the <I>open</I> function of the connection handler
anyway.

<P>
<HR WIDTH="100%">
<CENTER></CENTER>

<CENTER>[<A HREF="..">Tutorial
Index</A>] [<A HREF="page02.html">Previous
Page</A>] [<A HREF="page04.html">Continue
This Tutorial</A>]</CENTER>

</BODY>
</HTML>