Changes between Initial Version and Version 1 of XmlRpcNoOperation


Ignore:
Timestamp:
Sep 26, 2008, 8:11:26 PM (16 years ago)
Author:
guest
Comment:

Created this page [Majky]

Legend:

Unmodified
Added
Removed
Modified

  • XmlRpcNoOperation

    v1 v1  
     1[[PageOutline(3-4, Sections)]]
     2
     3== !NoOperation ==
     4
     5
     6=== Intro ===
     7
     8  keep given session alive, check session validity
     9
     10
     11=== Description ===
     12
     13  '''struct !NoOperation(string $token)'''
     14 
     15  This function is used to keep the session ''token'' alive while client application is idling.
     16
     17  Should be called every 15 minutes between XML-RPC requests (in case user is idle or client application is not currently communicating with OSDb server) to keep the connection alive while client application is still running.
     18  It can be also used to check if given ''token'' is still active.
     19
     20
     21=== Parameters ===
     22
     23  ''token (required)''::
     24    token string identifying user's session, taken from [XmlRpcLogIn LogIn] output structure.
     25
     26
     27=== Return Values ===
     28
     29  Output is returned in this structure:
     30{{{
     31  struct(
     32    (string) [status],
     33    (double) [seconds]
     34  )
     35}}}
     36
     37  and contains these elements:
     38   ''status''::
     39     function result code,
     40     contains error "406 No session" if session is no longer valid/active,
     41     see [wiki:XmlRpcStatusCode list of status codes]
     42   ''seconds''::
     43     time taken to execute this command on server
     44
     45
     46=== Implementations ===
     47
     48  There are currently no available sample implementations.
     49
     50
     51=== Changelog ===
     52
     53  Version 1: created this function
     54
     55
     56=== Examples ===
     57
     58
     59==== Input ====
     60
     61{{{
     62#!xml
     63<methodCall>
     64 <methodName>NoOperation</methodName>
     65 <params>
     66  <param>
     67   <value><string>0t6bf5qt1l32ol67frupr47fg7</string></value>
     68  </param>
     69 </params>
     70</methodCall>
     71}}}
     72 
     73==== Output ====
     74
     75{{{
     76#!xml
     77<methodResponse>
     78<params>
     79 <param>
     80  <value>
     81   <struct>
     82    <member>
     83     <name>status</name>
     84     <value><string>200 OK</string></value>
     85    </member>
     86    <member>
     87     <name>seconds</name>
     88     <value><double>0.005</double></value>
     89    </member>
     90   </struct>
     91  </value>
     92 </param>
     93</params>
     94</methodResponse>
     95}}}
     96
     97
     98=== Notes ===
     99
     100  none yet
     101
     102
     103=== See also ===
     104
     105  * [wiki:XmlRpcLogIn LogIn]
     106  * [wiki:XmlRpcLogOut LogOut]
     107
     108
     109=== Comments ===
     110
     111        add your comments, hints and suggestion here if you like ...
     112
     113
     114[Prev] [wiki:XmlRpcIntro Home] [Next]