LiveSupport::Scheduler::LogoutMethod Class Reference

#include <LogoutMethod.h>

Inheritance diagram for LiveSupport::Scheduler::LogoutMethod:

[legend]Collaboration diagram for LiveSupport::Scheduler::LogoutMethod:

[legend]List of all members.

---

Detailed Description

An XML-RPC method object to log out from the authentication server.

The name of the method when called through XML-RPC is "logout".

The expected parameter is an XML-RPC structure, with the following members:

• sessionId - string - the session ID returned by login.

In case of an error, a standard XML-RPC fault response is generated, and a { faultCode, faultString } structure is returned. The possible errors are:

• 2101 - invalid argument format
• 2120 - missing session ID argument
• 2104 - the authentication server reported an error

Author:

Author

fgerlits

Version:

Revision

2329

Definition at line 86 of file LogoutMethod.h.

Public Member Functions
	LogoutMethod (void) throw ()
	A default constructor, for testing purposes.
	LogoutMethod (Ptr< XmlRpc::XmlRpcServer >::Ref xmlRpcServer) throw ()
	Constuctor that registers the method with the server right away.
void	execute (XmlRpc::XmlRpcValue ¶meters, XmlRpc::XmlRpcValue &returnValue) throw (XmlRpc::XmlRpcException)
	Execute the logout command on the Scheduler daemon.

---

Constructor & Destructor Documentation

LiveSupport::Scheduler::LogoutMethod::LogoutMethod

(

void

)

throw () [inline]

A default constructor, for testing purposes.

Definition at line 105 of file LogoutMethod.h.

LogoutMethod::LogoutMethod

(

Ptr< XmlRpc::XmlRpcServer >::Ref

xmlRpcServer

)

throw ()

Constuctor that registers the method with the server right away.

Parameters:

xmlRpcServer

the XML-RPC server to register with.

Definition at line 66 of file LogoutMethod.cxx.

---

Member Function Documentation

void LogoutMethod::execute	(	XmlRpc::XmlRpcValue &	parameters,
		XmlRpc::XmlRpcValue &	returnValue
	)			throw (XmlRpc::XmlRpcException)

Execute the logout command on the Scheduler daemon.

Parameters:

	parameters	XML-RPC function call parameters
	returnValue	the return value of the call (out parameter)

Definition at line 78 of file LogoutMethod.cxx.

References LiveSupport::Core::XmlRpcException::what().

---

The documentation for this class was generated from the following files:

• LogoutMethod.h
• LogoutMethod.cxx

---