1
0
mirror of https://github.com/pocoproject/poco.git synced 2025-04-02 09:49:48 +02:00

Documentation fixes on DatagramSocket.h and Socket.h ()

* Update DatagramSocket.h

`connect cannot()` -> `connect() cannot`

* Update Socket.h

typo on `setReceiveTiemout`
This commit is contained in:
Nicolau Leal Werneck 2024-03-11 10:27:28 +01:00 committed by GitHub
parent 0c333cbe88
commit a5b3c84874
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 4 additions and 4 deletions
Net/include/Poco/Net

@ -129,7 +129,7 @@ public:
/// If reuseAddress is true, sets the SO_REUSEADDR /// If reuseAddress is true, sets the SO_REUSEADDR
/// socket option. /// socket option.
/// ///
/// Calls to connect cannot() come before calls to bind(). /// Calls to connect() cannot come before calls to bind().
void bind(const SocketAddress& address, bool reuseAddress, bool reusePort); void bind(const SocketAddress& address, bool reuseAddress, bool reusePort);
/// Bind a local address to the socket. /// Bind a local address to the socket.
@ -143,7 +143,7 @@ public:
/// If reusePort is true, sets the SO_REUSEPORT /// If reusePort is true, sets the SO_REUSEPORT
/// socket option. /// socket option.
/// ///
/// Calls to connect cannot() come before calls to bind(). /// Calls to connect() cannot come before calls to bind().
void bind6(const SocketAddress& address, bool reuseAddress, bool reusePort, bool ipV6Only = false); void bind6(const SocketAddress& address, bool reuseAddress, bool reusePort, bool ipV6Only = false);
/// Bind a local address to the socket. /// Bind a local address to the socket.
@ -160,7 +160,7 @@ public:
/// Sets the IPV6_V6ONLY socket option in accordance with /// Sets the IPV6_V6ONLY socket option in accordance with
/// the supplied ipV6Only value. /// the supplied ipV6Only value.
/// ///
/// Calls to connect cannot() come before calls to bind(). /// Calls to connect() cannot come before calls to bind().
int sendBytes(const void* buffer, int length, int flags = 0); int sendBytes(const void* buffer, int length, int flags = 0);
/// Sends the contents of the given buffer through /// Sends the contents of the given buffer through

@ -216,7 +216,7 @@ public:
/// as the system is free to adjust the value. /// as the system is free to adjust the value.
void setReceiveTimeout(const Poco::Timespan& timeout); void setReceiveTimeout(const Poco::Timespan& timeout);
/// Sets the send timeout for the socket. /// Sets the receive timeout for the socket.
/// ///
/// On systems that do not support SO_RCVTIMEO, a /// On systems that do not support SO_RCVTIMEO, a
/// workaround using poll() is provided. /// workaround using poll() is provided.