upstream/wesnoth
1
0
Fork 0
mirror of https://github.com/wesnoth/wesnoth synced 2025-05-19 07:55:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

campaignd: Document send_message/send_error's WML output and side-effects

Browse Source
This commit is contained in:
Ignacio R. Morelle 2014-06-24 20:44:26 -04:00
parent efcf8f7b6a
commit 46815ee008
1 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/campaign_server/campaign_server.hpp
View File

@ -177,10 +177,22 @@ private:
// Generic responses.
//
/** Send a client an informational message. */
/**
* Send a client an informational message.
*
* The WML sent consists of a document containing a single @p [message]
* child with a @a message attribute holding the value of @a msg.
*/
void send_message(const std::string& msg, network::connection sock);
/** Send a client an error message. */
/**
* Send a client an error message.
*
* The WML sent consists of a document containing a single @p [error] child
* with a @a message attribute holding the value of @a msg. In addition to
* sending the error to the client, a line with the client IP and message
* is recorded to the server log.
*/
void send_error(const std::string& msg, network::connection sock);
};