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