diff options
| author | Max Kellermann <max@musicpd.org> | 2019-04-04 10:14:38 +0200 |
|---|---|---|
| committer | Max Kellermann <max@musicpd.org> | 2019-04-04 10:24:58 +0200 |
| commit | d2eb4df8fc61c4c66e29804f334e2d0e935c7ba9 (patch) | |
| tree | a356ca051df450f726fdf8009af95a175b4f29bd | |
| parent | df33a898d7c1ba3228135bc27a29249923635a36 (diff) | |
event/{Fully,}BufferedSocket: add more API documentation
| -rw-r--r-- | src/event/BufferedSocket.hxx | 5 | ||||
| -rw-r--r-- | src/event/FullyBufferedSocket.hxx | 5 |
2 files changed, 10 insertions, 0 deletions
diff --git a/src/event/BufferedSocket.hxx b/src/event/BufferedSocket.hxx index 112ae829e..09bc1a099 100644 --- a/src/event/BufferedSocket.hxx +++ b/src/event/BufferedSocket.hxx @@ -46,6 +46,11 @@ public: using SocketMonitor::Close; private: + /** + * @return the number of bytes read from the socket, 0 if the + * socket isn't ready for reading, -1 on error (the socket has + * been closed and probably destructed) + */ ssize_t DirectRead(void *data, size_t length) noexcept; /** diff --git a/src/event/FullyBufferedSocket.hxx b/src/event/FullyBufferedSocket.hxx index 2351ebf14..8cda1f968 100644 --- a/src/event/FullyBufferedSocket.hxx +++ b/src/event/FullyBufferedSocket.hxx @@ -45,6 +45,11 @@ public: } private: + /** + * @return the number of bytes written to the socket, 0 if the + * socket isn't ready for writing, -1 on error (the socket has + * been closed and probably destructed) + */ ssize_t DirectWrite(const void *data, size_t length) noexcept; protected: |