event/{Fully,}BufferedSocket: add more API documentation

This commit is contained in:
Max Kellermann 2019-04-04 10:14:38 +02:00
parent df33a898d7
commit d2eb4df8fc
2 changed files with 10 additions and 0 deletions

View File

@ -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;
/**

View File

@ -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: