LiveSupport::Scheduler::GetVersionMethod Class Reference

#include <GetVersionMethod.h>

Inheritance diagram for LiveSupport::Scheduler::GetVersionMethod:

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

[legend]List of all members.

---

Detailed Description

An XML-RPC method object to return the version string for the scheduler daemon.

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

There are no expected parameters for this method.

The XML-RPC function returns an XML-RPC structure, containing the following fields:

• version - string - the version string of the Scheduler Daemon

There are no possible internal error condititons for this function.

Author:

Author

fgerlits

Version:

Revision

2329

Definition at line 85 of file GetVersionMethod.h.

Public Member Functions
	GetVersionMethod (void) throw ()
	A default constructor, for testing purposes.
	GetVersionMethod (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 create playlist command on the Scheduler daemon.

---

Constructor & Destructor Documentation

LiveSupport::Scheduler::GetVersionMethod::GetVersionMethod

(

void

)

throw () [inline]

A default constructor, for testing purposes.

Definition at line 104 of file GetVersionMethod.h.

GetVersionMethod::GetVersionMethod

(

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 83 of file GetVersionMethod.cxx.

---

Member Function Documentation

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

Execute the create playlist command on the Scheduler daemon.

Parameters:

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

Definition at line 94 of file GetVersionMethod.cxx.

References versionStr.

---

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

• GetVersionMethod.h
• GetVersionMethod.cxx

---