Opened 5 years ago

Closed 5 years ago

#9771 closed Bugs (fixed)

Incorrect documentation for basic_datagram_socket::async_send()

Reported by: mike.catanzaro@… Owned by: chris_kohlhoff
Milestone: To Be Determined Component: asio
Version: Boost 1.55.0 Severity: Problem
Keywords: Cc:

Description

The documentation for the first overload (without the socket_base::message_flags parameter) of basic_datagram_socket::async_send() appears to be incorrect. The documentation says:

"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."

It should probably match the second overload, which appears to be correct:

"This function is used to asynchronously send data on the datagram socket. The function call always returns immediately."

First (incorrect) overload: http://www.boost.org/doc/libs/1_55_0/doc/html/boost_asio/reference/basic_datagram_socket/async_send/overload1.html

Second (correct) overload: http://www.boost.org/doc/libs/1_55_0/doc/html/boost_asio/reference/basic_datagram_socket/async_send/overload2.html

Change History (1)

comment:1 Changed 5 years ago by chris_kohlhoff

Resolution: fixed
Status: newclosed
Note: See TracTickets for help on using tickets.