Imported Upstream version 1.57.0
[platform/upstream/boost.git] / doc / html / boost_asio / reference / basic_socket_acceptor.html
1 <html>
2 <head>
3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>basic_socket_acceptor</title>
5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7 <link rel="home" href="../../boost_asio.html" title="Boost.Asio">
8 <link rel="up" href="../reference.html" title="Reference">
9 <link rel="prev" href="basic_socket/_basic_socket.html" title="basic_socket::~basic_socket">
10 <link rel="next" href="basic_socket_acceptor/accept.html" title="basic_socket_acceptor::accept">
11 </head>
12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13 <table cellpadding="2" width="100%"><tr>
14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
15 <td align="center"><a href="../../../../index.html">Home</a></td>
16 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19 <td align="center"><a href="../../../../more/index.htm">More</a></td>
20 </tr></table>
21 <hr>
22 <div class="spirit-nav">
23 <a accesskey="p" href="basic_socket/_basic_socket.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="basic_socket_acceptor/accept.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
24 </div>
25 <div class="section">
26 <div class="titlepage"><div><div><h3 class="title">
27 <a name="boost_asio.reference.basic_socket_acceptor"></a><a class="link" href="basic_socket_acceptor.html" title="basic_socket_acceptor">basic_socket_acceptor</a>
28 </h3></div></div></div>
29 <p>
30         Provides the ability to accept new connections.
31       </p>
32 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
33     <span class="keyword">typename</span> <a class="link" href="Protocol.html" title="Protocol requirements">Protocol</a><span class="special">,</span>
34     <span class="keyword">typename</span> <a class="link" href="SocketAcceptorService.html" title="Socket acceptor service requirements">SocketAcceptorService</a> <span class="special">=</span> <span class="identifier">socket_acceptor_service</span><span class="special">&lt;</span><span class="identifier">Protocol</span><span class="special">&gt;&gt;</span>
35 <span class="keyword">class</span> <span class="identifier">basic_socket_acceptor</span> <span class="special">:</span>
36   <span class="keyword">public</span> <span class="identifier">basic_io_object</span><span class="special">&lt;</span> <span class="identifier">SocketAcceptorService</span> <span class="special">&gt;,</span>
37   <span class="keyword">public</span> <span class="identifier">socket_base</span>
38 </pre>
39 <h5>
40 <a name="boost_asio.reference.basic_socket_acceptor.h0"></a>
41         <span class="phrase"><a name="boost_asio.reference.basic_socket_acceptor.types"></a></span><a class="link" href="basic_socket_acceptor.html#boost_asio.reference.basic_socket_acceptor.types">Types</a>
42       </h5>
43 <div class="informaltable"><table class="table">
44 <colgroup>
45 <col>
46 <col>
47 </colgroup>
48 <thead><tr>
49 <th>
50                 <p>
51                   Name
52                 </p>
53               </th>
54 <th>
55                 <p>
56                   Description
57                 </p>
58               </th>
59 </tr></thead>
60 <tbody>
61 <tr>
62 <td>
63                 <p>
64                   <a class="link" href="basic_socket_acceptor/broadcast.html" title="basic_socket_acceptor::broadcast"><span class="bold"><strong>broadcast</strong></span></a>
65                 </p>
66               </td>
67 <td>
68                 <p>
69                   Socket option to permit sending of broadcast messages.
70                 </p>
71               </td>
72 </tr>
73 <tr>
74 <td>
75                 <p>
76                   <a class="link" href="basic_socket_acceptor/bytes_readable.html" title="basic_socket_acceptor::bytes_readable"><span class="bold"><strong>bytes_readable</strong></span></a>
77                 </p>
78               </td>
79 <td>
80                 <p>
81                   IO control command to get the amount of data that can be read without
82                   blocking.
83                 </p>
84               </td>
85 </tr>
86 <tr>
87 <td>
88                 <p>
89                   <a class="link" href="basic_socket_acceptor/debug.html" title="basic_socket_acceptor::debug"><span class="bold"><strong>debug</strong></span></a>
90                 </p>
91               </td>
92 <td>
93                 <p>
94                   Socket option to enable socket-level debugging.
95                 </p>
96               </td>
97 </tr>
98 <tr>
99 <td>
100                 <p>
101                   <a class="link" href="basic_socket_acceptor/do_not_route.html" title="basic_socket_acceptor::do_not_route"><span class="bold"><strong>do_not_route</strong></span></a>
102                 </p>
103               </td>
104 <td>
105                 <p>
106                   Socket option to prevent routing, use local interfaces only.
107                 </p>
108               </td>
109 </tr>
110 <tr>
111 <td>
112                 <p>
113                   <a class="link" href="basic_socket_acceptor/enable_connection_aborted.html" title="basic_socket_acceptor::enable_connection_aborted"><span class="bold"><strong>enable_connection_aborted</strong></span></a>
114                 </p>
115               </td>
116 <td>
117                 <p>
118                   Socket option to report aborted connections on accept.
119                 </p>
120               </td>
121 </tr>
122 <tr>
123 <td>
124                 <p>
125                   <a class="link" href="basic_socket_acceptor/endpoint_type.html" title="basic_socket_acceptor::endpoint_type"><span class="bold"><strong>endpoint_type</strong></span></a>
126                 </p>
127               </td>
128 <td>
129                 <p>
130                   The endpoint type.
131                 </p>
132               </td>
133 </tr>
134 <tr>
135 <td>
136                 <p>
137                   <a class="link" href="basic_socket_acceptor/implementation_type.html" title="basic_socket_acceptor::implementation_type"><span class="bold"><strong>implementation_type</strong></span></a>
138                 </p>
139               </td>
140 <td>
141                 <p>
142                   The underlying implementation type of I/O object.
143                 </p>
144               </td>
145 </tr>
146 <tr>
147 <td>
148                 <p>
149                   <a class="link" href="basic_socket_acceptor/keep_alive.html" title="basic_socket_acceptor::keep_alive"><span class="bold"><strong>keep_alive</strong></span></a>
150                 </p>
151               </td>
152 <td>
153                 <p>
154                   Socket option to send keep-alives.
155                 </p>
156               </td>
157 </tr>
158 <tr>
159 <td>
160                 <p>
161                   <a class="link" href="basic_socket_acceptor/linger.html" title="basic_socket_acceptor::linger"><span class="bold"><strong>linger</strong></span></a>
162                 </p>
163               </td>
164 <td>
165                 <p>
166                   Socket option to specify whether the socket lingers on close if
167                   unsent data is present.
168                 </p>
169               </td>
170 </tr>
171 <tr>
172 <td>
173                 <p>
174                   <a class="link" href="basic_socket_acceptor/message_flags.html" title="basic_socket_acceptor::message_flags"><span class="bold"><strong>message_flags</strong></span></a>
175                 </p>
176               </td>
177 <td>
178                 <p>
179                   Bitmask type for flags that can be passed to send and receive operations.
180                 </p>
181               </td>
182 </tr>
183 <tr>
184 <td>
185                 <p>
186                   <a class="link" href="basic_socket_acceptor/native_handle_type.html" title="basic_socket_acceptor::native_handle_type"><span class="bold"><strong>native_handle_type</strong></span></a>
187                 </p>
188               </td>
189 <td>
190                 <p>
191                   The native representation of an acceptor.
192                 </p>
193               </td>
194 </tr>
195 <tr>
196 <td>
197                 <p>
198                   <a class="link" href="basic_socket_acceptor/native_type.html" title="basic_socket_acceptor::native_type"><span class="bold"><strong>native_type</strong></span></a>
199                 </p>
200               </td>
201 <td>
202                 <p>
203                   (Deprecated: Use native_handle_type.) The native representation
204                   of an acceptor.
205                 </p>
206               </td>
207 </tr>
208 <tr>
209 <td>
210                 <p>
211                   <a class="link" href="basic_socket_acceptor/non_blocking_io.html" title="basic_socket_acceptor::non_blocking_io"><span class="bold"><strong>non_blocking_io</strong></span></a>
212                 </p>
213               </td>
214 <td>
215                 <p>
216                   (Deprecated: Use non_blocking().) IO control command to set the
217                   blocking mode of the socket.
218                 </p>
219               </td>
220 </tr>
221 <tr>
222 <td>
223                 <p>
224                   <a class="link" href="basic_socket_acceptor/protocol_type.html" title="basic_socket_acceptor::protocol_type"><span class="bold"><strong>protocol_type</strong></span></a>
225                 </p>
226               </td>
227 <td>
228                 <p>
229                   The protocol type.
230                 </p>
231               </td>
232 </tr>
233 <tr>
234 <td>
235                 <p>
236                   <a class="link" href="basic_socket_acceptor/receive_buffer_size.html" title="basic_socket_acceptor::receive_buffer_size"><span class="bold"><strong>receive_buffer_size</strong></span></a>
237                 </p>
238               </td>
239 <td>
240                 <p>
241                   Socket option for the receive buffer size of a socket.
242                 </p>
243               </td>
244 </tr>
245 <tr>
246 <td>
247                 <p>
248                   <a class="link" href="basic_socket_acceptor/receive_low_watermark.html" title="basic_socket_acceptor::receive_low_watermark"><span class="bold"><strong>receive_low_watermark</strong></span></a>
249                 </p>
250               </td>
251 <td>
252                 <p>
253                   Socket option for the receive low watermark.
254                 </p>
255               </td>
256 </tr>
257 <tr>
258 <td>
259                 <p>
260                   <a class="link" href="basic_socket_acceptor/reuse_address.html" title="basic_socket_acceptor::reuse_address"><span class="bold"><strong>reuse_address</strong></span></a>
261                 </p>
262               </td>
263 <td>
264                 <p>
265                   Socket option to allow the socket to be bound to an address that
266                   is already in use.
267                 </p>
268               </td>
269 </tr>
270 <tr>
271 <td>
272                 <p>
273                   <a class="link" href="basic_socket_acceptor/send_buffer_size.html" title="basic_socket_acceptor::send_buffer_size"><span class="bold"><strong>send_buffer_size</strong></span></a>
274                 </p>
275               </td>
276 <td>
277                 <p>
278                   Socket option for the send buffer size of a socket.
279                 </p>
280               </td>
281 </tr>
282 <tr>
283 <td>
284                 <p>
285                   <a class="link" href="basic_socket_acceptor/send_low_watermark.html" title="basic_socket_acceptor::send_low_watermark"><span class="bold"><strong>send_low_watermark</strong></span></a>
286                 </p>
287               </td>
288 <td>
289                 <p>
290                   Socket option for the send low watermark.
291                 </p>
292               </td>
293 </tr>
294 <tr>
295 <td>
296                 <p>
297                   <a class="link" href="basic_socket_acceptor/service_type.html" title="basic_socket_acceptor::service_type"><span class="bold"><strong>service_type</strong></span></a>
298                 </p>
299               </td>
300 <td>
301                 <p>
302                   The type of the service that will be used to provide I/O operations.
303                 </p>
304               </td>
305 </tr>
306 <tr>
307 <td>
308                 <p>
309                   <a class="link" href="basic_socket_acceptor/shutdown_type.html" title="basic_socket_acceptor::shutdown_type"><span class="bold"><strong>shutdown_type</strong></span></a>
310                 </p>
311               </td>
312 <td>
313                 <p>
314                   Different ways a socket may be shutdown.
315                 </p>
316               </td>
317 </tr>
318 </tbody>
319 </table></div>
320 <h5>
321 <a name="boost_asio.reference.basic_socket_acceptor.h1"></a>
322         <span class="phrase"><a name="boost_asio.reference.basic_socket_acceptor.member_functions"></a></span><a class="link" href="basic_socket_acceptor.html#boost_asio.reference.basic_socket_acceptor.member_functions">Member
323         Functions</a>
324       </h5>
325 <div class="informaltable"><table class="table">
326 <colgroup>
327 <col>
328 <col>
329 </colgroup>
330 <thead><tr>
331 <th>
332                 <p>
333                   Name
334                 </p>
335               </th>
336 <th>
337                 <p>
338                   Description
339                 </p>
340               </th>
341 </tr></thead>
342 <tbody>
343 <tr>
344 <td>
345                 <p>
346                   <a class="link" href="basic_socket_acceptor/accept.html" title="basic_socket_acceptor::accept"><span class="bold"><strong>accept</strong></span></a>
347                 </p>
348               </td>
349 <td>
350                 <p>
351                   Accept a new connection.
352                 </p>
353                 <p>
354                   Accept a new connection and obtain the endpoint of the peer.
355                 </p>
356               </td>
357 </tr>
358 <tr>
359 <td>
360                 <p>
361                   <a class="link" href="basic_socket_acceptor/assign.html" title="basic_socket_acceptor::assign"><span class="bold"><strong>assign</strong></span></a>
362                 </p>
363               </td>
364 <td>
365                 <p>
366                   Assigns an existing native acceptor to the acceptor.
367                 </p>
368               </td>
369 </tr>
370 <tr>
371 <td>
372                 <p>
373                   <a class="link" href="basic_socket_acceptor/async_accept.html" title="basic_socket_acceptor::async_accept"><span class="bold"><strong>async_accept</strong></span></a>
374                 </p>
375               </td>
376 <td>
377                 <p>
378                   Start an asynchronous accept.
379                 </p>
380               </td>
381 </tr>
382 <tr>
383 <td>
384                 <p>
385                   <a class="link" href="basic_socket_acceptor/basic_socket_acceptor.html" title="basic_socket_acceptor::basic_socket_acceptor"><span class="bold"><strong>basic_socket_acceptor</strong></span></a>
386                 </p>
387               </td>
388 <td>
389                 <p>
390                   Construct an acceptor without opening it.
391                 </p>
392                 <p>
393                   Construct an open acceptor.
394                 </p>
395                 <p>
396                   Construct an acceptor opened on the given endpoint.
397                 </p>
398                 <p>
399                   Construct a basic_socket_acceptor on an existing native acceptor.
400                 </p>
401                 <p>
402                   Move-construct a basic_socket_acceptor from another.
403                 </p>
404                 <p>
405                   Move-construct a basic_socket_acceptor from an acceptor of another
406                   protocol type.
407                 </p>
408               </td>
409 </tr>
410 <tr>
411 <td>
412                 <p>
413                   <a class="link" href="basic_socket_acceptor/bind.html" title="basic_socket_acceptor::bind"><span class="bold"><strong>bind</strong></span></a>
414                 </p>
415               </td>
416 <td>
417                 <p>
418                   Bind the acceptor to the given local endpoint.
419                 </p>
420               </td>
421 </tr>
422 <tr>
423 <td>
424                 <p>
425                   <a class="link" href="basic_socket_acceptor/cancel.html" title="basic_socket_acceptor::cancel"><span class="bold"><strong>cancel</strong></span></a>
426                 </p>
427               </td>
428 <td>
429                 <p>
430                   Cancel all asynchronous operations associated with the acceptor.
431                 </p>
432               </td>
433 </tr>
434 <tr>
435 <td>
436                 <p>
437                   <a class="link" href="basic_socket_acceptor/close.html" title="basic_socket_acceptor::close"><span class="bold"><strong>close</strong></span></a>
438                 </p>
439               </td>
440 <td>
441                 <p>
442                   Close the acceptor.
443                 </p>
444               </td>
445 </tr>
446 <tr>
447 <td>
448                 <p>
449                   <a class="link" href="basic_socket_acceptor/get_io_service.html" title="basic_socket_acceptor::get_io_service"><span class="bold"><strong>get_io_service</strong></span></a>
450                 </p>
451               </td>
452 <td>
453                 <p>
454                   Get the io_service associated with the object.
455                 </p>
456               </td>
457 </tr>
458 <tr>
459 <td>
460                 <p>
461                   <a class="link" href="basic_socket_acceptor/get_option.html" title="basic_socket_acceptor::get_option"><span class="bold"><strong>get_option</strong></span></a>
462                 </p>
463               </td>
464 <td>
465                 <p>
466                   Get an option from the acceptor.
467                 </p>
468               </td>
469 </tr>
470 <tr>
471 <td>
472                 <p>
473                   <a class="link" href="basic_socket_acceptor/io_control.html" title="basic_socket_acceptor::io_control"><span class="bold"><strong>io_control</strong></span></a>
474                 </p>
475               </td>
476 <td>
477                 <p>
478                   Perform an IO control command on the acceptor.
479                 </p>
480               </td>
481 </tr>
482 <tr>
483 <td>
484                 <p>
485                   <a class="link" href="basic_socket_acceptor/is_open.html" title="basic_socket_acceptor::is_open"><span class="bold"><strong>is_open</strong></span></a>
486                 </p>
487               </td>
488 <td>
489                 <p>
490                   Determine whether the acceptor is open.
491                 </p>
492               </td>
493 </tr>
494 <tr>
495 <td>
496                 <p>
497                   <a class="link" href="basic_socket_acceptor/listen.html" title="basic_socket_acceptor::listen"><span class="bold"><strong>listen</strong></span></a>
498                 </p>
499               </td>
500 <td>
501                 <p>
502                   Place the acceptor into the state where it will listen for new
503                   connections.
504                 </p>
505               </td>
506 </tr>
507 <tr>
508 <td>
509                 <p>
510                   <a class="link" href="basic_socket_acceptor/local_endpoint.html" title="basic_socket_acceptor::local_endpoint"><span class="bold"><strong>local_endpoint</strong></span></a>
511                 </p>
512               </td>
513 <td>
514                 <p>
515                   Get the local endpoint of the acceptor.
516                 </p>
517               </td>
518 </tr>
519 <tr>
520 <td>
521                 <p>
522                   <a class="link" href="basic_socket_acceptor/native.html" title="basic_socket_acceptor::native"><span class="bold"><strong>native</strong></span></a>
523                 </p>
524               </td>
525 <td>
526                 <p>
527                   (Deprecated: Use native_handle().) Get the native acceptor representation.
528                 </p>
529               </td>
530 </tr>
531 <tr>
532 <td>
533                 <p>
534                   <a class="link" href="basic_socket_acceptor/native_handle.html" title="basic_socket_acceptor::native_handle"><span class="bold"><strong>native_handle</strong></span></a>
535                 </p>
536               </td>
537 <td>
538                 <p>
539                   Get the native acceptor representation.
540                 </p>
541               </td>
542 </tr>
543 <tr>
544 <td>
545                 <p>
546                   <a class="link" href="basic_socket_acceptor/native_non_blocking.html" title="basic_socket_acceptor::native_non_blocking"><span class="bold"><strong>native_non_blocking</strong></span></a>
547                 </p>
548               </td>
549 <td>
550                 <p>
551                   Gets the non-blocking mode of the native acceptor implementation.
552                 </p>
553                 <p>
554                   Sets the non-blocking mode of the native acceptor implementation.
555                 </p>
556               </td>
557 </tr>
558 <tr>
559 <td>
560                 <p>
561                   <a class="link" href="basic_socket_acceptor/non_blocking.html" title="basic_socket_acceptor::non_blocking"><span class="bold"><strong>non_blocking</strong></span></a>
562                 </p>
563               </td>
564 <td>
565                 <p>
566                   Gets the non-blocking mode of the acceptor.
567                 </p>
568                 <p>
569                   Sets the non-blocking mode of the acceptor.
570                 </p>
571               </td>
572 </tr>
573 <tr>
574 <td>
575                 <p>
576                   <a class="link" href="basic_socket_acceptor/open.html" title="basic_socket_acceptor::open"><span class="bold"><strong>open</strong></span></a>
577                 </p>
578               </td>
579 <td>
580                 <p>
581                   Open the acceptor using the specified protocol.
582                 </p>
583               </td>
584 </tr>
585 <tr>
586 <td>
587                 <p>
588                   <a class="link" href="basic_socket_acceptor/operator_eq_.html" title="basic_socket_acceptor::operator="><span class="bold"><strong>operator=</strong></span></a>
589                 </p>
590               </td>
591 <td>
592                 <p>
593                   Move-assign a basic_socket_acceptor from another.
594                 </p>
595                 <p>
596                   Move-assign a basic_socket_acceptor from an acceptor of another
597                   protocol type.
598                 </p>
599               </td>
600 </tr>
601 <tr>
602 <td>
603                 <p>
604                   <a class="link" href="basic_socket_acceptor/set_option.html" title="basic_socket_acceptor::set_option"><span class="bold"><strong>set_option</strong></span></a>
605                 </p>
606               </td>
607 <td>
608                 <p>
609                   Set an option on the acceptor.
610                 </p>
611               </td>
612 </tr>
613 </tbody>
614 </table></div>
615 <h5>
616 <a name="boost_asio.reference.basic_socket_acceptor.h2"></a>
617         <span class="phrase"><a name="boost_asio.reference.basic_socket_acceptor.protected_member_functions"></a></span><a class="link" href="basic_socket_acceptor.html#boost_asio.reference.basic_socket_acceptor.protected_member_functions">Protected
618         Member Functions</a>
619       </h5>
620 <div class="informaltable"><table class="table">
621 <colgroup>
622 <col>
623 <col>
624 </colgroup>
625 <thead><tr>
626 <th>
627                 <p>
628                   Name
629                 </p>
630               </th>
631 <th>
632                 <p>
633                   Description
634                 </p>
635               </th>
636 </tr></thead>
637 <tbody>
638 <tr>
639 <td>
640                 <p>
641                   <a class="link" href="basic_socket_acceptor/get_implementation.html" title="basic_socket_acceptor::get_implementation"><span class="bold"><strong>get_implementation</strong></span></a>
642                 </p>
643               </td>
644 <td>
645                 <p>
646                   Get the underlying implementation of the I/O object.
647                 </p>
648               </td>
649 </tr>
650 <tr>
651 <td>
652                 <p>
653                   <a class="link" href="basic_socket_acceptor/get_service.html" title="basic_socket_acceptor::get_service"><span class="bold"><strong>get_service</strong></span></a>
654                 </p>
655               </td>
656 <td>
657                 <p>
658                   Get the service associated with the I/O object.
659                 </p>
660               </td>
661 </tr>
662 </tbody>
663 </table></div>
664 <h5>
665 <a name="boost_asio.reference.basic_socket_acceptor.h3"></a>
666         <span class="phrase"><a name="boost_asio.reference.basic_socket_acceptor.data_members"></a></span><a class="link" href="basic_socket_acceptor.html#boost_asio.reference.basic_socket_acceptor.data_members">Data Members</a>
667       </h5>
668 <div class="informaltable"><table class="table">
669 <colgroup>
670 <col>
671 <col>
672 </colgroup>
673 <thead><tr>
674 <th>
675                 <p>
676                   Name
677                 </p>
678               </th>
679 <th>
680                 <p>
681                   Description
682                 </p>
683               </th>
684 </tr></thead>
685 <tbody>
686 <tr>
687 <td>
688                 <p>
689                   <a class="link" href="basic_socket_acceptor/max_connections.html" title="basic_socket_acceptor::max_connections"><span class="bold"><strong>max_connections</strong></span></a>
690                 </p>
691               </td>
692 <td>
693                 <p>
694                   The maximum length of the queue of pending incoming connections.
695                 </p>
696               </td>
697 </tr>
698 <tr>
699 <td>
700                 <p>
701                   <a class="link" href="basic_socket_acceptor/message_do_not_route.html" title="basic_socket_acceptor::message_do_not_route"><span class="bold"><strong>message_do_not_route</strong></span></a>
702                 </p>
703               </td>
704 <td>
705                 <p>
706                   Specify that the data should not be subject to routing.
707                 </p>
708               </td>
709 </tr>
710 <tr>
711 <td>
712                 <p>
713                   <a class="link" href="basic_socket_acceptor/message_end_of_record.html" title="basic_socket_acceptor::message_end_of_record"><span class="bold"><strong>message_end_of_record</strong></span></a>
714                 </p>
715               </td>
716 <td>
717                 <p>
718                   Specifies that the data marks the end of a record.
719                 </p>
720               </td>
721 </tr>
722 <tr>
723 <td>
724                 <p>
725                   <a class="link" href="basic_socket_acceptor/message_out_of_band.html" title="basic_socket_acceptor::message_out_of_band"><span class="bold"><strong>message_out_of_band</strong></span></a>
726                 </p>
727               </td>
728 <td>
729                 <p>
730                   Process out-of-band data.
731                 </p>
732               </td>
733 </tr>
734 <tr>
735 <td>
736                 <p>
737                   <a class="link" href="basic_socket_acceptor/message_peek.html" title="basic_socket_acceptor::message_peek"><span class="bold"><strong>message_peek</strong></span></a>
738                 </p>
739               </td>
740 <td>
741                 <p>
742                   Peek at incoming data without removing it from the input queue.
743                 </p>
744               </td>
745 </tr>
746 </tbody>
747 </table></div>
748 <h5>
749 <a name="boost_asio.reference.basic_socket_acceptor.h4"></a>
750         <span class="phrase"><a name="boost_asio.reference.basic_socket_acceptor.protected_data_members"></a></span><a class="link" href="basic_socket_acceptor.html#boost_asio.reference.basic_socket_acceptor.protected_data_members">Protected
751         Data Members</a>
752       </h5>
753 <div class="informaltable"><table class="table">
754 <colgroup>
755 <col>
756 <col>
757 </colgroup>
758 <thead><tr>
759 <th>
760                 <p>
761                   Name
762                 </p>
763               </th>
764 <th>
765                 <p>
766                   Description
767                 </p>
768               </th>
769 </tr></thead>
770 <tbody>
771 <tr>
772 <td>
773                 <p>
774                   <a class="link" href="basic_socket_acceptor/implementation.html" title="basic_socket_acceptor::implementation"><span class="bold"><strong>implementation</strong></span></a>
775                 </p>
776               </td>
777 <td>
778                 <p>
779                   (Deprecated: Use get_implementation().) The underlying implementation
780                   of the I/O object.
781                 </p>
782               </td>
783 </tr>
784 <tr>
785 <td>
786                 <p>
787                   <a class="link" href="basic_socket_acceptor/service.html" title="basic_socket_acceptor::service"><span class="bold"><strong>service</strong></span></a>
788                 </p>
789               </td>
790 <td>
791                 <p>
792                   (Deprecated: Use get_service().) The service associated with the
793                   I/O object.
794                 </p>
795               </td>
796 </tr>
797 </tbody>
798 </table></div>
799 <p>
800         The <a class="link" href="basic_socket_acceptor.html" title="basic_socket_acceptor"><code class="computeroutput"><span class="identifier">basic_socket_acceptor</span></code></a> class template
801         is used for accepting new socket connections.
802       </p>
803 <h5>
804 <a name="boost_asio.reference.basic_socket_acceptor.h5"></a>
805         <span class="phrase"><a name="boost_asio.reference.basic_socket_acceptor.thread_safety"></a></span><a class="link" href="basic_socket_acceptor.html#boost_asio.reference.basic_socket_acceptor.thread_safety">Thread
806         Safety</a>
807       </h5>
808 <p>
809         <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
810       </p>
811 <p>
812         <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
813       </p>
814 <h5>
815 <a name="boost_asio.reference.basic_socket_acceptor.h6"></a>
816         <span class="phrase"><a name="boost_asio.reference.basic_socket_acceptor.example"></a></span><a class="link" href="basic_socket_acceptor.html#boost_asio.reference.basic_socket_acceptor.example">Example</a>
817       </h5>
818 <p>
819         Opening a socket acceptor with the SO_REUSEADDR option enabled:
820       </p>
821 <pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">acceptor</span> <span class="identifier">acceptor</span><span class="special">(</span><span class="identifier">io_service</span><span class="special">);</span>
822 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">endpoint</span> <span class="identifier">endpoint</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">v4</span><span class="special">(),</span> <span class="identifier">port</span><span class="special">);</span>
823 <span class="identifier">acceptor</span><span class="special">.</span><span class="identifier">open</span><span class="special">(</span><span class="identifier">endpoint</span><span class="special">.</span><span class="identifier">protocol</span><span class="special">());</span>
824 <span class="identifier">acceptor</span><span class="special">.</span><span class="identifier">set_option</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">acceptor</span><span class="special">::</span><span class="identifier">reuse_address</span><span class="special">(</span><span class="keyword">true</span><span class="special">));</span>
825 <span class="identifier">acceptor</span><span class="special">.</span><span class="identifier">bind</span><span class="special">(</span><span class="identifier">endpoint</span><span class="special">);</span>
826 <span class="identifier">acceptor</span><span class="special">.</span><span class="identifier">listen</span><span class="special">();</span>
827 </pre>
828 <h5>
829 <a name="boost_asio.reference.basic_socket_acceptor.h7"></a>
830         <span class="phrase"><a name="boost_asio.reference.basic_socket_acceptor.requirements"></a></span><a class="link" href="basic_socket_acceptor.html#boost_asio.reference.basic_socket_acceptor.requirements">Requirements</a>
831       </h5>
832 <p>
833         <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/basic_socket_acceptor.hpp</code>
834       </p>
835 <p>
836         <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
837       </p>
838 </div>
839 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
840 <td align="left"></td>
841 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
842         Distributed under the Boost Software License, Version 1.0. (See accompanying
843         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
844       </p>
845 </div></td>
846 </tr></table>
847 <hr>
848 <div class="spirit-nav">
849 <a accesskey="p" href="basic_socket/_basic_socket.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="basic_socket_acceptor/accept.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
850 </div>
851 </body>
852 </html>