org.jmythapi.protocol.request
Interface IMythRequest

All Superinterfaces:

ISendable, IVersionable

All Known Implementing Classes:

AMythRequest

public interface IMythRequest
extends IVersionable, ISendable

This interface represents a MythTV-protocol request.

A MythTV-protocol request consists of a command with a name and optionally a list of command arguments, separated by space.
Additionally request-parameters may be required, which are then separated by []:[].

When sending a request-messages to the backend, it is transfered in the form of an packet.

Request Example:

The following MythTV-request consists of a command with the name QUERY_REMOTEENCODER and an additional command parameter 1, which is the id of a remote encoder. The command name and additional command parameters are separated by space. Additionally the request contains a extra request parameter IS_BUSY, which in this case is a command to be processed by the remote encoder. The command and additional request parameters are by []:[].
The number shown in front of the request-command is the packet payload size.

33	QUERY_REMOTEENCODER 1[]:[]IS_BUSY

Supported Commands:

The following page contains a list of request-commands supported by a MythTV-backend: commands.
You can either send requests directly to a backend using a IBackendConnection, or you can use the more convenient functions provided by the IBackend, IRecorder or IRemoteEncoder classes.

See Also:

command, packet, connection, backend

Method Summary

IMythCommand	getCommand() Gets the request-command.
List<String>	getRequestArguments() Gets additional request-arguments.

Methods inherited from interface org.jmythapi.IVersionable

getVersionNr

Methods inherited from interface org.jmythapi.protocol.ISendable

getPacket

Method Detail

getCommand

IMythCommand getCommand()

Gets the request-command.

A command itself consists of a mandatory name and optional command arguments, e.g.GET_FREE_RECORDER_COUNT or ANN Playback MythTvPlayer 0.

Returns:

the command of the request object

getRequestArguments

List<String> getRequestArguments()

Gets additional request-arguments.

Returns:

additional request arguments.