summaryrefslogtreecommitdiff
path: root/src/network
diff options
context:
space:
mode:
authorrubidium <rubidium@openttd.org>2011-05-02 16:14:23 +0000
committerrubidium <rubidium@openttd.org>2011-05-02 16:14:23 +0000
commit4d5dbf51707c42c24eeafdb65016b079c54adcf2 (patch)
tree0197dcc17f4a8411ecea2223f356019c902fe7b9 /src/network
parente9837ff1ec1326aec622366ae29ff1aa81581daf (diff)
downloadopenttd-4d5dbf51707c42c24eeafdb65016b079c54adcf2.tar.xz
(svn r22410) -Document: some more bits ;)
Diffstat (limited to 'src/network')
-rw-r--r--src/network/network_command.cpp1
-rw-r--r--src/network/network_gamelist.cpp3
-rw-r--r--src/network/network_type.h7
3 files changed, 8 insertions, 3 deletions
diff --git a/src/network/network_command.cpp b/src/network/network_command.cpp
index d68021205..27e8338fb 100644
--- a/src/network/network_command.cpp
+++ b/src/network/network_command.cpp
@@ -275,6 +275,7 @@ static void DistributeQueue(CommandQueue *queue, const NetworkClientSocket *owne
}
}
+/** Distribute the commands of ourself and the clients. */
void NetworkDistributeCommands()
{
/* First send the server's commands. */
diff --git a/src/network/network_gamelist.cpp b/src/network/network_gamelist.cpp
index 707c5c36b..4511397da 100644
--- a/src/network/network_gamelist.cpp
+++ b/src/network/network_gamelist.cpp
@@ -25,7 +25,9 @@
NetworkGameList *_network_game_list = NULL;
+/** Mutex for handling delayed insertion/querying of servers. */
static ThreadMutex *_network_game_list_mutex = ThreadMutex::New();
+/** The games to insert when the GUI thread has time for us. */
static NetworkGameList *_network_game_delayed_insertion_list = NULL;
/**
@@ -72,7 +74,6 @@ static void NetworkGameListHandleDelayedInsert()
* Add a new item to the linked gamelist. If the IP and Port match
* return the existing item instead of adding it again
* @param address the address of the to-be added item
- * @param port the port the server is running on
* @return a point to the newly added or already existing item
*/
NetworkGameList *NetworkGameListAddItem(NetworkAddress address)
diff --git a/src/network/network_type.h b/src/network/network_type.h
index f40a1cdd5..ff29492b7 100644
--- a/src/network/network_type.h
+++ b/src/network/network_type.h
@@ -72,11 +72,13 @@ struct NetworkCompanyState {
struct NetworkClientInfo;
+/** The type of password we're asking for. */
enum NetworkPasswordType {
- NETWORK_GAME_PASSWORD,
- NETWORK_COMPANY_PASSWORD,
+ NETWORK_GAME_PASSWORD, ///< The password of the game.
+ NETWORK_COMPANY_PASSWORD, ///< The password of the company.
};
+/** Destination of our chat messages. */
enum DestType {
DESTTYPE_BROADCAST, ///< Send message/notice to all clients (All)
DESTTYPE_TEAM, ///< Send message/notice to everyone playing the same company (Team)
@@ -98,6 +100,7 @@ enum NetworkAction {
NETWORK_ACTION_COMPANY_NEW,
};
+/** The error codes we send around in the protocols. */
enum NetworkErrorCode {
NETWORK_ERROR_GENERAL, // Try to use this one like never