92 lines
5.7 KiB
HTML
92 lines
5.7 KiB
HTML
<HTML>
|
|
|
|
<HEAD>
|
|
<TITLE>Ubi.com GameService SDK</TITLE>
|
|
<LINK href="./gs-sdk-doc.css" rel="stylesheet" type="text/css">
|
|
</HEAD>
|
|
|
|
<BODY >
|
|
<!-- Generated by Doxygen 1.3.4 -->
|
|
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div>
|
|
<h1>Game server callback</h1>Game server callback.
|
|
<a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0>
|
|
<tr><td></td></tr>
|
|
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group5.html#a0">CBCDKey_RcvValidationResponse</a> )(<a class="el" href="struct__REPLY__INFORMATION.html">PREPLY_INFORMATION</a> psReplyInfo, <a class="el" href="struct__VALIDATION__SERVER__INFO.html">PVALIDATION_SERVER_INFO</a> psValidationServerInfo, GSubyte *pucAuhorizationID, CDKEY_PLAYER_STATUS eStatus, GSubyte *pucGlobalID)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Received a validation status for a player from the validation server. </em> <a href="#a0"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(* </td><td class="memItemRight" valign=bottom><a class="el" href="group__group5.html#a1">CBCDKey_RcvPlayerStatusRequest</a> )(<a class="el" href="struct__VALIDATION__SERVER__INFO.html">PVALIDATION_SERVER_INFO</a> psValidationServerInfo, GSubyte *pucAuhorizationID)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a player status request from the validation server. </em> <a href="#a1"></a><em><br><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
These callback function are used by the game server to process response to queries sent to or by the validation server <hr><h2>Typedef Documentation</h2>
|
|
<a class="anchor" name="a1" doxytag="GSCDKeyCallbacks.h::CBCDKey_RcvPlayerStatusRequest" ></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> typedef GSvoid( * <a class="el" href="GSCDKeyCallbacks_8h.html#a1">CBCDKey_RcvPlayerStatusRequest</a>)(<a class="el" href="struct__VALIDATION__SERVER__INFO.html">PVALIDATION_SERVER_INFO</a> psValidationServerInfo, GSubyte *pucAuhorizationID)
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
<dl compact><dt><b>Description:</b></dt><dd>This callback will be called whenever the game server receives a player status request from the validation server. The game server should then respond to this query with the function GSCDKey_PlayerStatusReply to inform the validation server of the player status. The status should be E_PLAYER_UNKNOWN if the player is not on the game server at the moment of the request.</dd></dl>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>psValidationServerInfo</em> </td><td>Validation server information from where the response came </td></tr>
|
|
<tr><td valign=top><em>pucAuhorizationID</em> </td><td>The authorization id of the concerned player </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a0" doxytag="GSCDKeyCallbacks.h::CBCDKey_RcvValidationResponse" ></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> typedef GSvoid( * <a class="el" href="GSCDKeyCallbacks_8h.html#a0">CBCDKey_RcvValidationResponse</a>)(<a class="el" href="struct__REPLY__INFORMATION.html">PREPLY_INFORMATION</a> psReplyInfo, <a class="el" href="struct__VALIDATION__SERVER__INFO.html">PVALIDATION_SERVER_INFO</a> psValidationServerInfo,GSubyte *pucAuhorizationID,CDKEY_PLAYER_STATUS eStatus,GSubyte *pucGlobalID)
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
<dl compact><dt><b>Description:</b></dt><dd>This callback will be called whenever the game server receives a validation status for a player after having sent a validation status query to the validation server. It will inform the game server of the player validation status so that the game server can choose to keep or disconnect the user.</dd></dl>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>psReplyInfo</em> </td><td>Pointer to a reply information structure that contains request id and status </td></tr>
|
|
<tr><td valign=top><em>psValidationServerInfo</em> </td><td>Validation server information from where the response came </td></tr>
|
|
<tr><td valign=top><em>pucAuhorizationID</em> </td><td>The authorization id in the query </td></tr>
|
|
<tr><td valign=top><em>eStatus</em> </td><td>The validation status of the player </td></tr>
|
|
<tr><td valign=top><em>pucGlobalID</em> </td><td>The unique global identifier of the CDKey </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<hr>
|
|
<p align="right">
|
|
<i>Ubi.com GameService SDK - ©UbiSoft Entertainment 2002 </i><br>
|
|
<i><a href="mailto:gsdevteam@ubisoft.com">GameService development team</a></i>
|
|
</p>
|
|
</body>
|
|
</html>
|