diff options
Diffstat (limited to 'net/socket/socket.h')
| -rw-r--r-- | net/socket/socket.h | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/net/socket/socket.h b/net/socket/socket.h index 17d9f12..450f42d 100644 --- a/net/socket/socket.h +++ b/net/socket/socket.h @@ -18,8 +18,8 @@ class NET_API Socket { public: virtual ~Socket() {} - // Reads data, up to buf_len bytes, from the socket. The number of bytes read - // is returned, or an error is returned upon failure. + // Reads data, up to |buf_len| bytes, from the socket. The number of bytes + // read is returned, or an error is returned upon failure. // ERR_SOCKET_NOT_CONNECTED should be returned if the socket is not currently // connected. Zero is returned once to indicate end-of-file; the return value // of subsequent calls is undefined, and may be OS dependent. ERR_IO_PENDING @@ -32,8 +32,8 @@ class NET_API Socket { virtual int Read(IOBuffer* buf, int buf_len, CompletionCallback* callback) = 0; - // Writes data, up to buf_len bytes, to the socket. Note: only part of the - // data may be written! The number of bytes written is returned, or an error + // Writes data, up to |buf_len| bytes, to the socket. Note: data may be + // written partially. The number of bytes written is returned, or an error // is returned upon failure. ERR_SOCKET_NOT_CONNECTED should be returned if // the socket is not currently connected. The return value when the // connection is closed is undefined, and may be OS dependent. ERR_IO_PENDING @@ -48,12 +48,12 @@ class NET_API Socket { CompletionCallback* callback) = 0; // Set the receive buffer size (in bytes) for the socket. - // Note: changing this value can effect the TCP window size on some platforms. + // Note: changing this value can affect the TCP window size on some platforms. // Returns true on success, or false on failure. virtual bool SetReceiveBufferSize(int32 size) = 0; // Set the send buffer size (in bytes) for the socket. - // Note: changing this value can effect the TCP window size on some platforms. + // Note: changing this value can affect the TCP window size on some platforms. // Returns true on success, or false on failure. virtual bool SetSendBufferSize(int32 size) = 0; }; |