generic-library/poco
1
0
Fork 0
mirror of https://github.com/pocoproject/poco.git synced 2025-10-29 04:17:55 +01:00
Code Issues Projects Releases Wiki Activity

clarify documentation of flags parameter

Browse Source
This commit is contained in:
Günter Obiltschnig
2020-02-08 16:29:01 +01:00
parent 58e4839f44
commit 137c6ad136
2 changed files with 70 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
Net/include/Poco/Net/DatagramSocket.h
View File

@@ -108,6 +108,9 @@ public:
/// ///
/// Returns the number of bytes sent, which may be /// Returns the number of bytes sent, which may be
/// less than the number of bytes specified. /// less than the number of bytes specified.
///
/// The flags parameter can be used to pass system-defined flags
/// for send() like MSG_DONTROUTE.
int sendBytes(const SocketBufVec& buffer, int flags = 0); int sendBytes(const SocketBufVec& buffer, int flags = 0);
/// Sends the contents of the given buffers through /// Sends the contents of the given buffers through
@@ -115,22 +118,34 @@ public:
/// ///
/// Returns the number of bytes sent, which may be /// Returns the number of bytes sent, which may be
/// less than the number of bytes specified. /// less than the number of bytes specified.
///
/// The flags parameter can be used to pass system-defined flags
/// for send() like MSG_DONTROUTE.
int receiveBytes(void* buffer, int length, int flags = 0); int receiveBytes(void* buffer, int length, int flags = 0);
/// Receives data from the socket and stores it /// Receives data from the socket and stores it
/// in buffer. Up to length bytes are received. /// in buffer. Up to length bytes are received.
/// ///
/// Returns the number of bytes received. /// Returns the number of bytes received.
///
/// The flags parameter can be used to pass system-defined flags
/// for recv() like MSG_PEEK.
int receiveBytes(SocketBufVec& buffer, int flags = 0); int receiveBytes(SocketBufVec& buffer, int flags = 0);
/// Receives data from the socket and stores it in buffers. /// Receives data from the socket and stores it in buffers.
/// ///
/// Returns the number of bytes received. /// Returns the number of bytes received.
///
/// The flags parameter can be used to pass system-defined flags
/// for recv() like MSG_PEEK.
int receiveBytes(Poco::Buffer<char>& buffer, int flags = 0, const Poco::Timespan& timeout = 100000); int receiveBytes(Poco::Buffer<char>& buffer, int flags = 0, const Poco::Timespan& timeout = 100000);
/// Receives data from the socket and stores it in buffers. /// Receives data from the socket and stores it in buffers.
/// ///
/// Returns the number of bytes received. /// Returns the number of bytes received.
///
/// The flags parameter can be used to pass system-defined flags
/// for recv() like MSG_PEEK.
int sendTo(const void* buffer, int length, const SocketAddress& address, int flags = 0); int sendTo(const void* buffer, int length, const SocketAddress& address, int flags = 0);
/// Sends the contents of the given buffer through /// Sends the contents of the given buffer through
@@ -138,6 +153,9 @@ public:
/// ///
/// Returns the number of bytes sent, which may be /// Returns the number of bytes sent, which may be
/// less than the number of bytes specified. /// less than the number of bytes specified.
///
/// The flags parameter can be used to pass system-defined flags
/// for sendto() like MSG_DONTROUTE.
int sendTo(const SocketBufVec& buffers, const SocketAddress& address, int flags = 0); int sendTo(const SocketBufVec& buffers, const SocketAddress& address, int flags = 0);
/// Sends the contents of the given buffers through /// Sends the contents of the given buffers through
@@ -145,6 +163,9 @@ public:
/// ///
/// Returns the number of bytes sent, which may be /// Returns the number of bytes sent, which may be
/// less than the number of bytes specified. /// less than the number of bytes specified.
///
/// The flags parameter can be used to pass system-defined flags
/// for sendto() like MSG_DONTROUTE.
int receiveFrom(void* buffer, int length, SocketAddress& address, int flags = 0); int receiveFrom(void* buffer, int length, SocketAddress& address, int flags = 0);
/// Receives data from the socket and stores it /// Receives data from the socket and stores it
@@ -152,6 +173,9 @@ public:
/// Stores the address of the sender in address. /// Stores the address of the sender in address.
/// ///
/// Returns the number of bytes received. /// Returns the number of bytes received.
///
/// The flags parameter can be used to pass system-defined flags
/// for recvfrom() like MSG_PEEK.
int receiveFrom(void* buffer, int length, struct sockaddr** ppSA, poco_socklen_t** ppSALen, int flags = 0); int receiveFrom(void* buffer, int length, struct sockaddr** ppSA, poco_socklen_t** ppSALen, int flags = 0);
/// Receives data from the socket and stores it /// Receives data from the socket and stores it
@@ -160,6 +184,9 @@ public:
/// ppSA, and the length of native address in ppSALen. /// ppSA, and the length of native address in ppSALen.
/// ///
/// Returns the number of bytes received. /// Returns the number of bytes received.
///
/// The flags parameter can be used to pass system-defined flags
/// for recvfrom() like MSG_PEEK.
int receiveFrom(SocketBufVec& buffers, SocketAddress& address, int flags = 0); int receiveFrom(SocketBufVec& buffers, SocketAddress& address, int flags = 0);
/// Receives data from the socket and stores it /// Receives data from the socket and stores it
@@ -168,6 +195,9 @@ public:
/// Stores the address of the sender in address. /// Stores the address of the sender in address.
/// ///
/// Returns the number of bytes received. /// Returns the number of bytes received.
///
/// The flags parameter can be used to pass system-defined flags
/// for recvfrom() like MSG_PEEK.
int receiveFrom(SocketBufVec& buffers, struct sockaddr** ppSA, poco_socklen_t** ppSALen, int flags = 0); int receiveFrom(SocketBufVec& buffers, struct sockaddr** ppSA, poco_socklen_t** ppSALen, int flags = 0);
/// Receives data from the socket and stores it /// Receives data from the socket and stores it
@@ -176,6 +206,9 @@ public:
/// ppSA, and the length of native address in ppSALen. /// ppSA, and the length of native address in ppSALen.
/// ///
/// Returns the number of bytes received. /// Returns the number of bytes received.
///
/// The flags parameter can be used to pass system-defined flags
/// for recvfrom() like MSG_PEEK.
void setBroadcast(bool flag); void setBroadcast(bool flag);
/// Sets the value of the SO_BROADCAST socket option. /// Sets the value of the SO_BROADCAST socket option.

18
Net/include/Poco/Net/StreamSocket.h
View File

@@ -106,6 +106,9 @@ public:
/// ///
/// Certain socket implementations may also return a negative /// Certain socket implementations may also return a negative
/// value denoting a certain condition. /// value denoting a certain condition.
///
/// The flags parameter can be used to pass system-defined flags
/// for send() like MSG_OOB.
int sendBytes(const SocketBufVec& buffer, int flags = 0); int sendBytes(const SocketBufVec& buffer, int flags = 0);
/// Sends the contents of the given buffers through /// Sends the contents of the given buffers through
@@ -113,6 +116,9 @@ public:
/// ///
/// Returns the number of bytes sent, which may be /// Returns the number of bytes sent, which may be
/// less than the number of bytes specified. /// less than the number of bytes specified.
///
/// The flags parameter can be used to pass system-defined flags
/// for send() like MSG_OOB.
int sendBytes(Poco::FIFOBuffer& buffer); int sendBytes(Poco::FIFOBuffer& buffer);
/// Sends the contents of the given buffer through /// Sends the contents of the given buffer through
@@ -126,6 +132,9 @@ public:
/// ///
/// Certain socket implementations may also return a negative /// Certain socket implementations may also return a negative
/// value denoting a certain condition. /// value denoting a certain condition.
///
/// The flags parameter can be used to pass system-defined flags
/// for send() like MSG_OOB.
int receiveBytes(void* buffer, int length, int flags = 0); int receiveBytes(void* buffer, int length, int flags = 0);
/// Receives data from the socket and stores it /// Receives data from the socket and stores it
@@ -138,16 +147,25 @@ public:
/// Throws a TimeoutException if a receive timeout has /// Throws a TimeoutException if a receive timeout has
/// been set and nothing is received within that interval. /// been set and nothing is received within that interval.
/// Throws a NetException (or a subclass) in case of other errors. /// Throws a NetException (or a subclass) in case of other errors.
///
/// The flags parameter can be used to pass system-defined flags
/// for recv() like MSG_OOB, MSG_PEEK or MSG_WAITALL.
int receiveBytes(SocketBufVec& buffer, int flags = 0); int receiveBytes(SocketBufVec& buffer, int flags = 0);
/// Receives data from the socket and stores it in buffers. /// Receives data from the socket and stores it in buffers.
/// ///
/// Returns the number of bytes received. /// Returns the number of bytes received.
///
/// The flags parameter can be used to pass system-defined flags
/// for recv() like MSG_OOB, MSG_PEEK or MSG_WAITALL.
int receiveBytes(Poco::Buffer<char>& buffer, int flags = 0, const Poco::Timespan& timeout = 100000); int receiveBytes(Poco::Buffer<char>& buffer, int flags = 0, const Poco::Timespan& timeout = 100000);
/// Receives data from the socket and stores it in buffers. /// Receives data from the socket and stores it in buffers.
/// ///
/// Returns the number of bytes received. /// Returns the number of bytes received.
///
/// The flags parameter can be used to pass system-defined flags
/// for recv() like MSG_OOB, MSG_PEEK or MSG_WAITALL.
int receiveBytes(Poco::FIFOBuffer& buffer); int receiveBytes(Poco::FIFOBuffer& buffer);
/// Receives data from the socket and stores it /// Receives data from the socket and stores it