RomkaZVO/FC1
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
34d6c5d489611da93eb41d9afd4744c00da9f517
FC1/Ubisoft.com/GSServices/sdks/gs-sdk-cdkey/doc-api/group__group2.html
romkazvo 34d6c5d489 123
2023-08-07 19:29:24 +08:00

214 lines
10 KiB
HTML
Raw Blame History

<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&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
<h1>Game server functionalities</h1>Game server functionalities.
<a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="GSCDKeyDefines_8h.html#a0">GSCDKeyRequest</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__group2.html#a0">GSCDKey_ValidateUser</a> (GShandle pGSCDKeyHandle, <a class="el" href="struct__VALIDATION__SERVER__INFO.html">PVALIDATION_SERVER_INFO</a> psValidationServerInfo, GSubyte *pucAuhorizationID, GSchar *szGameName, GSushort usTimeout=3)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Ask the validation server for a validation status of a player. </em> <a href="#a0"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="GSCDKeyDefines_8h.html#a0">GSCDKeyRequest</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__group2.html#a1">GSCDKey_DisconnectUser</a> (GShandle pGSCDKeyHandle, <a class="el" href="struct__VALIDATION__SERVER__INFO.html">PVALIDATION_SERVER_INFO</a> psValidationServerInfo, GSubyte *pucAuhorizationID)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Inform the validation server that a player has disconnected. </em> <a href="#a1"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="GSCDKeyDefines_8h.html#a0">GSCDKeyRequest</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__group2.html#a2">GSCDKey_PlayerStatusReply</a> (GShandle pGSCDKeyHandle, <a class="el" href="struct__VALIDATION__SERVER__INFO.html">PVALIDATION_SERVER_INFO</a> psValidationServerInfo, GSubyte *pucAuhorizationID, CDKEY_PLAYER_STATUS eStatus)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Inform the validation server of a player status. </em> <a href="#a2"></a><em><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
These functions are used by the game server to ask the validation status of a player, inform the validation server of a player status and disconnection. <hr><h2>Function Documentation</h2>
<a class="anchor" name="a1" doxytag="GSCDKeyInterface.h::GSCDKey_DisconnectUser" ></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"> <a class="el" href="GSCDKeyDefines_8h.html#a0">GSCDKeyRequest</a> GSCDKey_DisconnectUser </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">GShandle&nbsp;</td>
<td class="mdname" nowrap> <em>pGSCDKeyHandle</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="struct__VALIDATION__SERVER__INFO.html">PVALIDATION_SERVER_INFO</a>&nbsp;</td>
<td class="mdname" nowrap> <em>psValidationServerInfo</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>GSubyte *&nbsp;</td>
<td class="mdname" nowrap> <em>pucAuhorizationID</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<dl compact><dt><b>Description:</b></dt><dd>This function is used to inform the validation server that a player has disconnected from the game server. This must be called whenever a game server detects a client disconnection.</dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>The id 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>pGSCDKeyHandle</em>&nbsp;</td><td>Handle on the created cd key module </td></tr>
<tr><td valign=top><em>psValidationServerInfo</em>&nbsp;</td><td>Validation server information </td></tr>
<tr><td valign=top><em>pucAuhorizationID</em>&nbsp;</td><td>Authorization id of the game client </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="GSCDKeyInterface.h::GSCDKey_PlayerStatusReply" ></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"> <a class="el" href="GSCDKeyDefines_8h.html#a0">GSCDKeyRequest</a> GSCDKey_PlayerStatusReply </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">GShandle&nbsp;</td>
<td class="mdname" nowrap> <em>pGSCDKeyHandle</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="struct__VALIDATION__SERVER__INFO.html">PVALIDATION_SERVER_INFO</a>&nbsp;</td>
<td class="mdname" nowrap> <em>psValidationServerInfo</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>GSubyte *&nbsp;</td>
<td class="mdname" nowrap> <em>pucAuhorizationID</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>CDKEY_PLAYER_STATUS&nbsp;</td>
<td class="mdname" nowrap> <em>eStatus</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<dl compact><dt><b>Description:</b></dt><dd>This function is used to inform the validation server of a player status. This must be called with the correct status for a player whenever the game server receive a status request from the validation server via the CBCDKey_RcvPlayerStatusRequest callback.</dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>The id 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>pGSCDKeyHandle</em>&nbsp;</td><td>Handle on the created cd key module </td></tr>
<tr><td valign=top><em>psValidationServerInfo</em>&nbsp;</td><td>Validation server information </td></tr>
<tr><td valign=top><em>pucAuhorizationID</em>&nbsp;</td><td>Authorization id of the game client </td></tr>
<tr><td valign=top><em>eStatus</em>&nbsp;</td><td>Status of the player </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a0" doxytag="GSCDKeyInterface.h::GSCDKey_ValidateUser" ></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"> <a class="el" href="GSCDKeyDefines_8h.html#a0">GSCDKeyRequest</a> GSCDKey_ValidateUser </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">GShandle&nbsp;</td>
<td class="mdname" nowrap> <em>pGSCDKeyHandle</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="struct__VALIDATION__SERVER__INFO.html">PVALIDATION_SERVER_INFO</a>&nbsp;</td>
<td class="mdname" nowrap> <em>psValidationServerInfo</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>GSubyte *&nbsp;</td>
<td class="mdname" nowrap> <em>pucAuhorizationID</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>GSchar *&nbsp;</td>
<td class="mdname" nowrap> <em>szGameName</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>GSushort&nbsp;</td>
<td class="mdname" nowrap> <em>usTimeout</em> = 3</td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<dl compact><dt><b>Description:</b></dt><dd>This function is used to ask the validation server for a validation status of a player after the latter has connected on the game server. The game server will received the result via the CBCDKey_RcvValidationResponse callback.</dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>The id 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>pGSCDKeyHandle</em>&nbsp;</td><td>Handle on the created cd key module </td></tr>
<tr><td valign=top><em>psValidationServerInfo</em>&nbsp;</td><td>Validation server information </td></tr>
<tr><td valign=top><em>pucAuhorizationID</em>&nbsp;</td><td>Authorization id sent by the game client </td></tr>
<tr><td valign=top><em>szGameName</em>&nbsp;</td><td>Name of the game on the game server </td></tr>
<tr><td valign=top><em>usTimeout</em>&nbsp;</td><td>Number of second before the request is considered timed out default for this request is 3. 0 means a unlimited timeout value. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr>
<p align="right">
<i>Ubi.com GameService SDK - &copy;UbiSoft Entertainment 2002 </i><br>
<i><a href="mailto:gsdevteam@ubisoft.com">GameService development team</a></i>
</p>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink