This commit is contained in:
romkazvo
2023-08-07 19:29:24 +08:00
commit 34d6c5d489
4832 changed files with 1389451 additions and 0 deletions

View File

@@ -0,0 +1,154 @@
<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>Callbacks<br>
<small>
[<a class="el" href="group__group5.html">Persistent Storage Service</a>]</small>
</h1>The persistent storage service function callbacks.
<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(*&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__group__PSCB.html#a0">CBPSRcv_LoginResult</a> )(GSubyte ucType, GSint iReason)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Receive status of the Persistent data storage login request. </em> <a href="#a0"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(*&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__group__PSCB.html#a1">CBPSRcv_Disconnection</a> )()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Client as been disconnected from the Persistent storage service. </em> <a href="#a1"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(*&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__group__PSCB.html#a2">CBPSRcv_SetDataReply</a> )(GSubyte ucType, GSint iReason, GSuint iID)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Proxy reply on client request to set persistent data. </em> <a href="#a2"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>typedef GSvoid(*&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__group__PSCB.html#a3">CBPSRcv_GetDataReply</a> )(GSubyte ucType, GSint iReason, GSuint iID, GSvoid *pData, GSint iSize)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Proxy reply on client request to get persistent data. </em> <a href="#a3"></a><em><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="a1" doxytag="GSPersistentCB.h::CBPSRcv_Disconnection" ></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="GSPersistentCB_8h.html#a1">CBPSRcv_Disconnection</a>)()
</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 callback will be called when the client has been disconnected from the Persistent storage service </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="GSPersistentCB.h::CBPSRcv_GetDataReply" ></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="GSPersistentCB_8h.html#a3">CBPSRcv_GetDataReply</a>)(GSubyte ucType, GSint iReason, GSuint iID,GSvoid *pData,GSint iSize)
</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 callback will be called when the client ask for persistent data using the Persistent storage service</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>ucType</em>&nbsp;</td><td>The status of the message received back (GSSUCCESS or GSFAIL) </td></tr>
<tr><td valign=top><em>iReason</em>&nbsp;</td><td>The reason of failure if ucType is GSFAIL </td></tr>
<tr><td valign=top><em>iID</em>&nbsp;</td><td>The id of the request </td></tr>
<tr><td valign=top><em>pData</em>&nbsp;</td><td>Pointer to the data buffer </td></tr>
<tr><td valign=top><em>iSize</em>&nbsp;</td><td>Size of the data buffer </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a0" doxytag="GSPersistentCB.h::CBPSRcv_LoginResult" ></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="GSPersistentCB_8h.html#a0">CBPSRcv_LoginResult</a>)(GSubyte ucType, GSint iReason)
</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 callback will be called when the client receive a response from the router after asking to join the Persistent storage server </dd></dl>
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group5__1.html#a0">PSSend_Login()</a></dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>ucType</em>&nbsp;</td><td>The status of the message received back (GSSUCCESS or GSFAIL) </td></tr>
<tr><td valign=top><em>lReason</em>&nbsp;</td><td>The reason of failure if ucType is GSFAIL </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="GSPersistentCB.h::CBPSRcv_SetDataReply" ></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="GSPersistentCB_8h.html#a2">CBPSRcv_SetDataReply</a>)(GSubyte ucType, GSint iReason, GSuint iID)
</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 callback will be called when the client has set data using Persistent storage service</dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>ucType</em>&nbsp;</td><td>The status of the message received back (GSSUCCESS or GSFAIL) </td></tr>
<tr><td valign=top><em>iReason</em>&nbsp;</td><td>The reason of failure if ucType is GSFAIL </td></tr>
<tr><td valign=top><em>iID</em>&nbsp;</td><td>The id of the request </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>