svdrp.h File Reference

#include "thread.h"
#include "tools.h"

Go to the source code of this file.

Enumerations
enum	eSvdrpPeerModes { spmOff = 0 , spmAny = 1 , spmOnly = 2 }

Functions
void	SetSVDRPPorts (int TcpPort, int UdpPort)
void	SetSVDRPGrabImageDir (const char *GrabImageDir)
void	StartSVDRPHandler (void)
void	StopSVDRPHandler (void)
bool	GetSVDRPServerNames (cStringList *ServerNames)
bool	ExecSVDRPCommand (const char *ServerName, const char *Command, cStringList *Response=NULL)
void	BroadcastSVDRPCommand (const char *Command)
int	SVDRPCode (const char *s)
const char *	SVDRPValue (const char *s)

Variables
cStateKey	StateKeySVDRPRemoteTimersPoll

Enumeration Type Documentation

eSvdrpPeerModes

enum eSvdrpPeerModes

Enumerator
spmOff
spmAny
spmOnly

Definition at line 16 of file svdrp.h.

Function Documentation

BroadcastSVDRPCommand()

void BroadcastSVDRPCommand

(

const char *

Command

)

Sends the given SVDRP Command string to all remote VDRs.

Definition at line 2908 of file svdrp.c.

References BroadcastSVDRPCommand(), ExecSVDRPCommand(), cSVDRPClientHandler::GetServerNames(), cVector< T >::Size(), SVDRPClientHandler, and SVDRPHandlerMutex.

Referenced by BroadcastSVDRPCommand().

ExecSVDRPCommand()

bool ExecSVDRPCommand	(	const char *	ServerName,
		const char *	Command,
		cStringList *	Response = NULL )

Sends the given SVDRP Command string to the remote VDR identified by ServerName and collects all of the response strings in Response.

If no Response parameter is given, the response from command execution is ignored. Returns true if the data exchange was successful. Whether or not the actual SVDRP command was successful depends on the resulting strings from the remote VDR, which can be accessed through Response. If Response is given, it will be cleared before the command is actually executed.

Definition at line 2899 of file svdrp.c.

References ExecSVDRPCommand(), cSVDRPClientHandler::Execute(), SVDRPClientHandler, and SVDRPHandlerMutex.

Referenced by BroadcastSVDRPCommand(), ExecSVDRPCommand(), HandleRemoteTimerModifications(), and cMenuTimers::OnOff().

GetSVDRPServerNames()

bool GetSVDRPServerNames

(

cStringList *

ServerNames

)

Gets a list of all available VDRs this VDR is connected to via SVDRP, and stores it in the given ServerNames list.

The list is cleared before getting the server names. Returns true if the resulting list is not empty.

Definition at line 2890 of file svdrp.c.

References cSVDRPClientHandler::GetServerNames(), GetSVDRPServerNames(), SVDRPClientHandler, and SVDRPHandlerMutex.

Referenced by cMenuEditTimer::cMenuEditTimer(), GetSVDRPServerNames(), and cMenuSetupMisc::Set().

SetSVDRPGrabImageDir()

void SetSVDRPGrabImageDir

(

const char *

GrabImageDir

)

Definition at line 2779 of file svdrp.c.

References grabImageDir, and SetSVDRPGrabImageDir().

Referenced by main(), and SetSVDRPGrabImageDir().

SetSVDRPPorts()

void SetSVDRPPorts	(	int	TcpPort,
		int	UdpPort )

Definition at line 2773 of file svdrp.c.

References SetSVDRPPorts(), SVDRPTcpPort, and SVDRPUdpPort.

Referenced by main(), and SetSVDRPPorts().

StartSVDRPHandler()

void StartSVDRPHandler

(

void

)

Definition at line 2863 of file svdrp.c.

References cSVDRPClientHandler::cSVDRPClientHandler(), cSVDRPServerHandler::cSVDRPServerHandler(), Setup, cThread::Start(), StartSVDRPHandler(), SVDRPClientHandler, SVDRPHandlerMutex, cSetup::SVDRPPeering, SVDRPServerHandler, SVDRPTcpPort, SVDRPUdpPort, and cSVDRPServerHandler::WaitUntilReady().

Referenced by main(), cMenuSetupMisc::ProcessKey(), and StartSVDRPHandler().

StopSVDRPHandler()

void StopSVDRPHandler

(

void

)

Definition at line 2879 of file svdrp.c.

References StopSVDRPHandler(), SVDRPClientHandler, SVDRPHandlerMutex, and SVDRPServerHandler.

Referenced by main(), cMenuSetupMisc::ProcessKey(), and StopSVDRPHandler().

SVDRPCode()

int SVDRPCode ( const char * s )

inline

Returns the value of the three digit reply code of the given SVDRP response string.

Definition at line 47 of file svdrp.h.

References SVDRPCode().

Referenced by cSVDRPClient::GetRemoteTimers(), HandleRemoteTimerModifications(), cMenuTimers::OnOff(), and SVDRPCode().

SVDRPValue()

const char * SVDRPValue ( const char * s )

inline

Returns the actual value of the given SVDRP response string, skipping the three digit reply code and possible continuation line indicator.

Definition at line 50 of file svdrp.h.

References SVDRPValue().

Referenced by HandleRemoteTimerModifications(), and SVDRPValue().

Variable Documentation

StateKeySVDRPRemoteTimersPoll

cStateKey StateKeySVDRPRemoteTimersPoll

extern

Controls whether a change to the local list of timers needs to result in sending a POLL to the remote clients.

Referenced by cMenuTimers::Delete(), main(), cMenuTimers::OnOff(), cMenuEditTimer::ProcessKey(), cMenuSchedule::Record(), cMenuWhatsOn::Record(), StateKeySVDRPRemoteTimersPoll(), and TimerStillRecording().