MythFrontend Class Reference

List of all members.


Detailed Description

A connection to a particular frontend /*.

Definition at line 18 of file MythFrontend.php.


Public Member Functions

 __construct ($host, $port)
 Object constructor.
MythFrontend ($host, $port)
 Placeholder constructor for php4 compatibility.
 __destruct ()
 Disconnect when destroying the object.
 connect ($timeout=5)
 Open a connection to this frontend.
 _disconnect ()
 Disconnect from this frontend /*.
 _get_response ($query, $keep_hash=false)
 Get the response to a query as a string, or an awaiting response buffer if $query is null.
 _get_rows ($query, $sep="\n")
 Call _get_response and return its string broken into an array.
 get_jump_points ()
 Load and return the jump points available for this frontend.
 query_location ()
 Return the location, or a status message that the frontend isn't running.
 query ($query)
 Send a query to the frontend.
 send_key ($key)
 Send a keypress to the frontend.
 send_jump ($jump_point)
 Send the frontend to a specific jump point.
 send_play ($options)
 Send a playback command to the frontend.

Public Attributes

 $fp
 $connected = false
 $host
 $port
 $jump_points = array()

Constructor & Destructor Documentation

MythFrontend::__construct ( host,
port 
)

Object constructor.

Parameters:
string $host Hostname or IP for this frontend.
int $port TCP port to connect to. /*

Definition at line 40 of file MythFrontend.php.

MythFrontend::__destruct (  ) 

Disconnect when destroying the object.

/*

Definition at line 58 of file MythFrontend.php.


Member Function Documentation

& MythFrontend::MythFrontend ( host,
port 
)

Placeholder constructor for php4 compatibility.

Parameters:
string $host Hostname or IP for this frontend.
int $port TCP port to connect to. /*

Definition at line 51 of file MythFrontend.php.

MythFrontend::connect ( timeout = 5  ) 

Open a connection to this frontend.

This also serves as a ping to verify that a frontend is running.

Parameters:
int $timeout Connection timeout, set low in case the host isn't actually on. /*

Definition at line 69 of file MythFrontend.php.

MythFrontend::_disconnect (  ) 

Disconnect from this frontend /*.

Definition at line 87 of file MythFrontend.php.

MythFrontend::_get_response ( query,
keep_hash = false 
)

Get the response to a query as a string, or an awaiting response buffer if $query is null.

Parameters:
string $query The query to send, or null
Returns:
string The response to $query /*

Definition at line 103 of file MythFrontend.php.

MythFrontend::_get_rows ( query,
sep = "\n" 
)

Call _get_response and return its string broken into an array.

Parameters:
string $query The query to send, or null
Returns:
array The response to $query, broken into an array /*

Definition at line 130 of file MythFrontend.php.

MythFrontend::get_jump_points (  ) 

Load and return the jump points available for this frontend.

Returns:
array The jump points available for this frontend /*

Definition at line 140 of file MythFrontend.php.

MythFrontend::query_location (  ) 

Return the location, or a status message that the frontend isn't running.

Returns:
string Location of the frontend. /*

Definition at line 157 of file MythFrontend.php.

MythFrontend::query ( query  ) 

Send a query to the frontend.

Parameters:
string $query The key to send. /*

Definition at line 169 of file MythFrontend.php.

MythFrontend::send_key ( key  ) 

Send a keypress to the frontend.

Parameters:
string $jump_point The key to send. /*

Definition at line 179 of file MythFrontend.php.

MythFrontend::send_jump ( jump_point  ) 

Send the frontend to a specific jump point.

Parameters:
string $jump_point The jump point to send. /*

Definition at line 191 of file MythFrontend.php.

MythFrontend::send_play ( options  ) 

Send a playback command to the frontend.

Parameters:
string $options The playback parameters to pass in. /*

Definition at line 203 of file MythFrontend.php.


Member Data Documentation

MythFrontend::$fp

Definition at line 21 of file MythFrontend.php.

MythFrontend::$connected = false

Definition at line 24 of file MythFrontend.php.

MythFrontend::$host

Definition at line 27 of file MythFrontend.php.

MythFrontend::$port

Definition at line 29 of file MythFrontend.php.

MythFrontend::$jump_points = array()

Definition at line 32 of file MythFrontend.php.


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

Generated on Sat Dec 18 05:16:07 2010 for MythTV by  doxygen 1.5.5