diff options
| author | rubidium <rubidium@openttd.org> | 2011-05-01 13:29:40 +0000 |
|---|---|---|
| committer | rubidium <rubidium@openttd.org> | 2011-05-01 13:29:40 +0000 |
| commit | 99ec3a044aab32e0fe4aea03a5539cf0e4f129e9 (patch) | |
| tree | 8d9cdc4b81d2d7c4a9ca505656b837777e38092a /src/network/core/tcp.cpp | |
| parent | 536c581923e456ed6a0d1a47747b7c9e111d8755 (diff) | |
| download | openttd-99ec3a044aab32e0fe4aea03a5539cf0e4f129e9.tar.xz | |
(svn r22403) -Document: some more network/core code
Diffstat (limited to 'src/network/core/tcp.cpp')
| -rw-r--r-- | src/network/core/tcp.cpp | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/src/network/core/tcp.cpp b/src/network/core/tcp.cpp index 9a6704006..8cfa2d60e 100644 --- a/src/network/core/tcp.cpp +++ b/src/network/core/tcp.cpp @@ -18,6 +18,10 @@ #include "tcp.h" +/** + * Construct a socket handler for a TCP connection. + * @param s The just opened TCP connection. + */ NetworkTCPSocketHandler::NetworkTCPSocketHandler(SOCKET s) : NetworkSocketHandler(), packet_queue(NULL), packet_recv(NULL), @@ -138,8 +142,7 @@ SendPacketsState NetworkTCPSocketHandler::SendPackets(bool closing_down) /** * Receives a packet for the given client - * @param status the variable to store the status into - * @return the received packet (or NULL when it didn't receive one) + * @return The received packet (or NULL when it didn't receive one) */ Packet *NetworkTCPSocketHandler::ReceivePacket() { @@ -219,7 +222,7 @@ Packet *NetworkTCPSocketHandler::ReceivePacket() /** * Check whether this socket can send or receive something. * @return \c true when there is something to receive. - * @note Sets #writeable if more data can be sent. + * @note Sets #writable if more data can be sent. */ bool NetworkTCPSocketHandler::CanSendReceive() { |