425 lines
18 KiB
HTML
425 lines
18 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>Functions<br>
|
|
<small>
|
|
[<a class="el" href="group__group5.html">Persistent Storage Service</a>]</small>
|
|
</h1>Messages sent to the persistent storage service.
|
|
<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>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group5__1.html#a0">PSSend_Login</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Login to the persistent storage service. </em> <a href="#a0"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group5__1.html#a1">PSSend_Disconnect</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disconnect from the persistent storage service. </em> <a href="#a1"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group5__1.html#a2">PS_Engine</a> (GSuint uiMaxPostingDelay=500, GSuint uiMaxsOperationalDelay=800)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Update connection status-messages handling relating to the persistent data storage service. </em> <a href="#a2"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>GSuint </td><td class="memItemRight" valign=bottom><a class="el" href="group__group5__1.html#a3">PSSend_GetPrivateData</a> (const GSchar *szGame, GSint iEventID, GSint iRecordID)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the private data related to a player. </em> <a href="#a3"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>GSuint </td><td class="memItemRight" valign=bottom><a class="el" href="group__group5__1.html#a4">PSSend_SetPrivateData</a> (const GSchar *szGame, GSint iEventID, GSint iRecordID, const GSvoid *vpData, GSint iSize)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the private data related to a player. </em> <a href="#a4"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>GSuint </td><td class="memItemRight" valign=bottom><a class="el" href="group__group5__1.html#a5">PSSend_GetPublicData</a> (const GSchar *szGame, GSint iEventID, GSint iRecordID, const GSchar *szUsername=0)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the public data related to a player. </em> <a href="#a5"></a><em><br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align=right valign=top>GSuint </td><td class="memItemRight" valign=bottom><a class="el" href="group__group5__1.html#a6">PSSend_SetPublicData</a> (const GSchar *szGame, GSint iEventID, GSint iRecordID, const GSvoid *vpData, GSint iSize)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the public data related to a player. </em> <a href="#a6"></a><em><br><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
These function are used to send to messages to the persistent storage server <hr><h2>Function Documentation</h2>
|
|
<a class="anchor" name="a2" doxytag="GSClientLibrary.h::PS_Engine" ></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"> GSbool PS_Engine </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">GSuint </td>
|
|
<td class="mdname" nowrap> <em>uiMaxPostingDelay</em> = 500, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>GSuint </td>
|
|
<td class="mdname" nowrap> <em>uiMaxsOperationalDelay</em> = 800</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
<dl compact><dt><b>Description:</b></dt><dd>Updates the connection between the client and the server, and handles the delivery of queued up messages and reception of messages relating to the persistent data storage service service. This function should be called regularly to ensure that the application will run smoothly with the service.</dd></dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
|
<dl compact><dt><b>Return values:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>GS_TRUE</em> </td><td>The connection is ok and function call was a success </td></tr>
|
|
<tr><td valign=top><em>GS_FALSE</em> </td><td>There has been a communication problem between the client and the server</td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>uiMaxPostingDelay</em> </td><td>The maximum time to be spent inside the engine to read incomming messages and posting them to the message queue. (Milliseconds) </td></tr>
|
|
<tr><td valign=top><em>uiMaxsOperationalDelay</em> </td><td>The maximum time to be spent inside the engine to decode message in the queue and calling appropriate callback. (Milliseconds) </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a1" doxytag="GSClientLibrary.h::PSSend_Disconnect" ></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"> GSbool PSSend_Disconnect </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
<dl compact><dt><b>Description:</b></dt><dd>Disconnect from the persistent storage service.</dd></dl>
|
|
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__PSCB.html#a1">CBPSRcv_Disconnection</a></dd></dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
|
<dl compact><dt><b>Return values:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
|
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a3" doxytag="GSClientLibrary.h::PSSend_GetPrivateData" ></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"> GSuint PSSend_GetPrivateData </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const GSchar * </td>
|
|
<td class="mdname" nowrap> <em>szGame</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>GSint </td>
|
|
<td class="mdname" nowrap> <em>iEventID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>GSint </td>
|
|
<td class="mdname" nowrap> <em>iRecordID</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
<dl compact><dt><b>Description:</b></dt><dd>Get the private data related to a player using the persistent data storage service.</dd></dl>
|
|
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__PSCB.html#a3">CBPSRcv_GetDataReply</a></dd></dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>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>szGame</em> </td><td>The name of the game </td></tr>
|
|
<tr><td valign=top><em>iEventID</em> </td><td>The id of the event (this id is available in the lobby info) </td></tr>
|
|
<tr><td valign=top><em>iRecordID</em> </td><td>Specific id of the record set. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a5" doxytag="GSClientLibrary.h::PSSend_GetPublicData" ></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"> GSuint PSSend_GetPublicData </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const GSchar * </td>
|
|
<td class="mdname" nowrap> <em>szGame</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>GSint </td>
|
|
<td class="mdname" nowrap> <em>iEventID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>GSint </td>
|
|
<td class="mdname" nowrap> <em>iRecordID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>const GSchar * </td>
|
|
<td class="mdname" nowrap> <em>szUsername</em> = 0</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
<dl compact><dt><b>Description:</b></dt><dd>Get the public data related to a player using the persistent data storage service.</dd></dl>
|
|
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__PSCB.html#a2">CBPSRcv_SetDataReply</a></dd></dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>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>szGame</em> </td><td>The name of the game </td></tr>
|
|
<tr><td valign=top><em>iEventID</em> </td><td>The id of the event (this id is available in the lobby info) </td></tr>
|
|
<tr><td valign=top><em>iRecordID</em> </td><td>Specific id of the record set. </td></tr>
|
|
<tr><td valign=top><em>szUsername</em> </td><td>The username of the player related with the data (Default to the current username if the argument is not passed) </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a0" doxytag="GSClientLibrary.h::PSSend_Login" ></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"> GSbool PSSend_Login </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
<dl compact><dt><b>Description:</b></dt><dd>Login to the persistent storage service. Will return false if unable to connect true on success</dd></dl>
|
|
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__PSCB.html#a0">CBPSRcv_LoginResult</a></dd></dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
|
<dl compact><dt><b>Return values:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
|
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a4" doxytag="GSClientLibrary.h::PSSend_SetPrivateData" ></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"> GSuint PSSend_SetPrivateData </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const GSchar * </td>
|
|
<td class="mdname" nowrap> <em>szGame</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>GSint </td>
|
|
<td class="mdname" nowrap> <em>iEventID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>GSint </td>
|
|
<td class="mdname" nowrap> <em>iRecordID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>const GSvoid * </td>
|
|
<td class="mdname" nowrap> <em>vpData</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>GSint </td>
|
|
<td class="mdname" nowrap> <em>iSize</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
<dl compact><dt><b>Description:</b></dt><dd>Set the private data related to a player using the persistent data storage service.</dd></dl>
|
|
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__PSCB.html#a2">CBPSRcv_SetDataReply</a></dd></dl>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>szGame</em> </td><td>The name of the game </td></tr>
|
|
<tr><td valign=top><em>iEventID</em> </td><td>The id of the event (this id is available in the lobby info) </td></tr>
|
|
<tr><td valign=top><em>iRecordID</em> </td><td>Specific id of the record set. </td></tr>
|
|
<tr><td valign=top><em>vpData</em> </td><td>The actual data buffer </td></tr>
|
|
<tr><td valign=top><em>iSize</em> </td><td>Size of the data buffer </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a6" doxytag="GSClientLibrary.h::PSSend_SetPublicData" ></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"> GSuint PSSend_SetPublicData </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const GSchar * </td>
|
|
<td class="mdname" nowrap> <em>szGame</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>GSint </td>
|
|
<td class="mdname" nowrap> <em>iEventID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>GSint </td>
|
|
<td class="mdname" nowrap> <em>iRecordID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>const GSvoid * </td>
|
|
<td class="mdname" nowrap> <em>vpData</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>GSint </td>
|
|
<td class="mdname" nowrap> <em>iSize</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
<dl compact><dt><b>Description:</b></dt><dd>Set the public data related to a player using the persistent data storage service.</dd></dl>
|
|
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__PSCB.html#a2">CBPSRcv_SetDataReply</a></dd></dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>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>szGame</em> </td><td>The name of the game </td></tr>
|
|
<tr><td valign=top><em>iEventID</em> </td><td>The id of the event (this id is available in the lobby info) </td></tr>
|
|
<tr><td valign=top><em>iRecordID</em> </td><td>Specific id of the record set. </td></tr>
|
|
<tr><td valign=top><em>vpData</em> </td><td>The actual data buffer </td></tr>
|
|
<tr><td valign=top><em>iSize</em> </td><td>Size of the data buffer </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>
|