hedgewars: comparison project_files/frontlib/net/netconn.h

equal deleted inserted replaced

-:4feced261c68
+:de822cd3df3a
 #define NETCONN_STATE_CONNECTING 0
 #define NETCONN_STATE_LOBBY 1
 #define NETCONN_STATE_ROOM 2
 #define NETCONN_STATE_DISCONNECTED 10
-#define NETCONN_DISCONNECT_NORMAL 0				//!< The connection was closed normally
+#define NETCONN_DISCONNECT_NORMAL 0             //!< The connection was closed normally
-#define NETCONN_DISCONNECT_SERVER_TOO_OLD 1		//!< The server has a lower protocol version than we do
+#define NETCONN_DISCONNECT_SERVER_TOO_OLD 1     //!< The server has a lower protocol version than we do
-#define NETCONN_DISCONNECT_AUTH_FAILED 2		//!< You sent a password with flib_netconn_send_password that was not accepted
+#define NETCONN_DISCONNECT_AUTH_FAILED 2        //!< You sent a password with flib_netconn_send_password that was not accepted
-#define NETCONN_DISCONNECT_CONNLOST 3			//!< The network connection was lost
+#define NETCONN_DISCONNECT_CONNLOST 3           //!< The network connection was lost
-#define NETCONN_DISCONNECT_INTERNAL_ERROR 100	//!< Something went wrong in frontlib itself
+#define NETCONN_DISCONNECT_INTERNAL_ERROR 100   //!< Something went wrong in frontlib itself
-#define NETCONN_ROOMLEAVE_ABANDONED 0			//!< The room was closed because the chief left
+#define NETCONN_ROOMLEAVE_ABANDONED 0           //!< The room was closed because the chief left
-#define NETCONN_ROOMLEAVE_KICKED 1				//!< You have been kicked from the room
+#define NETCONN_ROOMLEAVE_KICKED 1              //!< You have been kicked from the room
-#define NETCONN_MSG_TYPE_PLAYERINFO 0			//!< A response to flib_netconn_send_playerInfo
+#define NETCONN_MSG_TYPE_PLAYERINFO 0           //!< A response to flib_netconn_send_playerInfo
-#define NETCONN_MSG_TYPE_SERVERMESSAGE 1		//!< The welcome message when connecting to the lobby
+#define NETCONN_MSG_TYPE_SERVERMESSAGE 1        //!< The welcome message when connecting to the lobby
-#define NETCONN_MSG_TYPE_WARNING 2				//!< A general warning message
+#define NETCONN_MSG_TYPE_WARNING 2              //!< A general warning message
-#define NETCONN_MSG_TYPE_ERROR 3				//!< A general error message
+#define NETCONN_MSG_TYPE_ERROR 3                //!< A general error message
 #define NETCONN_MAPCHANGE_FULL 0
 #define NETCONN_MAPCHANGE_MAP 1
 #define NETCONN_MAPCHANGE_MAPGEN 2
 #define NETCONN_MAPCHANGE_DRAWNMAP 3
 // Send functions needed when connecting and disconnecting
-	/**
+/**
-	 * Request a different nickname.
+* Request a different nickname.
-	 * This function only makes sense in reaction to an onNickTaken callback, because the netconn
+* This function only makes sense in reaction to an onNickTaken callback, because the netconn
-	 * automatically requests the nickname you provide on creation, and once the server accepts the
+* automatically requests the nickname you provide on creation, and once the server accepts the
-	 * nickname it can no longer be changed.
+* nickname it can no longer be changed.
-	 */
+*/
-	int flib_netconn_send_nick(flib_netconn *conn, const char *nick);
+int flib_netconn_send_nick(flib_netconn *conn, const char *nick);
-	/**
+/**
-	 * Send the password in reply to a password request.
+* Send the password in reply to a password request.
-	 * If the server does not accept the password, you will be disconnected
+* If the server does not accept the password, you will be disconnected
-	 * (NETCONN_DISCONNECT_AUTH_FAILED)
+* (NETCONN_DISCONNECT_AUTH_FAILED)
-	 */
+*/
-	int flib_netconn_send_password(flib_netconn *conn, const char *passwd);
+int flib_netconn_send_password(flib_netconn *conn, const char *passwd);
-	/**
+/**
-	 * Tell the server that you want to leave. If successful, the server will disconnect you.
+* Tell the server that you want to leave. If successful, the server will disconnect you.
-	 */
+*/
-	int flib_netconn_send_quit(flib_netconn *conn, const char *quitmsg);
+int flib_netconn_send_quit(flib_netconn *conn, const char *quitmsg);
 // Send functions that make sense both in the lobby and in rooms
-	/**
+/**
-	 * Send a chat message. This message is either sent to the lobby or the room, depending on
+* Send a chat message. This message is either sent to the lobby or the room, depending on
-	 * whether you are in a room at the moment. The message is not echoed back to you.
+* whether you are in a room at the moment. The message is not echoed back to you.
-	 */
+*/
-	int flib_netconn_send_chat(flib_netconn *conn, const char *chat);
+int flib_netconn_send_chat(flib_netconn *conn, const char *chat);
-	/**
+/**
-	 * Kick a player. This has different meanings in the lobby and in a room;
+* Kick a player. This has different meanings in the lobby and in a room;
-	 * In the lobby, it will kick the player from the server, and you need to be a server admin to
+* In the lobby, it will kick the player from the server, and you need to be a server admin to
-	 * do it. In a room, it will kick the player from the room, and you need to be room chief.
+* do it. In a room, it will kick the player from the room, and you need to be room chief.
-	 */
+*/
-	int flib_netconn_send_kick(flib_netconn *conn, const char *playerName);
+int flib_netconn_send_kick(flib_netconn *conn, const char *playerName);
-	/**
+/**
-	 * Request information about a player (e.g. current room, version, partial IP). If the action
+* Request information about a player (e.g. current room, version, partial IP). If the action
-	 * succeeds, you will receive an onMessage callback with NETCONN_MSG_TYPE_PLAYERINFO containing
+* succeeds, you will receive an onMessage callback with NETCONN_MSG_TYPE_PLAYERINFO containing
-	 * the requested information.
+* the requested information.
-	 */
+*/
-	int flib_netconn_send_playerInfo(flib_netconn *conn, const char *playerName);
+int flib_netconn_send_playerInfo(flib_netconn *conn, const char *playerName);
 // Send functions that only make sense in the lobby
-	/**
+/**
-	 * Request an update of the room list. Only makes sense when in lobby state.
+* Request an update of the room list. Only makes sense when in lobby state.
-	 * If the action succeeds, you will receive an onRoomlist callback containing the current room
+* If the action succeeds, you will receive an onRoomlist callback containing the current room
-	 * data.
+* data.
-	 */
+*/
-	int flib_netconn_send_request_roomlist(flib_netconn *conn);
+int flib_netconn_send_request_roomlist(flib_netconn *conn);
-	/**
+/**
-	 * Join a room as guest (not chief). Only makes sense when in lobby state. If the action
+* Join a room as guest (not chief). Only makes sense when in lobby state. If the action
-	 * succeeds, you will receive an onEnterRoom callback with chief=false followed by other
+* succeeds, you will receive an onEnterRoom callback with chief=false followed by other
-	 * callbacks with current room information.
+* callbacks with current room information.
-	 */
+*/
-	int flib_netconn_send_joinRoom(flib_netconn *conn, const char *room);
+int flib_netconn_send_joinRoom(flib_netconn *conn, const char *room);
-	/**
+/**
-	 * Follow a player. Only valid in the lobby. If the player is in a room (or in a game), this
+* Follow a player. Only valid in the lobby. If the player is in a room (or in a game), this
-	 * command is analogous to calling flib_netconn_send_joinRoom with that room.
+* command is analogous to calling flib_netconn_send_joinRoom with that room.
-	 */
+*/
-	int flib_netconn_send_playerFollow(flib_netconn *conn, const char *playerName);
+int flib_netconn_send_playerFollow(flib_netconn *conn, const char *playerName);
-	/**
+/**
-	 * Create and join a new room. Only makes sense when in lobby state. If the action succeeds,
+* Create and join a new room. Only makes sense when in lobby state. If the action succeeds,
-	 * you will receive an onEnterRoom callback with chief=true.
+* you will receive an onEnterRoom callback with chief=true.
-	 */
+*/
-	int flib_netconn_send_createRoom(flib_netconn *conn, const char *room);
+int flib_netconn_send_createRoom(flib_netconn *conn, const char *room);
-	/**
+/**
-	 * Ban a player. The scope of this ban depends on whether you are in a room or in the lobby.
+* Ban a player. The scope of this ban depends on whether you are in a room or in the lobby.
-	 * In a room, you need to be the room chief, and the ban will apply to the room only. In the
+* In a room, you need to be the room chief, and the ban will apply to the room only. In the
-	 * lobby, you need to be server admin to ban someone, and the ban applies to the entire server.
+* lobby, you need to be server admin to ban someone, and the ban applies to the entire server.
-	 */
+*/
-	int flib_netconn_send_ban(flib_netconn *conn, const char *playerName);
+int flib_netconn_send_ban(flib_netconn *conn, const char *playerName);
-	/**
+/**
-	 * Does something administrator-y. At any rate you need to be an administrator and in the lobby
+* Does something administrator-y. At any rate you need to be an administrator and in the lobby
-	 * to use this command.
+* to use this command.
-	 */
+*/
-	int flib_netconn_send_clearAccountsCache(flib_netconn *conn);
+int flib_netconn_send_clearAccountsCache(flib_netconn *conn);
-	/**
+/**
-	 * Sets a server variable to the indicated value. Only makes sense if you are server admin and
+* Sets a server variable to the indicated value. Only makes sense if you are server admin and
-	 * in the lobby. Known variables are MOTD_NEW, MOTD_OLD and LATEST_PROTO. MOTD_OLD is shown to
+* in the lobby. Known variables are MOTD_NEW, MOTD_OLD and LATEST_PROTO. MOTD_OLD is shown to
-	 * players with older protocol versions, to inform them that they might want to update.
+* players with older protocol versions, to inform them that they might want to update.
-	 */
+*/
-	int flib_netconn_send_setServerVar(flib_netconn *conn, const char *name, const char *value);
+int flib_netconn_send_setServerVar(flib_netconn *conn, const char *name, const char *value);
-	/**
+/**
-	 * Queries all server variables. Only makes sense if you are server admin and in the lobby.
+* Queries all server variables. Only makes sense if you are server admin and in the lobby.
-	 * If the action succeeds, you will receive several onServerVar callbacks with the
+* If the action succeeds, you will receive several onServerVar callbacks with the
-	 * current values of all server variables.
+* current values of all server variables.
-	 */
+*/
-	int flib_netconn_send_getServerVars(flib_netconn *conn);
+int flib_netconn_send_getServerVars(flib_netconn *conn);
 // Send functions that only make sense in a room
-	/**
+/**
-	 * Leave the room for the lobby. Only makes sense in room state. msg can be NULL if you don't
+* Leave the room for the lobby. Only makes sense in room state. msg can be NULL if you don't
-	 * want to send a message. The server always accepts a part command, so once you send it off,
+* want to send a message. The server always accepts a part command, so once you send it off,
-	 * you can just assume that you are back in the lobby.
+* you can just assume that you are back in the lobby.
-	 */
+*/
-	int flib_netconn_send_leaveRoom(flib_netconn *conn, const char *msg);
+int flib_netconn_send_leaveRoom(flib_netconn *conn, const char *msg);
-	/**
+/**
-	 * Change your "ready" status in the room. Only makes sense when in room state. If the action
+* Change your "ready" status in the room. Only makes sense when in room state. If the action
-	 * succeeds, you will receive an onClientFlags callback containing the change.
+* succeeds, you will receive an onClientFlags callback containing the change.
-	 */
+*/
-	int flib_netconn_send_toggleReady(flib_netconn *conn);
+int flib_netconn_send_toggleReady(flib_netconn *conn);
-	/**
+/**
-	 * Add a team to the current room. Apart from the "fixed" team information, this also includes
+* Add a team to the current room. Apart from the "fixed" team information, this also includes
-	 * the color, but not the number of hogs. Only makes sense when in room state. If the action
+* the color, but not the number of hogs. Only makes sense when in room state. If the action
-	 * succeeds, you will receive an onTeamAccepted callback with the name of the team.
+* succeeds, you will receive an onTeamAccepted callback with the name of the team.
-	 *
+*
-	 * Notes: Technically, sending a color here is the only way for a non-chief to set the color of
+* Notes: Technically, sending a color here is the only way for a non-chief to set the color of
-	 * her own team. The server remembers this color and even generates a separate teamColor message
+* her own team. The server remembers this color and even generates a separate teamColor message
-	 * to inform everyone of it. However, at the moment the frontends generally override this color
+* to inform everyone of it. However, at the moment the frontends generally override this color
-	 * with one they choose themselves in order to deal with unfortunate behavior of the QtFrontend,
+* with one they choose themselves in order to deal with unfortunate behavior of the QtFrontend,
-	 * which always sends color index 0 when adding a team but thinks that the team has a random
+* which always sends color index 0 when adding a team but thinks that the team has a random
-	 * color. The chief always sends a new color in order to bring the QtFrontend back into sync.
+* color. The chief always sends a new color in order to bring the QtFrontend back into sync.
-	 */
+*/
-	int flib_netconn_send_addTeam(flib_netconn *conn, const flib_team *team);
+int flib_netconn_send_addTeam(flib_netconn *conn, const flib_team *team);
-	/**
+/**
-	 * Remove the team with the name teamname. Only makes sense when in room state.
+* Remove the team with the name teamname. Only makes sense when in room state.
-	 * The server does not send a reply on success.
+* The server does not send a reply on success.
-	 */
+*/
-	int flib_netconn_send_removeTeam(flib_netconn *conn, const char *teamname);
+int flib_netconn_send_removeTeam(flib_netconn *conn, const char *teamname);
 // Send functions that only make sense in a room and if you are room chief
-	/**
+/**
-	 * Rename the current room. Only makes sense in room state and if you are chief. If the action
+* Rename the current room. Only makes sense in room state and if you are chief. If the action
-	 * succeeds, you (and everyone else on the server) will receive an onRoomUpdate message
+* succeeds, you (and everyone else on the server) will receive an onRoomUpdate message
-	 * containing the change.
+* containing the change.
-	 */
+*/
-	int flib_netconn_send_renameRoom(flib_netconn *conn, const char *roomName);
+int flib_netconn_send_renameRoom(flib_netconn *conn, const char *roomName);
-	/**
+/**
-	 * Set the number of hogs for a team. Only makes sense in room state and if you are chief.
+* Set the number of hogs for a team. Only makes sense in room state and if you are chief.
-	 * The server does not send a reply.
+* The server does not send a reply.
-	 */
+*/
-	int flib_netconn_send_teamHogCount(flib_netconn *conn, const char *teamname, int hogcount);
+int flib_netconn_send_teamHogCount(flib_netconn *conn, const char *teamname, int hogcount);
-	/**
+/**
-	 * Set the teamcolor of a team. Only makes sense in room state and if you are chief.
+* Set the teamcolor of a team. Only makes sense in room state and if you are chief.
-	 * The server does not send a reply.
+* The server does not send a reply.
-	 */
+*/
-	int flib_netconn_send_teamColor(flib_netconn *conn, const char *teamname, int colorIndex);
+int flib_netconn_send_teamColor(flib_netconn *conn, const char *teamname, int colorIndex);
-	/**
+/**
-	 * Set the weaponset for the room. Only makes sense in room state and if you are chief.
+* Set the weaponset for the room. Only makes sense in room state and if you are chief.
-	 * The server does not send a reply.
+* The server does not send a reply.
-	 */
+*/
-	int flib_netconn_send_weaponset(flib_netconn *conn, const flib_weaponset *weaponset);
+int flib_netconn_send_weaponset(flib_netconn *conn, const flib_weaponset *weaponset);
-	/**
+/**
-	 * Set the map for the room. Only makes sense in room state and if you are chief.
+* Set the map for the room. Only makes sense in room state and if you are chief.
-	 * The server does not send a reply.
+* The server does not send a reply.
-	 */
+*/
-	int flib_netconn_send_map(flib_netconn *conn, const flib_map *map);
+int flib_netconn_send_map(flib_netconn *conn, const flib_map *map);
-	/**
+/**
-	 * Set the mapname. Only makes sense in room state and if you are chief.
+* Set the mapname. Only makes sense in room state and if you are chief.
-	 * The server does not send a reply.
+* The server does not send a reply.
-	 */
+*/
-	int flib_netconn_send_mapName(flib_netconn *conn, const char *mapName);
+int flib_netconn_send_mapName(flib_netconn *conn, const char *mapName);
-	/**
+/**
-	 * Set the map generator (regular, maze, drawn, named). Only makes sense in room state and if
+* Set the map generator (regular, maze, drawn, named). Only makes sense in room state and if
-	 * you are chief.
+* you are chief.
-	 * The server does not send a reply.
+* The server does not send a reply.
-	 */
+*/
-	int flib_netconn_send_mapGen(flib_netconn *conn, int mapGen);
+int flib_netconn_send_mapGen(flib_netconn *conn, int mapGen);
-	/**
+/**
-	 * Set the map template for regular maps. Only makes sense in room state and if you are chief.
+* Set the map template for regular maps. Only makes sense in room state and if you are chief.
-	 * The server does not send a reply.
+* The server does not send a reply.
-	 */
+*/
-	int flib_netconn_send_mapTemplate(flib_netconn *conn, int templateFilter);
+int flib_netconn_send_mapTemplate(flib_netconn *conn, int templateFilter);
-	/**
+/**
-	 * Set the maze template (maze size) for mazes. Only makes sense in room state and if you are
+* Set the maze template (maze size) for mazes. Only makes sense in room state and if you are
-	 * chief. The server does not send a reply.
+* chief. The server does not send a reply.
-	 */
+*/
-	int flib_netconn_send_mapMazeSize(flib_netconn *conn, int mazeSize);
+int flib_netconn_send_mapMazeSize(flib_netconn *conn, int mazeSize);
-	/**
+/**
-	 * Set the seed for the map. Only makes sense in room state and if you are chief.
+* Set the seed for the map. Only makes sense in room state and if you are chief.
-	 * The server does not send a reply.
+* The server does not send a reply.
-	 */
+*/
-	int flib_netconn_send_mapSeed(flib_netconn *conn, const char *seed);
+int flib_netconn_send_mapSeed(flib_netconn *conn, const char *seed);
-	/**
+/**
-	 * Set the theme for the map. Only makes sense in room state and if you are chief.
+* Set the theme for the map. Only makes sense in room state and if you are chief.
-	 * The server does not send a reply.
+* The server does not send a reply.
-	 */
+*/
-	int flib_netconn_send_mapTheme(flib_netconn *conn, const char *theme);
+int flib_netconn_send_mapTheme(flib_netconn *conn, const char *theme);
-	/**
+/**
-	 * Set the draw data for the drawn map. Only makes sense in room state and if you are chief.
+* Set the draw data for the drawn map. Only makes sense in room state and if you are chief.
-	 * The server does not send a reply.
+* The server does not send a reply.
-	 */
+*/
-	int flib_netconn_send_mapDrawdata(flib_netconn *conn, const uint8_t *drawData, size_t size);
+int flib_netconn_send_mapDrawdata(flib_netconn *conn, const uint8_t *drawData, size_t size);
-	/**
+/**
-	 * Set the script (game style). Only makes sense in room state and if you are chief.
+* Set the script (game style). Only makes sense in room state and if you are chief.
-	 * The server does not send a reply.
+* The server does not send a reply.
-	 */
+*/
-	int flib_netconn_send_script(flib_netconn *conn, const char *scriptName);
+int flib_netconn_send_script(flib_netconn *conn, const char *scriptName);
-	/**
+/**
-	 * Set the scheme. Only makes sense in room state and if you are chief.
+* Set the scheme. Only makes sense in room state and if you are chief.
-	 * The server does not send a reply.
+* The server does not send a reply.
-	 */
+*/
-	int flib_netconn_send_scheme(flib_netconn *conn, const flib_scheme *scheme);
+int flib_netconn_send_scheme(flib_netconn *conn, const flib_scheme *scheme);
-	/**
+/**
-	 * Signal that you want to start the game. Only makes sense in room state and if you are chief.
+* Signal that you want to start the game. Only makes sense in room state and if you are chief.
-	 * The server will check whether all players are ready and whether it believes the setup makes
+* The server will check whether all players are ready and whether it believes the setup makes
-	 * sense (e.g. more than one clan). If the server is satisfied, you will receive an onRunGame
+* sense (e.g. more than one clan). If the server is satisfied, you will receive an onRunGame
-	 * callback (all other clients in the room are notified the same way). Otherwise the server
+* callback (all other clients in the room are notified the same way). Otherwise the server
-	 * might answer with a warning, or might not answer at all.
+* might answer with a warning, or might not answer at all.
-	 */
+*/
-	int flib_netconn_send_startGame(flib_netconn *conn);
+int flib_netconn_send_startGame(flib_netconn *conn);
-	/**
+/**
-	 * Allow/forbid players to join the room. Only makes sense in room state and if you are chief.
+* Allow/forbid players to join the room. Only makes sense in room state and if you are chief.
-	 * The server does not send a reply.
+* The server does not send a reply.
-	 */
+*/
-	int flib_netconn_send_toggleRestrictJoins(flib_netconn *conn);
+int flib_netconn_send_toggleRestrictJoins(flib_netconn *conn);
-	/**
+/**
-	 * Allow/forbid adding teams to the room. Only makes sense in room state and if you are chief.
+* Allow/forbid adding teams to the room. Only makes sense in room state and if you are chief.
-	 * The server does not send a reply.
+* The server does not send a reply.
-	 */
+*/
-	int flib_netconn_send_toggleRestrictTeams(flib_netconn *conn);
+int flib_netconn_send_toggleRestrictTeams(flib_netconn *conn);
 // Send functions that are only needed for running a game
-	/**
+/**
-	 * Send a teamchat message, forwarded from the engine. Only makes sense ingame.
+* Send a teamchat message, forwarded from the engine. Only makes sense ingame.
-	 * The server does not send a reply. In contrast to a Chat message, the server
+* The server does not send a reply. In contrast to a Chat message, the server
-	 * automatically converts this into an engine message and passes it on to the other
+* automatically converts this into an engine message and passes it on to the other
-	 * clients.
+* clients.
-	 */
+*/
-	int flib_netconn_send_teamchat(flib_netconn *conn, const char *msg);
+int flib_netconn_send_teamchat(flib_netconn *conn, const char *msg);
-	/**
+/**
-	 * Send an engine message. Only makes sense when ingame. In a networked game, you have to pass
+* Send an engine message. Only makes sense when ingame. In a networked game, you have to pass
-	 * all the engine messages from the engine here, and they will be spread to all other clients
+* all the engine messages from the engine here, and they will be spread to all other clients
-	 * in the game to keep the game in sync.
+* in the game to keep the game in sync.
-	 */
+*/
-	int flib_netconn_send_engineMessage(flib_netconn *conn, const uint8_t *message, size_t size);
+int flib_netconn_send_engineMessage(flib_netconn *conn, const uint8_t *message, size_t size);
-	/**
+/**
-	 * Inform the server that the round has ended. Call this when the engine has disconnected,
+* Inform the server that the round has ended. Call this when the engine has disconnected,
-	 * passing 1 if the round ended normally, 0 otherwise.
+* passing 1 if the round ended normally, 0 otherwise.
-	 */
+*/
-	int flib_netconn_send_roundfinished(flib_netconn *conn, bool withoutError);
+int flib_netconn_send_roundfinished(flib_netconn *conn, bool withoutError);
 // Callbacks that are important for connecting/disconnecting
-	/**
+/**
-	 * onNickTaken is called when connecting to the server, if it turns out that there is already a
+* onNickTaken is called when connecting to the server, if it turns out that there is already a
-	 * player with the same nick.
+* player with the same nick.
-	 * In order to proceed, a new nickname needs to be sent to the server using
+* In order to proceed, a new nickname needs to be sent to the server using
-	 * flib_netconn_send_nick() (or of course you can bail out and send a QUIT).
+* flib_netconn_send_nick() (or of course you can bail out and send a QUIT).
-	 * If you don't set a callback, the netconn will automatically react by generating a new name.
+* If you don't set a callback, the netconn will automatically react by generating a new name.
-	 */
+*/
-	void flib_netconn_onNickTaken(flib_netconn *conn, void (*callback)(void *context, const char *nick), void* context);
+void flib_netconn_onNickTaken(flib_netconn *conn, void (*callback)(void *context, const char *nick), void* context);
-	/**
+/**
-	 * When connecting with a registered nickname, the server will ask for a password before
+* When connecting with a registered nickname, the server will ask for a password before
-	 * admitting you in. This callback is called when that happens. As a reaction, you can send the
+* admitting you in. This callback is called when that happens. As a reaction, you can send the
-	 * password using flib_netconn_send_password. If you don't register a callback, the default
+* password using flib_netconn_send_password. If you don't register a callback, the default
-	 * behavior is to just quit in a way that will cause a disconnect with
+* behavior is to just quit in a way that will cause a disconnect with
-	 * NETCONN_DISCONNECT_AUTH_FAILED.
+* NETCONN_DISCONNECT_AUTH_FAILED.
-	 *
+*
-	 * You can't just choose a new nickname when you receive this callback, because at that point
+* You can't just choose a new nickname when you receive this callback, because at that point
-	 * the server has already accepted your nick.
+* the server has already accepted your nick.
-	 */
+*/
-	void flib_netconn_onPasswordRequest(flib_netconn *conn, void (*callback)(void *context, const char *nick), void* context);
+void flib_netconn_onPasswordRequest(flib_netconn *conn, void (*callback)(void *context, const char *nick), void* context);
-	/**
+/**
-	 * This is called when the server has accepted our nickname (and possibly password) and we have
+* This is called when the server has accepted our nickname (and possibly password) and we have
-	 * entered the lobby.
+* entered the lobby.
-	 */
+*/
-	void flib_netconn_onConnected(flib_netconn *conn, void (*callback)(void *context), void* context);
+void flib_netconn_onConnected(flib_netconn *conn, void (*callback)(void *context), void* context);
-	/**
+/**
-	 * This is always the last callback (unless the netconn is destroyed early), and the netconn
+* This is always the last callback (unless the netconn is destroyed early), and the netconn
-	 * should be destroyed when it is received. The reason for the disconnect is passed as one of
+* should be destroyed when it is received. The reason for the disconnect is passed as one of
-	 * the NETCONN_DISCONNECT_ constants. Sometimes a message is included as well, but that
+* the NETCONN_DISCONNECT_ constants. Sometimes a message is included as well, but that
-	 * parameter might also be NULL.
+* parameter might also be NULL.
-	 */
+*/
-	void flib_netconn_onDisconnected(flib_netconn *conn, void (*callback)(void *context, int reason, const char *message), void* context);
+void flib_netconn_onDisconnected(flib_netconn *conn, void (*callback)(void *context, int reason, const char *message), void* context);
 // Callbacks that make sense in most situations
-	/**
+/**
-	 * Callback for several informational messages that should be displayed to the user
+* Callback for several informational messages that should be displayed to the user
-	 * (e.g. in the chat window), but do not require a reaction. If a game is running, you might
+* (e.g. in the chat window), but do not require a reaction. If a game is running, you might
-	 * want to redirect some of these messages to the engine as well so the user will see them.
+* want to redirect some of these messages to the engine as well so the user will see them.
-	 */
+*/
-	void flib_netconn_onMessage(flib_netconn *conn, void (*callback)(void *context, int msgtype, const char *msg), void* context);
+void flib_netconn_onMessage(flib_netconn *conn, void (*callback)(void *context, int msgtype, const char *msg), void* context);
-	/**
+/**
-	 * We received a chat message. Where this message belongs depends on the current state
+* We received a chat message. Where this message belongs depends on the current state
-	 * (lobby/room). If a game is running the message should be passed to the engine.
+* (lobby/room). If a game is running the message should be passed to the engine.
-	 */
+*/
-	void flib_netconn_onChat(flib_netconn *conn, void (*callback)(void *context, const char *nick, const char *msg), void* context);
+void flib_netconn_onChat(flib_netconn *conn, void (*callback)(void *context, const char *nick, const char *msg), void* context);
-	/**
+/**
-	 * Callbacks for incremental room list updates. They will fire whenever these events occur,
+* Callbacks for incremental room list updates. They will fire whenever these events occur,
-	 * even before you first query the actual roomlist - so be sure not to blindly reference your
+* even before you first query the actual roomlist - so be sure not to blindly reference your
-	 * room list in these callbacks. The server currently only sends updates when a room changes
+* room list in these callbacks. The server currently only sends updates when a room changes
-	 * its name, so in order to update other room information you need to query the roomlist again
+* its name, so in order to update other room information you need to query the roomlist again
-	 * (see send_request_roomlist / onRoomlist).
+* (see send_request_roomlist / onRoomlist).
-	 */
+*/
-	void flib_netconn_onRoomAdd(flib_netconn *conn, void (*callback)(void *context, const flib_room *room), void* context);
+void flib_netconn_onRoomAdd(flib_netconn *conn, void (*callback)(void *context, const flib_room *room), void* context);
-	void flib_netconn_onRoomDelete(flib_netconn *conn, void (*callback)(void *context, const char *name), void* context);
+void flib_netconn_onRoomDelete(flib_netconn *conn, void (*callback)(void *context, const char *name), void* context);
-	void flib_netconn_onRoomUpdate(flib_netconn *conn, void (*callback)(void *context, const char *oldName, const flib_room *room), void* context);
+void flib_netconn_onRoomUpdate(flib_netconn *conn, void (*callback)(void *context, const char *oldName, const flib_room *room), void* context);
-	/**
+/**
-	 * Callbacks for players joining or leaving the lobby. In contrast to the roomlist updates, you
+* Callbacks for players joining or leaving the lobby. In contrast to the roomlist updates, you
-	 * will get a JOIN callback for every player already on the server when you join (and there is
+* will get a JOIN callback for every player already on the server when you join (and there is
-	 * no direct way to query the current playerlist)
+* no direct way to query the current playerlist)
-	 *
+*
-	 * NOTE: partMessage may be NULL.
+* NOTE: partMessage may be NULL.
-	 */
+*/
-	void flib_netconn_onLobbyJoin(flib_netconn *conn, void (*callback)(void *context, const char *nick), void* context);
+void flib_netconn_onLobbyJoin(flib_netconn *conn, void (*callback)(void *context, const char *nick), void* context);
-	void flib_netconn_onLobbyLeave(flib_netconn *conn, void (*callback)(void *context, const char *nick, const char *partMessage), void* context);
+void flib_netconn_onLobbyLeave(flib_netconn *conn, void (*callback)(void *context, const char *nick, const char *partMessage), void* context);
-	/**
+/**
-	 * This is called when the server informs us that one or more flags associated with a
+* This is called when the server informs us that one or more flags associated with a
-	 * player/client have changed.
+* player/client have changed.
-	 *
+*
-	 * nick is the name of the player, flags is a string containing one character for each modified
+* nick is the name of the player, flags is a string containing one character for each modified
-	 * flag (see below), and newFlagState signals whether the flags should be set to true or false.
+* flag (see below), and newFlagState signals whether the flags should be set to true or false.
-	 *
+*
-	 * Some of these flags are important for protocol purposes (especially if they are set for you)
+* Some of these flags are important for protocol purposes (especially if they are set for you)
-	 * while others are just informational. Also, some flags are only relevant for players who are
+* while others are just informational. Also, some flags are only relevant for players who are
-	 * in the same room as you, and the server will not inform you if they change for others.
+* in the same room as you, and the server will not inform you if they change for others.
-	 *
+*
-	 * These are the currently known/used flags:
+* These are the currently known/used flags:
-	 * a: Server admin. Always updated.
+* a: Server admin. Always updated.
-	 * h: Room chief. Updated when in the same room.
+* h: Room chief. Updated when in the same room.
-	 * r: Ready to play. Updated when in the same room.
+* r: Ready to play. Updated when in the same room.
-	 * u: Registered user. Always updated.
+* u: Registered user. Always updated.
-	 *
+*
-	 * The server tells us the 'a' and 'u' flags for all players when we first join the lobby, and
+* The server tells us the 'a' and 'u' flags for all players when we first join the lobby, and
-	 * also tells us the 'r' and 'h' flags when we join or create a room. It assumes that all flags
+* also tells us the 'r' and 'h' flags when we join or create a room. It assumes that all flags
-	 * are initially false, so it will typically only tell you to set certain flags to true when
+* are initially false, so it will typically only tell you to set certain flags to true when
-	 * transmitting the initial states. Reset the 'h' and 'r' flags to false when leaving a room,
+* transmitting the initial states. Reset the 'h' and 'r' flags to false when leaving a room,
-	 * or when entering room state, to arrive at the right state for each player.
+* or when entering room state, to arrive at the right state for each player.
-	 *
+*
-	 * The room chief state of yourself is particularly important because it determines whether you
+* The room chief state of yourself is particularly important because it determines whether you
-	 * can modify settings of the current room. Generally, when you create a room you start out
+* can modify settings of the current room. Generally, when you create a room you start out
-	 * being room chief, and when you join an existing room you are not. However, if the original
+* being room chief, and when you join an existing room you are not. However, if the original
-	 * chief leaves a room, the server can choose a new chief, and if that happens the chief flag
+* chief leaves a room, the server can choose a new chief, and if that happens the chief flag
-	 * will be transferred to someone else.
+* will be transferred to someone else.
-	 */
+*/
-	void flib_netconn_onClientFlags(flib_netconn *conn, void (*callback)(void *context, const char *nick, const char *flags, bool newFlagState), void *context);
+void flib_netconn_onClientFlags(flib_netconn *conn, void (*callback)(void *context, const char *nick, const char *flags, bool newFlagState), void *context);
 // Callbacks that happen only in response to specific requests
-	/**
+/**
-	 * Response to flib_netconn_send_request_roomlist().
+* Response to flib_netconn_send_request_roomlist().
-	 * The rooms array contains the current state of all rooms on the server.
+* The rooms array contains the current state of all rooms on the server.
-	 */
+*/
-	void flib_netconn_onRoomlist(flib_netconn *conn, void (*callback)(void *context, const flib_room **rooms, int roomCount), void* context);
+void flib_netconn_onRoomlist(flib_netconn *conn, void (*callback)(void *context, const flib_room **rooms, int roomCount), void* context);
-	/**
+/**
-	 * Response to flib_netconn_send_joinRoom, flib_netconn_send_playerFollow or
+* Response to flib_netconn_send_joinRoom, flib_netconn_send_playerFollow or
-	 * flib_netconn_send_createRoom.
+* flib_netconn_send_createRoom.
-	 *
+*
-	 * You just left the lobby and entered a room.
+* You just left the lobby and entered a room.
-	 * If chief is true, you can and should send a full configuration for the room now. This
+* If chief is true, you can and should send a full configuration for the room now. This
-	 * consists of ammo, scheme, script and map, where map apparently has to come last.
+* consists of ammo, scheme, script and map, where map apparently has to come last.
-	 */
+*/
-	void flib_netconn_onEnterRoom(flib_netconn *conn, void (*callback)(void *context, bool chief), void *context);
+void flib_netconn_onEnterRoom(flib_netconn *conn, void (*callback)(void *context, bool chief), void *context);
-	/**
+/**
-	 * Response to flib_netconn_send_addTeam.
+* Response to flib_netconn_send_addTeam.
-	 * The server might reject your team for several reasons, e.g. because it has the same name as
+* The server might reject your team for several reasons, e.g. because it has the same name as
-	 * an existing team, or because the room chief restricted adding new teams. If the team is
+* an existing team, or because the room chief restricted adding new teams. If the team is
-	 * accepted by the server, this callback is fired.
+* accepted by the server, this callback is fired.
-	 *
+*
-	 * If you are the room chief, you are expected to provide the hog count for your own team now
+* If you are the room chief, you are expected to provide the hog count for your own team now
-	 * using flib_netconn_send_teamHogCount. The color of the team is already set to the one you
+* using flib_netconn_send_teamHogCount. The color of the team is already set to the one you
-	 * provided in addTeam.
+* provided in addTeam.
-	 */
+*/
-	void flib_netconn_onTeamAccepted(flib_netconn *conn, void (*callback)(void *context, const char *team), void *context);
+void flib_netconn_onTeamAccepted(flib_netconn *conn, void (*callback)(void *context, const char *team), void *context);
-	/**
+/**
-	 * When you query the server vars with flib_netconn_send_getServerVars (only works as admin),
+* When you query the server vars with flib_netconn_send_getServerVars (only works as admin),
-	 * the server replies with a list of them. This callback is called for each entry in that list.
+* the server replies with a list of them. This callback is called for each entry in that list.
-	 */
+*/
-	void flib_netconn_onServerVar(flib_netconn *conn, void (*callback)(void *context, const char *name, const char *value), void *context);
+void flib_netconn_onServerVar(flib_netconn *conn, void (*callback)(void *context, const char *name, const char *value), void *context);
 // Callbacks that are only relevant in a room
-	/**
+/**
-	 * You just left a room and entered the lobby again.
+* You just left a room and entered the lobby again.
-	 * reason is one of the NETCONN_ROOMLEAVE_ constants (usually a kick).
+* reason is one of the NETCONN_ROOMLEAVE_ constants (usually a kick).
-	 * This will not be called when you actively leave a room using PART.
+* This will not be called when you actively leave a room using PART.
-	 * Don't confuse with onRoomLeave, which indicates that *someone else* left the room.
+* Don't confuse with onRoomLeave, which indicates that *someone else* left the room.
-	 */
+*/
-	void flib_netconn_onLeaveRoom(flib_netconn *conn, void (*callback)(void *context, int reason, const char *message), void *context);
+void flib_netconn_onLeaveRoom(flib_netconn *conn, void (*callback)(void *context, int reason, const char *message), void *context);
-	/**
+/**
-	 * Someone joined or left the room you are currently in.
+* Someone joined or left the room you are currently in.
-	 * Analogous to onLobbyJoin/leave, you will receive the join callback for all players that are
+* Analogous to onLobbyJoin/leave, you will receive the join callback for all players that are
-	 * already in the room when you join, including for yourself (this is actually how it is
+* already in the room when you join, including for yourself (this is actually how it is
-	 * determined that you joined a room).
+* determined that you joined a room).
-	 *
+*
-	 * However, you will *not* receive onRoomLeave messages for everyone when you leave the room.
+* However, you will *not* receive onRoomLeave messages for everyone when you leave the room.
-	 */
+*/
-	void flib_netconn_onRoomJoin(flib_netconn *conn, void (*callback)(void *context, const char *nick), void* context);
+void flib_netconn_onRoomJoin(flib_netconn *conn, void (*callback)(void *context, const char *nick), void* context);
-	void flib_netconn_onRoomLeave(flib_netconn *conn, void (*callback)(void *context, const char *nick, const char *partMessage), void* context);
+void flib_netconn_onRoomLeave(flib_netconn *conn, void (*callback)(void *context, const char *nick, const char *partMessage), void* context);
-	/**
+/**
-	 * A new team was added to the room. The person who adds a team does NOT receive this callback
+* A new team was added to the room. The person who adds a team does NOT receive this callback
-	 * (he gets onTeamAccepted instead).
+* (he gets onTeamAccepted instead).
-	 *
+*
-	 * The team does not contain bindings, stats, weaponset, color or the number of hogs (but it is
+* The team does not contain bindings, stats, weaponset, color or the number of hogs (but it is
-	 * assumed to be the default of 4).
+* assumed to be the default of 4).
-	 *
+*
-	 * If you receive this message and you are the room chief, you may want to send a color and hog
+* If you receive this message and you are the room chief, you may want to send a color and hog
-	 * count for this team using flib_netconn_send_teamHogCount / teamColor for QtFrontend
+* count for this team using flib_netconn_send_teamHogCount / teamColor for QtFrontend
-	 * compatibility.
+* compatibility.
-	 *
+*
-	 * The server currently sends another message with the color of the team to the same recipients
+* The server currently sends another message with the color of the team to the same recipients
-	 * as this teamAdd message, which will trigger an onTeamColorChanged callback. See the
+* as this teamAdd message, which will trigger an onTeamColorChanged callback. See the
-	 * description of flib_netconn_send_addTeam for more information.
+* description of flib_netconn_send_addTeam for more information.
-	 */
+*/
-	void flib_netconn_onTeamAdd(flib_netconn *conn, void (*callback)(void *context, const flib_team *team), void *context);
+void flib_netconn_onTeamAdd(flib_netconn *conn, void (*callback)(void *context, const flib_team *team), void *context);
-	/**
+/**
-	 * A team was removed from the room. The person who removed the team will not receive this
+* A team was removed from the room. The person who removed the team will not receive this
-	 * callback.
+* callback.
-	 */
+*/
-	void flib_netconn_onTeamDelete(flib_netconn *conn, void (*callback)(void *context, const char *teamname), void *context);
+void flib_netconn_onTeamDelete(flib_netconn *conn, void (*callback)(void *context, const char *teamname), void *context);
-	/**
+/**
-	 * The number of hogs in a team has been changed by the room chief. If you are the chief and
+* The number of hogs in a team has been changed by the room chief. If you are the chief and
-	 * change the number of hogs yourself, you will not receive this callback.
+* change the number of hogs yourself, you will not receive this callback.
-	 */
+*/
-	void flib_netconn_onHogCountChanged(flib_netconn *conn, void (*callback)(void *context, const char *teamName, int hogs), void *context);
+void flib_netconn_onHogCountChanged(flib_netconn *conn, void (*callback)(void *context, const char *teamName, int hogs), void *context);
-	/**
+/**
-	 * The color of a team has been set or changed. The client who set or changed the color will
+* The color of a team has been set or changed. The client who set or changed the color will
-	 * not receive this callback.
+* not receive this callback.
-	 *
+*
-	 * Normally, only the chief can change the color of a team. However, this message is also
+* Normally, only the chief can change the color of a team. However, this message is also
-	 * generated when a team is added, so you can receive it even as chief.
+* generated when a team is added, so you can receive it even as chief.
-	 */
+*/
-	void flib_netconn_onTeamColorChanged(flib_netconn *conn, void (*callback)(void *context, const char *teamName, int colorIndex), void *context);
+void flib_netconn_onTeamColorChanged(flib_netconn *conn, void (*callback)(void *context, const char *teamName, int colorIndex), void *context);
-	/**
+/**
-	 * The room chief has changed the game scheme (or you just joined a room).
+* The room chief has changed the game scheme (or you just joined a room).
-	 * You will not receive this callback if you changed the scheme yourself.
+* You will not receive this callback if you changed the scheme yourself.
-	 */
+*/
-	void flib_netconn_onSchemeChanged(flib_netconn *conn, void (*callback)(void *context, const flib_scheme *scheme), void *context);
+void flib_netconn_onSchemeChanged(flib_netconn *conn, void (*callback)(void *context, const flib_scheme *scheme), void *context);
-	/**
+/**
-	 * The room chief has changed the map (or you just joined a room). Only non-chiefs receive these
+* The room chief has changed the map (or you just joined a room). Only non-chiefs receive these
-	 * messages.
+* messages.
-	 *
+*
-	 * To reduce the number of callback functions, the netconn keeps track of the current map
+* To reduce the number of callback functions, the netconn keeps track of the current map
-	 * settings and always passes the entire current map config, but informs the callee about what
+* settings and always passes the entire current map config, but informs the callee about what
-	 * has changed (see the NETCONN_MAPCHANGE_ constants).
+* has changed (see the NETCONN_MAPCHANGE_ constants).
-	 *
+*
-	 * Caution: Due to the way the protocol works, the map might not be complete at this point if it
+* Caution: Due to the way the protocol works, the map might not be complete at this point if it
-	 * is a hand-drawn map, because the "full" map config does not include the drawn map data.
+* is a hand-drawn map, because the "full" map config does not include the drawn map data.
-	 */
+*/
-	void flib_netconn_onMapChanged(flib_netconn *conn, void (*callback)(void *context, const flib_map *map, int changetype), void *context);
+void flib_netconn_onMapChanged(flib_netconn *conn, void (*callback)(void *context, const flib_map *map, int changetype), void *context);
-	/**
+/**
-	 * The room chief has changed the game style (or you just joined a room). If you are the chief
+* The room chief has changed the game style (or you just joined a room). If you are the chief
-	 * and change the style yourself, you will not receive this callback.
+* and change the style yourself, you will not receive this callback.
-	 */
+*/
-	void flib_netconn_onScriptChanged(flib_netconn *conn, void (*callback)(void *context, const char *script), void *context);
+void flib_netconn_onScriptChanged(flib_netconn *conn, void (*callback)(void *context, const char *script), void *context);
-	/**
+/**
-	 * The room chief has changed the weaponset (or you just joined a room). If you are the chief
+* The room chief has changed the weaponset (or you just joined a room). If you are the chief
-	 * and change the weaponset yourself, you will not receive this callback.
+* and change the weaponset yourself, you will not receive this callback.
-	 */
+*/
-	void flib_netconn_onWeaponsetChanged(flib_netconn *conn, void (*callback)(void *context, const flib_weaponset *weaponset), void *context);
+void flib_netconn_onWeaponsetChanged(flib_netconn *conn, void (*callback)(void *context, const flib_weaponset *weaponset), void *context);
-	/**
+/**
-	 * The game is starting. Fire up the engine and join in!
+* The game is starting. Fire up the engine and join in!
-	 * You can let the netconn generate the right game setup using flib_netconn_create_gamesetup
+* You can let the netconn generate the right game setup using flib_netconn_create_gamesetup
-	 */
+*/
-	void flib_netconn_onRunGame(flib_netconn *conn, void (*callback)(void *context), void *context);
+void flib_netconn_onRunGame(flib_netconn *conn, void (*callback)(void *context), void *context);
-	/**
+/**
-	 * You are in a room, a game is in progress, and the server is sending you the new input for the
+* You are in a room, a game is in progress, and the server is sending you the new input for the
-	 * engine to keep up to date with the current happenings. Pass it on to the engine using
+* engine to keep up to date with the current happenings. Pass it on to the engine using
-	 * flib_gameconn_send_enginemsg.
+* flib_gameconn_send_enginemsg.
-	 */
+*/
-	void flib_netconn_onEngineMessage(flib_netconn *conn, void (*callback)(void *context, const uint8_t *message, size_t size), void *context);
+void flib_netconn_onEngineMessage(flib_netconn *conn, void (*callback)(void *context, const uint8_t *message, size_t size), void *context);
 #endif

changeset 10017	de822cd3df3a
parent 10015	4feced261c68