Skip to content

Commit

Permalink
campaignd: Document send_message/send_error's WML output and side-eff…
Browse files Browse the repository at this point in the history
…ects
  • Loading branch information
irydacea committed Jun 25, 2014
1 parent efcf8f7 commit 46815ee
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions src/campaign_server/campaign_server.hpp
Expand Up @@ -177,10 +177,22 @@ class server : private boost::noncopyable
// 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);
};

Expand Down

0 comments on commit 46815ee

Please sign in to comment.