LiveSupport::Scheduler::StopCurrentlyPlayingMethod Class Reference

#include <StopCurrentlyPlayingMethod.h>

Inheritance diagram for LiveSupport::Scheduler::StopCurrentlyPlayingMethod:

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

[legend]List of all members.

---

Detailed Description

An XML-RPC method object to stop the scheduler’s audio player.

The name of the method when called through XML-RPC is “stopCurrentlyPlaying”.

Stops the audio player, and removes the current item from the schedule, so that something else can be scheduled in its place.

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

• sessionId – string – the session ID obtained via the login() method of the authentication client

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

• 5001 – invalid argument format
• 5010 – error reported by the audio player component
• 5020 – missing session ID argument

Author:

Author

fgerlits

Version:

Revision

3017

Definition at line 94 of file StopCurrentlyPlayingMethod.h.

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

---

Constructor & Destructor Documentation

LiveSupport::Scheduler::StopCurrentlyPlayingMethod::StopCurrentlyPlayingMethod

(

void

)

throw () [inline]

A default constructor, for testing purposes.

Definition at line 113 of file StopCurrentlyPlayingMethod.h.

StopCurrentlyPlayingMethod::StopCurrentlyPlayingMethod

(

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 84 of file StopCurrentlyPlayingMethod.cxx.

---

Member Function Documentation

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

Execute the remove from schedule command on the Scheduler daemon.

Parameters:

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

Definition at line 95 of file StopCurrentlyPlayingMethod.cxx.

---

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

• StopCurrentlyPlayingMethod.h
• StopCurrentlyPlayingMethod.cxx

---