CPPMyth
Library to interoperate with MythTV server
Public Member Functions | Private Member Functions | Private Attributes
Myth::ProtoMonitor Class Reference
Inheritance diagram for Myth::ProtoMonitor:
Inheritance graph
[legend]
Collaboration diagram for Myth::ProtoMonitor:
Collaboration graph
[legend]

Public Member Functions

 ProtoMonitor (const std::string &server, unsigned port)
 
 ProtoMonitor (const std::string &server, unsigned port, bool frontend)
 
virtual bool Open ()
 
virtual void Close ()
 
virtual bool IsOpen ()
 
ProtoRecorderPtr GetRecorderFromNum (int rnum)
 
bool QueryFreeSpaceSummary (int64_t *total, int64_t *used)
 
std::string GetSetting (const std::string &hostname, const std::string &setting)
 
bool SetSetting (const std::string &hostname, const std::string &setting, const std::string &value)
 
bool QueryGenpixmap (const Program &program)
 
bool DeleteRecording (const Program &program, bool force=false, bool forget=false)
 
bool UndeleteRecording (const Program &program)
 
bool StopRecording (const Program &program)
 
bool CancelNextRecording (int rnum, bool cancel)
 
StorageGroupFilePtr QuerySGFile (const std::string &hostname, const std::string &sgname, const std::string &filename)
 
MarkListPtr GetCutList (const Program &program)
 
MarkListPtr GetCommBreakList (const Program &program)
 
bool BlockShutdown ()
 
bool AllowShutdown ()
 
CardInputListPtr GetFreeInputs (int rnum=0)
 Asks the backend for a list of free inputs. A free input is one that is connected but not busy, not in a busy input group or is locked. More...
 
- Public Member Functions inherited from Myth::ProtoBase
 ProtoBase (const std::string &server, unsigned port)
 
virtual unsigned GetProtoVersion () const
 
virtual std::string GetServer () const
 
virtual unsigned GetPort () const
 
virtual int GetSocketErrNo () const
 
virtual int GetSocket () const
 
virtual bool HasHanging () const
 
virtual void CleanHanging ()
 
virtual ERROR_t GetProtoError () const
 

Private Member Functions

bool Announce75 ()
 
bool Announce88 ()
 
ProtoRecorderPtr GetRecorderFromNum75 (int rnum)
 
bool QueryFreeSpaceSummary75 (int64_t *total, int64_t *used)
 
std::string GetSetting75 (const std::string &hostname, const std::string &setting)
 
bool SetSetting75 (const std::string &hostname, const std::string &setting, const std::string &value)
 
bool QueryGenpixmap75 (const Program &program)
 
bool DeleteRecording75 (const Program &program, bool force, bool forget)
 
bool UndeleteRecording75 (const Program &program)
 
bool StopRecording75 (const Program &program)
 
bool CancelNextRecording75 (int rnum, bool cancel)
 
StorageGroupFilePtr QuerySGFile75 (const std::string &hostname, const std::string &sgname, const std::string &filename)
 
MarkListPtr GetCutList75 (const Program &program)
 
MarkListPtr GetCommBreakList75 (const Program &program)
 
bool BlockShutdown75 ()
 
bool AllowShutdown75 ()
 
std::vector< int > GetFreeCardIdList75 ()
 
CardInputListPtr GetFreeInputs75 ()
 
CardInputListPtr GetFreeInputs79 ()
 
CardInputListPtr GetFreeInputs81 ()
 
CardInputListPtr GetFreeInputs87 (int rnum)
 
CardInputListPtr GetFreeInputs89 (int rnum)
 
CardInputListPtr GetFreeInputs90 (int rnum)
 
CardInputListPtr GetFreeInputs91 (int rnum)
 

Private Attributes

bool m_frontend
 

Additional Inherited Members

- Public Types inherited from Myth::ProtoBase
enum  ERROR_t { ERROR_NO_ERROR = 0, ERROR_SERVER_UNREACHABLE, ERROR_SOCKET_ERROR, ERROR_UNKNOWN_VERSION }
 
- Protected Member Functions inherited from Myth::ProtoBase
bool OpenConnection (int rcvbuf)
 
void HangException ()
 
bool SendCommand (const char *cmd, bool feedback=true)
 
size_t GetMessageLength () const
 
bool ReadField (std::string &field)
 
bool IsMessageOK (const std::string &field) const
 
size_t FlushMessage ()
 
bool RcvMessageLength ()
 
ProgramPtr RcvProgramInfo ()
 
void MakeProgramInfo (const Program &program, std::string &msg)
 
- Protected Attributes inherited from Myth::ProtoBase
OS::CMutex * m_mutex
 
TcpSocket * m_socket
 
unsigned m_protoVersion
 
std::string m_server
 
unsigned m_port
 
bool m_hang
 Connection hang: while true allow retry.
 
bool m_tainted
 Connection has hung since last reset.
 
size_t m_msgLength
 
size_t m_msgConsumed
 

Detailed Description

Definition at line 35 of file mythprotomonitor.h.

Member Function Documentation

◆ GetFreeInputs()

CardInputListPtr Myth::ProtoMonitor::GetFreeInputs ( int  rnum = 0)
inline

Asks the backend for a list of free inputs. A free input is one that is connected but not busy, not in a busy input group or is locked.

Parameters
rnumSince protocol 87: Input to exclude (not counted as busy). Defaulted with 0 for none.
Returns

Definition at line 106 of file mythprotomonitor.h.

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