[[PageOutline(3-4, Sections)]]

== !NoOperation ==


=== Intro ===

  keep given session alive, check session validity


=== Description ===

  '''struct !NoOperation(string $token)'''
  
  This function is used to keep the session ''token'' alive while client application is idling.

  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.
  It can be also used to check if given ''token'' is still active.


=== Parameters ===

  ''token (required)''::
    token string identifying user's session, taken from [XmlRpcLogIn LogIn] output structure.


=== Return Values ===

  Output is returned in this structure: 
{{{
  struct(
    (string) [status],
    (double) [seconds]
  )
}}}

  and contains these elements:
   ''status''::
     function result code,
     contains error "406 No session" if session is no longer valid/active,
     see [wiki:XmlRpcStatusCode list of status codes]
   ''seconds''::
     time taken to execute this command on server


=== Implementations ===

  There are currently no available sample implementations.


=== Changelog ===

  Version 1: created this function


=== Examples ===


==== Input ====

{{{
#!xml
<methodCall>
 <methodName>NoOperation</methodName>
 <params>
  <param>
   <value><string>0t6bf5qt1l32ol67frupr47fg7</string></value>
  </param>
 </params>
</methodCall>
}}}
  
==== Output ====

{{{
#!xml
<methodResponse>
<params>
 <param>
  <value>
   <struct>
    <member>
     <name>status</name>
     <value><string>200 OK</string></value>
    </member>
    <member>
     <name>seconds</name>
     <value><double>0.005</double></value>
    </member>
   </struct>
  </value>
 </param>
</params>
</methodResponse>
}}}


=== Notes ===

  none yet


=== See also ===

  * [wiki:XmlRpcLogIn LogIn]
  * [wiki:XmlRpcLogOut LogOut]


=== Comments ===

	add your comments, hints and suggestion here if you like ...


[Prev] [wiki:XmlRpcIntro Home] [Next]