Skip to content

Commit 838a259

Browse files
committed
Fix documentation error where an asynchronous function was described as
having synchronous behaviour.
1 parent ff5d07f commit 838a259

File tree

2 files changed

+4
-5
lines changed

2 files changed

+4
-5
lines changed

asio/include/asio/basic_datagram_socket.hpp

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -349,9 +349,8 @@ class basic_datagram_socket
349349

350350
/// Start an asynchronous send on a connected socket.
351351
/**
352-
* This function is used to send data on the datagram socket. The function
353-
* call will block until the data has been sent successfully or an error
354-
* occurs.
352+
* This function is used to asynchronously send data on the datagram socket.
353+
* The function call always returns immediately.
355354
*
356355
* @param buffers One or more data buffers to be sent on the socket. Although
357356
* the buffers object may be copied as necessary, ownership of the underlying

asio/src/doc/reference.qbk

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3842,7 +3842,7 @@ Start an asynchronous send on a connected socket.
38423842
WriteHandler handler);
38433843

38443844

3845-
This function is used to send data on the datagram socket. The function call will block until the data has been sent successfully or an error occurs.
3845+
This function is used to asynchronously send data on the datagram socket. The function call always returns immediately.
38463846

38473847

38483848
[heading Parameters]
@@ -106159,4 +106159,4 @@ The initiating function (async\_read\_some in the above example) suspends the cu
106159106159
[endsect]
106160106160

106161106161

106162-
[endsect]
106162+
[endsect]

0 commit comments

Comments
 (0)