Description

Described the details about the classes used in Messages.

Data Structures
class	TRM::ReserveTunerResponse
	Class implementing the response message to a ReserveTuner request. More...

class	TRM::ReserveTuner
	Class implementing a Tuner reservation request, the client uses this message to request, update or renew a reservation. More...

class	TRM::ReleaseTunerReservationResponse
	Class implementing the response message payload for releasing Tuner reservation. More...

class	TRM::ReleaseTunerReservation
	Implements the message payload for releasing tuner reservation. More...

class	TRM::ValidateTunerReservationResponse
	Implements the response message payload for Tuner reservation validation requests. More...

class	TRM::ValidateTunerReservation
	Implements the message format for client to validate an existing tuner reservation. More...

class	TRM::CancelRecordingResponse
	Implements payload for a response message against cancel recording request. More...

class	TRM::CancelRecording
	Implements a message to cancel the recording. More...

class	TRM::CancelLiveResponse
	Implements payload for a response message against cancel live streaming request. More...

class	TRM::CancelLive
	Implements a message to cancel the live streaming. More...

class	TRM::GetAllTunerIdsResponse
	Implements the response message payload against a Tuner Id request. More...

class	TRM::GetAllTunerIds
	Implements the message payload format for requesting the system allocated Unique Id of tuner. The ID for each tuner is guaranteed to be unique within the same target host. More...

class	TRM::DetailedTunerState
	Class for implementing the detail state information of a single tuner. More...

class	TRM::GetAllTunerStatesResponse
	Implements the response payload against a Get tuner state request. More...

class	TRM::GetAllTunerStates
	Implements a request message for getting the state of all tuners in the system. More...

class	TRM::GetAllReservationsResponse
	Implements the response message for the request to get All tuner reservation details. More...

class	TRM::GetAllReservations
	Implements a request message to get reservation detail of all the tuners that are valid at that time. More...

class	TRM::GetVersionResponse
	Implements the response message for the queries that request TRM server version. More...

class	TRM::NotifyTunerReservationRelease
	Class to implement asynchronous Notification from TRM to the owner of a token that its tuner reservation has been terminated. The token is no longer valid after receiving this message. More...

class	TRM::NotifyTunerReservationUpdate
	Implements the asynchronous Notification from TRM whenever a reservation has changed its usage by its owner. More...

class	TRM::NotifyTunerReservationConflicts
	Class for implementing asynchronous notification from TRM to the owner of a token that a tuner reservation is about to be terminated, unless the owner initiates to resolve the conflict. More...

class	TRM::NotifyTunerStatesUpdate
	Class for implementing an asynchronous Notification from TRM whenever a tuner has changed it state. More...

class	TRM::NotifyTunerPretune
	Implements a Notification message when a pre tune has performed. More...

Data Structure Documentation

◆ TRM::ReserveTunerResponse

class TRM::ReserveTunerResponse

Class implementing the response message to a ReserveTuner request.

The tuner reservations included in the response are granted reservations. The requesting component (e.g. Guide or Recorder) must comply with the granted reservations, or update the granted reservations with the actual tuner usage

Definition at line 858 of file Messages.h.

Inheritance diagram for TRM::ReserveTunerResponse:

Collaboration diagram for TRM::ReserveTunerResponse:

Public Types
typedef std::list< TunerReservation >	ReservationCT

typedef std::list< TunerReservation >	ConflictCT

Public Types inherited from TRM::ResponseBase
typedef NoResponse	ResponseType

Public Member Functions
	ReserveTunerResponse (const std::string &uuid="")

	ReserveTunerResponse (const std::string &uuid, const ResponseStatus &status, const TunerReservation &tunerReservation)

	ReserveTunerResponse (const std::string &uuid, const ResponseStatus &status, const ConflictCT &conflicts=ConflictCT())

const TunerReservation &	getTunerReservation (void) const
	This function is used to return the unique token generated when a reservation is created. This token will be used with the response message payload. More...

void	setTunerReservation (const TunerReservation &tunerReservation)
	This function is used to set the input token which will be used to uniquely identify the response message. More...

const ConflictCT &	getConflicts (void) const
	This function returns an array of existing tuner reservations that is in conflict with the requested reservation. More...

ConflictCT &	getConflicts (void)
	This function returns an array of existing tuner reservations that is in conflict with the requested reservation. More...

void	addConflict (const TunerReservation &reservation)
	This function adds a tuner reservation request to the array of existing tuner reservations that is in conflict with the requested reservation. More...

virtual void	print (void) const
	This function prints the list of tuner reservations with all the conflicts if exist. It is used for debugging purpose. More...

Public Member Functions inherited from TRM::ResponseBase
	ResponseBase (const std::string &className, const std::string &uuid, const ResponseStatus &status)

const ResponseStatus &	getStatus (void) const

ResponseStatus &	getStatus (void)

Public Member Functions inherited from TRM::MessageBase
const std::string &	getClassName (void) const

const MessageType &	getType (void) const

const std::string &	getUUID (void) const

Static Public Member Functions
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::ResponseBase
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::MessageBase
static const char *	klassName (void)

Private Attributes
TunerReservation	tunerReservation

ConflictCT	conflicts

Additional Inherited Members
Protected Member Functions inherited from TRM::MessageBase
	MessageBase (const std::string &className, MessageType type, const std::string &uuid)

Protected Attributes inherited from TRM::ResponseBase
ResponseStatus	status

Member Function Documentation

◆ getTunerReservation()

const TunerReservation& TRM::ReserveTunerResponse::getTunerReservation ( void ) const

inline

This function is used to return the unique token generated when a reservation is created. This token will be used with the response message payload.

Returns: Returns the already granted reservation token.

Definition at line 893 of file Messages.h.

◆ setTunerReservation()

void TRM::ReserveTunerResponse::setTunerReservation ( const TunerReservation & tunerReservation )

inline

This function is used to set the input token which will be used to uniquely identify the response message.

Parameters

[in] tunerReservation A unique token that the requesting device can use to make the remote tuning request.

Returns: None.

Definition at line 904 of file Messages.h.

◆ getConflicts() [1/2]

const ConflictCT& TRM::ReserveTunerResponse::getConflicts ( void ) const

inline

This function returns an array of existing tuner reservations that is in conflict with the requested reservation.

Returns: Array of conflict reservations.

Definition at line 914 of file Messages.h.

◆ getConflicts() [2/2]

ConflictCT& TRM::ReserveTunerResponse::getConflicts ( void )

inline

This function returns an array of existing tuner reservations that is in conflict with the requested reservation.

Returns: Array of conflict reservations.

Definition at line 924 of file Messages.h.

◆ addConflict()

void TRM::ReserveTunerResponse::addConflict ( const TunerReservation & reservation )

inline

This function adds a tuner reservation request to the array of existing tuner reservations that is in conflict with the requested reservation.

Parameters

[in] reservation A unique token that the requesting device can use to make the remote tuning request.

Returns: None.

Definition at line 935 of file Messages.h.

◆ print()

virtual void TRM::ReserveTunerResponse::print ( void ) const

inlinevirtual

This function prints the list of tuner reservations with all the conflicts if exist. It is used for debugging purpose.

Returns: None.

Reimplemented from TRM::ResponseBase.

Definition at line 945 of file Messages.h.

◆ TRM::ReserveTuner

class TRM::ReserveTuner

Class implementing a Tuner reservation request, the client uses this message to request, update or renew a reservation.

When renewing a reservation, the tunerReservation contains an existing reservationToken and matching values of {device, activity}

Definition at line 972 of file Messages.h.

Inheritance diagram for TRM::ReserveTuner:

Collaboration diagram for TRM::ReserveTuner:

Public Types
typedef ReserveTunerResponse	ResponseType

Public Member Functions
	ReserveTuner (const std::string &uuid, const std::string &device, const TunerReservation &tunerReservation, const std::string &resurrect="false")

virtual void	print (void) const

TunerReservation &	getTunerReservation (void)
	This function is used to return the unique token generated when a reservation is created. This token will be used when creating a reservation request message payload. More...

const TunerReservation &	getTunerReservation (void) const
	This function is used to return the unique token generated when a reservation is created. This token will be used when creating a reservation request message payload. More...

const std::string &	getResurrect (void) const
	This function is used to return the list of resurrect (dead) reservation tokens. More...

Public Member Functions inherited from TRM::RequestBase
	RequestBase (const std::string &className, const std::string &uuid, const std::string &device)

	RequestBase (const std::string &className, const std::string &uuid)

const std::string &	getDevice (void) const

Public Member Functions inherited from TRM::MessageBase
const std::string &	getClassName (void) const

const MessageType &	getType (void) const

const std::string &	getUUID (void) const

Static Public Member Functions
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::RequestBase
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::MessageBase
static const char *	klassName (void)

Private Attributes
TunerReservation	tunerReservation

std::string	resurrect

Additional Inherited Members
Protected Member Functions inherited from TRM::MessageBase
	MessageBase (const std::string &className, MessageType type, const std::string &uuid)

Protected Attributes inherited from TRM::RequestBase
std::string	device

Member Function Documentation

◆ getTunerReservation() [1/2]

TunerReservation& TRM::ReserveTuner::getTunerReservation ( void )

inline

This function is used to return the unique token generated when a reservation is created. This token will be used when creating a reservation request message payload.

If present and valid in <tunerReservation>, the existing reservation will be updated. The field should not be present in the initial ReserveTuner message.

Returns: Returns the existing reservation token.

Definition at line 1006 of file Messages.h.

◆ getTunerReservation() [2/2]

const TunerReservation& TRM::ReserveTuner::getTunerReservation ( void ) const

inline

This function is used to return the unique token generated when a reservation is created. This token will be used when creating a reservation request message payload.

If present and valid in <tunerReservation>, the existing reservation will be updated. The field should not be present in the initial ReserveTuner message.

Returns: Returns the existing reservation token.

Definition at line 1020 of file Messages.h.

◆ getResurrect()

const std::string& TRM::ReserveTuner::getResurrect ( void ) const

inline

This function is used to return the list of resurrect (dead) reservation tokens.

A resurrect token is the one which the TRM server has lost due to re-set.

Returns: Returns the array of resurrect reservation token.

Definition at line 1032 of file Messages.h.

◆ TRM::ReleaseTunerReservationResponse

class TRM::ReleaseTunerReservationResponse

Class implementing the response message payload for releasing Tuner reservation.

Definition at line 1046 of file Messages.h.

Inheritance diagram for TRM::ReleaseTunerReservationResponse:

Collaboration diagram for TRM::ReleaseTunerReservationResponse:

Public Member Functions
	ReleaseTunerReservationResponse (const std::string &uuid="", const std::string &reservationToken="")

	ReleaseTunerReservationResponse (const std::string &uuid, const ResponseStatus &status, const std::string &reservationToken, const bool &released)

bool	isReleased (void) const
	This function is used to a return the value of released flag which may be “true” or “false”, indicating if a valid token is successfully released or not. More...

void	setReleased (bool result)
	This function is used to set the value of released flag with input value. More...

Public Member Functions inherited from TRM::SimpleTRMResponse
virtual void	print (void) const

const std::string &	getReservationToken (void) const

	SimpleTRMResponse (const std::string &className, const std::string &uuid, const ResponseStatus &status, const std::string &reservationToken)

Public Member Functions inherited from TRM::ResponseBase
	ResponseBase (const std::string &className, const std::string &uuid, const ResponseStatus &status)

const ResponseStatus &	getStatus (void) const

ResponseStatus &	getStatus (void)

Public Member Functions inherited from TRM::MessageBase
const std::string &	getClassName (void) const

const MessageType &	getType (void) const

const std::string &	getUUID (void) const

Static Public Member Functions
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::SimpleTRMResponse
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::ResponseBase
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::MessageBase
static const char *	klassName (void)

Private Attributes
bool	released

Additional Inherited Members
Public Types inherited from TRM::ResponseBase
typedef NoResponse	ResponseType

Protected Member Functions inherited from TRM::MessageBase
	MessageBase (const std::string &className, MessageType type, const std::string &uuid)

Protected Attributes inherited from TRM::ResponseBase
ResponseStatus	status

Member Function Documentation

◆ isReleased()

bool TRM::ReleaseTunerReservationResponse::isReleased ( void ) const

inline

This function is used to a return the value of released flag which may be “true” or “false”, indicating if a valid token is successfully released or not.

If the token is not valid, the ResponseStatus will carry “MALFORMED_REQUEST”

Returns: Returns the value of released flag.

Return values

true	if token is released, false otherwise.

Definition at line 1072 of file Messages.h.

◆ setReleased()

void TRM::ReleaseTunerReservationResponse::setReleased ( bool result )

inline

This function is used to set the value of released flag with input value.

A true value will be supplied in response message when a valid token is released successfully.

Parameters

[in] result Boolean value used for setting the released flag.

Definition at line 1081 of file Messages.h.

◆ TRM::ReleaseTunerReservation

class TRM::ReleaseTunerReservation

Implements the message payload for releasing tuner reservation.

Generally a release request is needed if the device owner or activity has changed.

Definition at line 1094 of file Messages.h.

Inheritance diagram for TRM::ReleaseTunerReservation:

Collaboration diagram for TRM::ReleaseTunerReservation:

Public Types
typedef ReleaseTunerReservationResponse	ResponseType

Public Member Functions
	ReleaseTunerReservation (const std::string &uuid, const std::string &device, const std::string &reservationToken)

Public Member Functions inherited from TRM::SimpleTRMRequest
virtual void	print (void) const

const std::string &	getReservationToken (void) const

	SimpleTRMRequest (const std::string &className, const std::string &uuid, const std::string &device, const std::string &reservationToken)

	SimpleTRMRequest (const std::string &className, const std::string &uuid, const std::string &reservationToken)

Public Member Functions inherited from TRM::RequestBase
	RequestBase (const std::string &className, const std::string &uuid, const std::string &device)

	RequestBase (const std::string &className, const std::string &uuid)

const std::string &	getDevice (void) const

Public Member Functions inherited from TRM::MessageBase
const std::string &	getClassName (void) const

const MessageType &	getType (void) const

const std::string &	getUUID (void) const

Static Public Member Functions
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::SimpleTRMRequest
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::RequestBase
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::MessageBase
static const char *	klassName (void)

Additional Inherited Members
Protected Member Functions inherited from TRM::MessageBase
	MessageBase (const std::string &className, MessageType type, const std::string &uuid)

Protected Attributes inherited from TRM::RequestBase
std::string	device

◆ TRM::ValidateTunerReservationResponse

class TRM::ValidateTunerReservationResponse

Implements the response message payload for Tuner reservation validation requests.

Definition at line 1118 of file Messages.h.

Inheritance diagram for TRM::ValidateTunerReservationResponse:

Collaboration diagram for TRM::ValidateTunerReservationResponse:

Public Member Functions
	ValidateTunerReservationResponse (const std::string &uuid="", const std::string &reservationToken="")

	ValidateTunerReservationResponse (const std::string &uuid, const ResponseStatus &status, const std::string &reservationToken, const bool &valid)

bool	isValid (void) const
	This function returns whether the token requested is valid or not. More...

void	setValid (bool result)
	This function sets the value of 'valid' flag for a validate tuner reservation response. More...

Public Member Functions inherited from TRM::SimpleTRMResponse
virtual void	print (void) const

const std::string &	getReservationToken (void) const

	SimpleTRMResponse (const std::string &className, const std::string &uuid, const ResponseStatus &status, const std::string &reservationToken)

Public Member Functions inherited from TRM::ResponseBase
	ResponseBase (const std::string &className, const std::string &uuid, const ResponseStatus &status)

const ResponseStatus &	getStatus (void) const

ResponseStatus &	getStatus (void)

Public Member Functions inherited from TRM::MessageBase
const std::string &	getClassName (void) const

const MessageType &	getType (void) const

const std::string &	getUUID (void) const

Static Public Member Functions
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::SimpleTRMResponse
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::ResponseBase
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::MessageBase
static const char *	klassName (void)

Private Attributes
bool	valid

Additional Inherited Members
Public Types inherited from TRM::ResponseBase
typedef NoResponse	ResponseType

Protected Member Functions inherited from TRM::MessageBase
	MessageBase (const std::string &className, MessageType type, const std::string &uuid)

Protected Attributes inherited from TRM::ResponseBase
ResponseStatus	status

Member Function Documentation

◆ isValid()

bool TRM::ValidateTunerReservationResponse::isValid ( void ) const

inline

This function returns whether the token requested is valid or not.

A string of “true” or “false” indicates if the token is valid or not. The token is valid only if the reservationToken and device both match the record maintained by TRM

Returns: Returns a boolean value indicating the token is valid or not.

Definition at line 1143 of file Messages.h.

◆ setValid()

void TRM::ValidateTunerReservationResponse::setValid ( bool result )

inline

This function sets the value of 'valid' flag for a validate tuner reservation response.

A true value will be present in the "valid" field of response message if the token and device both match in the record maintained by TRM.

Parameters

[in] result Boolean value used for setting the valid flag.

Definition at line 1153 of file Messages.h.

◆ TRM::ValidateTunerReservation

class TRM::ValidateTunerReservation

Implements the message format for client to validate an existing tuner reservation.

A reservation is valid after it is created, and invalid after it is released either per client’s request or upon receiving asynchronous notification from TRM.

Definition at line 1168 of file Messages.h.

Inheritance diagram for TRM::ValidateTunerReservation:

Collaboration diagram for TRM::ValidateTunerReservation:

Public Types
typedef ValidateTunerReservationResponse	ResponseType

Public Member Functions
	ValidateTunerReservation (const std::string &uuid, const std::string &device, const std::string &reservationToken)

Public Member Functions inherited from TRM::SimpleTRMRequest
virtual void	print (void) const

const std::string &	getReservationToken (void) const

	SimpleTRMRequest (const std::string &className, const std::string &uuid, const std::string &device, const std::string &reservationToken)

	SimpleTRMRequest (const std::string &className, const std::string &uuid, const std::string &reservationToken)

Public Member Functions inherited from TRM::RequestBase
	RequestBase (const std::string &className, const std::string &uuid, const std::string &device)

	RequestBase (const std::string &className, const std::string &uuid)

const std::string &	getDevice (void) const

Public Member Functions inherited from TRM::MessageBase
const std::string &	getClassName (void) const

const MessageType &	getType (void) const

const std::string &	getUUID (void) const

Static Public Member Functions
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::SimpleTRMRequest
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::RequestBase
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::MessageBase
static const char *	klassName (void)

Additional Inherited Members
Protected Member Functions inherited from TRM::MessageBase
	MessageBase (const std::string &className, MessageType type, const std::string &uuid)

Protected Attributes inherited from TRM::RequestBase
std::string	device

◆ TRM::CancelRecordingResponse

class TRM::CancelRecordingResponse

Implements payload for a response message against cancel recording request.

Definition at line 1194 of file Messages.h.

Inheritance diagram for TRM::CancelRecordingResponse:

Collaboration diagram for TRM::CancelRecordingResponse:

Public Member Functions
	CancelRecordingResponse (const std::string &uuid="", const std::string &reservationToken="")

	CancelRecordingResponse (const std::string &uuid, const ResponseStatus &status, const std::string &reservationToken, const bool &canceled)

bool	isCanceled (void) const
	This function returns whether a recording is cancelled, this is used when preparing the response message against a cancel recording request. More...

void	setCanceled (bool result)
	This function sets the value of "cancelled" field for the response message of a cancel recording request. More...

Public Member Functions inherited from TRM::SimpleTRMResponse
virtual void	print (void) const

const std::string &	getReservationToken (void) const

	SimpleTRMResponse (const std::string &className, const std::string &uuid, const ResponseStatus &status, const std::string &reservationToken)

Public Member Functions inherited from TRM::ResponseBase
	ResponseBase (const std::string &className, const std::string &uuid, const ResponseStatus &status)

const ResponseStatus &	getStatus (void) const

ResponseStatus &	getStatus (void)

Public Member Functions inherited from TRM::MessageBase
const std::string &	getClassName (void) const

const MessageType &	getType (void) const

const std::string &	getUUID (void) const

Static Public Member Functions
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::SimpleTRMResponse
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::ResponseBase
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::MessageBase
static const char *	klassName (void)

Private Attributes
bool	canceled

Additional Inherited Members
Public Types inherited from TRM::ResponseBase
typedef NoResponse	ResponseType

Protected Member Functions inherited from TRM::MessageBase
	MessageBase (const std::string &className, MessageType type, const std::string &uuid)

Protected Attributes inherited from TRM::ResponseBase
ResponseStatus	status

Member Function Documentation

◆ isCanceled()

bool TRM::CancelRecordingResponse::isCanceled ( void ) const

inline

This function returns whether a recording is cancelled, this is used when preparing the response message against a cancel recording request.

Returns: Returns "true" if the recording is cancelled. “false” if the recording does not exist.

Definition at line 1218 of file Messages.h.

◆ setCanceled()

void TRM::CancelRecordingResponse::setCanceled ( bool result )

inline

This function sets the value of "cancelled" field for the response message of a cancel recording request.

Parameters

[in] result Boolean value used for setting the 'cancelled' flag.

Definition at line 1226 of file Messages.h.

◆ TRM::CancelRecording

class TRM::CancelRecording

Implements a message to cancel the recording.

The client uses this message to request TRM to cancel the recording associated with the supplied reservationToken. After successful cancellation of the recording, the associated token is no longer valid.

Definition at line 1241 of file Messages.h.

Inheritance diagram for TRM::CancelRecording:

Collaboration diagram for TRM::CancelRecording:

Public Types
typedef CancelRecordingResponse	ResponseType

Public Member Functions
	CancelRecording (const std::string &uuid, const std::string &reservationToken)

Public Member Functions inherited from TRM::SimpleTRMRequest
virtual void	print (void) const

const std::string &	getReservationToken (void) const

	SimpleTRMRequest (const std::string &className, const std::string &uuid, const std::string &device, const std::string &reservationToken)

	SimpleTRMRequest (const std::string &className, const std::string &uuid, const std::string &reservationToken)

Public Member Functions inherited from TRM::RequestBase
	RequestBase (const std::string &className, const std::string &uuid, const std::string &device)

	RequestBase (const std::string &className, const std::string &uuid)

const std::string &	getDevice (void) const

Public Member Functions inherited from TRM::MessageBase
const std::string &	getClassName (void) const

const MessageType &	getType (void) const

const std::string &	getUUID (void) const

Static Public Member Functions
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::SimpleTRMRequest
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::RequestBase
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::MessageBase
static const char *	klassName (void)

Additional Inherited Members
Protected Member Functions inherited from TRM::MessageBase
	MessageBase (const std::string &className, MessageType type, const std::string &uuid)

Protected Attributes inherited from TRM::RequestBase
std::string	device

◆ TRM::CancelLiveResponse

class TRM::CancelLiveResponse

Implements payload for a response message against cancel live streaming request.

Definition at line 1265 of file Messages.h.

Inheritance diagram for TRM::CancelLiveResponse:

Collaboration diagram for TRM::CancelLiveResponse:

Public Member Functions
	CancelLiveResponse (const std::string &uuid="", const std::string &reservationToken="")

	CancelLiveResponse (const std::string &uuid, const ResponseStatus &status, const std::string &reservationToken, const std::string &serviceLocator, const bool &canceled)

bool	isCanceled (void) const
	This will return whether the Live session has been cancelled, this information will be used in the response message of a cancel live streaming request. More...

void	setCanceled (bool result)
	This will update value of the "cancelled" flag which will be used in the response message of a cancel live streaming request. More...

const std::string &	getServiceLocator () const
	This function returns a string containing the service Locator which will be used while preparing response for a cancel live streaming request. More...

void	setServiceLocator (const std::string &serviceLocator)
	This function sets value of the service Locator field which will be used in the response message of a cancel live streaming request. More...

Public Member Functions inherited from TRM::SimpleTRMResponse
virtual void	print (void) const

const std::string &	getReservationToken (void) const

	SimpleTRMResponse (const std::string &className, const std::string &uuid, const ResponseStatus &status, const std::string &reservationToken)

Public Member Functions inherited from TRM::ResponseBase
	ResponseBase (const std::string &className, const std::string &uuid, const ResponseStatus &status)

const ResponseStatus &	getStatus (void) const

ResponseStatus &	getStatus (void)

Public Member Functions inherited from TRM::MessageBase
const std::string &	getClassName (void) const

const MessageType &	getType (void) const

const std::string &	getUUID (void) const

Static Public Member Functions
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::SimpleTRMResponse
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::ResponseBase
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::MessageBase
static const char *	klassName (void)

Private Attributes
bool	canceled

std::string	serviceLocator

Additional Inherited Members
Public Types inherited from TRM::ResponseBase
typedef NoResponse	ResponseType

Protected Member Functions inherited from TRM::MessageBase
	MessageBase (const std::string &className, MessageType type, const std::string &uuid)

Protected Attributes inherited from TRM::ResponseBase
ResponseStatus	status

Member Function Documentation

◆ isCanceled()

bool TRM::CancelLiveResponse::isCanceled ( void ) const

inline

This will return whether the Live session has been cancelled, this information will be used in the response message of a cancel live streaming request.

Returns: Returns true if the live streaming is cancelled, false otherwise.

Definition at line 1291 of file Messages.h.

◆ setCanceled()

void TRM::CancelLiveResponse::setCanceled ( bool result )

inline

This will update value of the "cancelled" flag which will be used in the response message of a cancel live streaming request.

Parameters

[in] result Boolean value used for setting the 'cancelled' flag.

Definition at line 1299 of file Messages.h.

◆ getServiceLocator()

const std::string& TRM::CancelLiveResponse::getServiceLocator ( ) const

inline

This function returns a string containing the service Locator which will be used while preparing response for a cancel live streaming request.

Returns: Returns the service locator string.

Definition at line 1307 of file Messages.h.

◆ setServiceLocator()

void TRM::CancelLiveResponse::setServiceLocator ( const std::string & serviceLocator )

inline

This function sets value of the service Locator field which will be used in the response message of a cancel live streaming request.

Parameters

[in] serviceLocator A string value representing the service locator (source locator).

Definition at line 1317 of file Messages.h.

◆ TRM::CancelLive

class TRM::CancelLive

Implements a message to cancel the live streaming.

The client uses this message to request TRM to cancel the live streaming session associated with the supplied reservationToken. After successful cancellation of the session, the associated token is no longer valid.

Definition at line 1334 of file Messages.h.

Inheritance diagram for TRM::CancelLive:

Collaboration diagram for TRM::CancelLive:

Public Types
typedef CancelLiveResponse	ResponseType

Public Member Functions
	CancelLive (const std::string &uuid, const std::string &serviceLocator, const std::string &reservationToken="")

const std::string &	getServiceLocator (void) const
	This function returns a string containing the service Locator which will be used while preparing the cancel live streaming request. More...

void	setServiceLocator (const std::string &serviceLocator)
	This function sets value of the service Locator field which will be used while preparing the cancel live streaming request. More...

Public Member Functions inherited from TRM::SimpleTRMRequest
virtual void	print (void) const

const std::string &	getReservationToken (void) const

	SimpleTRMRequest (const std::string &className, const std::string &uuid, const std::string &device, const std::string &reservationToken)

	SimpleTRMRequest (const std::string &className, const std::string &uuid, const std::string &reservationToken)

Public Member Functions inherited from TRM::RequestBase
	RequestBase (const std::string &className, const std::string &uuid, const std::string &device)

	RequestBase (const std::string &className, const std::string &uuid)

const std::string &	getDevice (void) const

Public Member Functions inherited from TRM::MessageBase
const std::string &	getClassName (void) const

const MessageType &	getType (void) const

const std::string &	getUUID (void) const

Static Public Member Functions
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::SimpleTRMRequest
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::RequestBase
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::MessageBase
static const char *	klassName (void)

Private Attributes
std::string	serviceLocator

Additional Inherited Members
Protected Member Functions inherited from TRM::MessageBase
	MessageBase (const std::string &className, MessageType type, const std::string &uuid)

Protected Attributes inherited from TRM::RequestBase
std::string	device

Member Function Documentation

◆ getServiceLocator()

const std::string& TRM::CancelLive::getServiceLocator ( void ) const

inline

This function returns a string containing the service Locator which will be used while preparing the cancel live streaming request.

Returns: Returns the service locator string.

Definition at line 1356 of file Messages.h.

◆ setServiceLocator()

void TRM::CancelLive::setServiceLocator ( const std::string & serviceLocator )

inline

This function sets value of the service Locator field which will be used while preparing the cancel live streaming request.

Parameters

[in] serviceLocator A string value representing the service locator (source locator).

Definition at line 1366 of file Messages.h.

◆ TRM::GetAllTunerIdsResponse

class TRM::GetAllTunerIdsResponse

Implements the response message payload against a Tuner Id request.

Definition at line 1378 of file Messages.h.

Inheritance diagram for TRM::GetAllTunerIdsResponse:

Collaboration diagram for TRM::GetAllTunerIdsResponse:

Public Member Functions
	GetAllTunerIdsResponse (const std::string &uuid="")

	GetAllTunerIdsResponse (const std::string &uuid, const ResponseStatus &status, const std::list< std::string > &tunerIds=std::list< std::string >())

const std::list< std::string > &	getTunerIds (void) const
	This function will return an array of tuner id. More...

void	addTunerId (const std::string &tid)
	This function will add a new tuner identifier to the list of tuner ID. More...

void	addTunerId (const std::list< std::string > &tid)
	This function will add a list of new tuner identifiers to existing array of tuner ID. More...

void	print (void) const

Public Member Functions inherited from TRM::SimpleTRMResponse
const std::string &	getReservationToken (void) const

	SimpleTRMResponse (const std::string &className, const std::string &uuid, const ResponseStatus &status, const std::string &reservationToken)

Public Member Functions inherited from TRM::ResponseBase
	ResponseBase (const std::string &className, const std::string &uuid, const ResponseStatus &status)

const ResponseStatus &	getStatus (void) const

ResponseStatus &	getStatus (void)

Public Member Functions inherited from TRM::MessageBase
const std::string &	getClassName (void) const

const MessageType &	getType (void) const

const std::string &	getUUID (void) const

Static Public Member Functions
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::SimpleTRMResponse
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::ResponseBase
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::MessageBase
static const char *	klassName (void)

Private Attributes
std::list< std::string >	tunerIds

Additional Inherited Members
Public Types inherited from TRM::ResponseBase
typedef NoResponse	ResponseType

Protected Member Functions inherited from TRM::MessageBase
	MessageBase (const std::string &className, MessageType type, const std::string &uuid)

Protected Attributes inherited from TRM::ResponseBase
ResponseStatus	status

Member Function Documentation

◆ getTunerIds()

const std::list<std::string>& TRM::GetAllTunerIdsResponse::getTunerIds ( void ) const

inline

This function will return an array of tuner id.

Returns: Returns an array of tuner Identifiers.

Definition at line 1399 of file Messages.h.

◆ addTunerId() [1/2]

void TRM::GetAllTunerIdsResponse::addTunerId ( const std::string & tid )

inline

This function will add a new tuner identifier to the list of tuner ID.

Parameters

[in] tid An unique tuner identifier.

Definition at line 1408 of file Messages.h.

◆ addTunerId() [2/2]

void TRM::GetAllTunerIdsResponse::addTunerId ( const std::list< std::string > & tid )

inline

This function will add a list of new tuner identifiers to existing array of tuner ID.

Parameters

[in] tid List of unique tuner identifiers.

Definition at line 1417 of file Messages.h.

◆ TRM::GetAllTunerIds

class TRM::GetAllTunerIds

Implements the message payload format for requesting the system allocated Unique Id of tuner. The ID for each tuner is guaranteed to be unique within the same target host.

Definition at line 1439 of file Messages.h.

Inheritance diagram for TRM::GetAllTunerIds:

Collaboration diagram for TRM::GetAllTunerIds:

Public Types
typedef GetAllTunerIdsResponse	ResponseType

Public Member Functions
	GetAllTunerIds (const std::string &uuid, const std::string &device="")

Public Member Functions inherited from TRM::SimpleTRMRequest
virtual void	print (void) const

const std::string &	getReservationToken (void) const

	SimpleTRMRequest (const std::string &className, const std::string &uuid, const std::string &device, const std::string &reservationToken)

	SimpleTRMRequest (const std::string &className, const std::string &uuid, const std::string &reservationToken)

Public Member Functions inherited from TRM::RequestBase
	RequestBase (const std::string &className, const std::string &uuid, const std::string &device)

	RequestBase (const std::string &className, const std::string &uuid)

const std::string &	getDevice (void) const

Public Member Functions inherited from TRM::MessageBase
const std::string &	getClassName (void) const

const MessageType &	getType (void) const

const std::string &	getUUID (void) const

Static Public Member Functions
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::SimpleTRMRequest
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::RequestBase
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::MessageBase
static const char *	klassName (void)

Additional Inherited Members
Protected Member Functions inherited from TRM::MessageBase
	MessageBase (const std::string &className, MessageType type, const std::string &uuid)

Protected Attributes inherited from TRM::RequestBase
std::string	device

◆ TRM::DetailedTunerState

class TRM::DetailedTunerState

Class for implementing the detail state information of a single tuner.

Definition at line 1463 of file Messages.h.

Collaboration diagram for TRM::DetailedTunerState:

Public Member Functions
	DetailedTunerState (const std::string &state="Free", const std::string &serviceLocator="")

const std::string	getState () const
	This function will return the detailed state for the tuner. More...

const std::string	getServiceLocator () const
	This function will Service Locator that has to be used in the Detailed State message. More...

const std::map< std::string, std::string > &	getOwners (void) const
	This function will return the Owners list in the form of activity and device. More...

const std::string	getReservedDeviceId () const
	This function will return the ReservedDeviceId for the tuner. More...

void	setReservedDeviceId (const std::string &reservedDeviceId)
	This function will set the reserved Device Id field while getting Detalied Tuner State message. More...

void	setState (const std::string &state, const std::string &serviceLocator="")
	This function sets the state attribute of the DetailedTunerState message with the input parameters such as tuner state and service Locator. More...

void	addTunerOwner (const std::string &activity, const std::string &device)
	This function will add a new device Id to the activity attribute of owners list. More...

void	print (const std::string &prefix="") const

Private Attributes
std::string	state

std::string	serviceLocator

std::map< std::string, std::string >	owners

std::string	reservedDeviceId

Friends
class	GetAllTunerStatesResponse

class	NotifyTunerStatesUpdate

std::ostream &	operator<< (std::ostream &, DetailedTunerState const &)

Member Function Documentation

◆ getState()

const std::string TRM::DetailedTunerState::getState ( ) const

inline

This function will return the detailed state for the tuner.

Returns: Returns a string value containing the detailed tuner state.

Definition at line 1474 of file Messages.h.

◆ getServiceLocator()

const std::string TRM::DetailedTunerState::getServiceLocator ( ) const

inline

This function will Service Locator that has to be used in the Detailed State message.

Returns: Returns the Service Locator string.

Definition at line 1482 of file Messages.h.

◆ getOwners()

const std::map<std::string, std::string>& TRM::DetailedTunerState::getOwners ( void ) const

inline

This function will return the Owners list in the form of activity and device.

Returns: Returns the Owners list string.

Definition at line 1490 of file Messages.h.

◆ getReservedDeviceId()

const std::string TRM::DetailedTunerState::getReservedDeviceId ( ) const

inline

This function will return the ReservedDeviceId for the tuner.

If this value is present in the detailedStates, the corresponding tuner is can only be used in the following cases.

LIVE streaming for the device represented by the reservedDeviceId.
RECORD for any recording request, regardless of the recording’s originating device

Returns: Returns the remote Device name making the request.

Definition at line 1503 of file Messages.h.

◆ setReservedDeviceId()

void TRM::DetailedTunerState::setReservedDeviceId ( const std::string & reservedDeviceId )

inline

This function will set the reserved Device Id field while getting Detalied Tuner State message.

Parameters

[in] reservedDeviceId String representing Reserved Device Id.

Definition at line 1511 of file Messages.h.

◆ setState()

void TRM::DetailedTunerState::setState	(	const std::string &	state,
		const std::string &	serviceLocator = `""`
	)

inline

This function sets the state attribute of the DetailedTunerState message with the input parameters such as tuner state and service Locator.

Parameters

[in]	state	Detailed tuner state.
[in]	serviceLocator	Service Locator (Source Locator) string.

Definition at line 1522 of file Messages.h.

◆ addTunerOwner()

void TRM::DetailedTunerState::addTunerOwner	(	const std::string &	activity,
		const std::string &	device
	)

inline

This function will add a new device Id to the activity attribute of owners list.

Parameters

[in]	activity	Tuner Activity such as "Live" or "Record"
[in]	device	The unique device identifier.

Definition at line 1533 of file Messages.h.

◆ TRM::GetAllTunerStatesResponse

class TRM::GetAllTunerStatesResponse

Implements the response payload against a Get tuner state request.

This message will ask for all tuner reservations that are valid at the time of request.

Definition at line 1563 of file Messages.h.

Inheritance diagram for TRM::GetAllTunerStatesResponse:

Collaboration diagram for TRM::GetAllTunerStatesResponse:

Public Member Functions
	GetAllTunerStatesResponse (const std::string &uuid="")

	GetAllTunerStatesResponse (const std::string &uuid, const ResponseStatus &status, const std::map< std::string, std::string > &tunerStates=std::map< std::string, std::string >())

const std::map< std::string, std::string > &	getTunerStates (void) const
	This function will return the tuner states which is an enumeration of detailed tuner states at time of request. More...

void	addTunerState (const std::string &tid, const std::string &state)
	This function will add the new state value against the specified tuner id. More...

void	print (void) const
	This function is used to print the debug information for each tuner state.

const std::map< std::string, DetailedTunerState > &	getTunerDetailedStates (void) const

void	addTunerState (const std::string &tid, const std::string &state, const std::string &serviceLocator, const std::string &reservedDeviceId)
	This function will add the detailed tuner state value against the specified tuner id. More...

void	addTunerOwner (const std::string &tid, const std::string &activity, const std::string &device)
	This function will add the supplied device to the corresponding owners activity list. More...

Public Member Functions inherited from TRM::SimpleTRMResponse
const std::string &	getReservationToken (void) const

	SimpleTRMResponse (const std::string &className, const std::string &uuid, const ResponseStatus &status, const std::string &reservationToken)

Public Member Functions inherited from TRM::ResponseBase
	ResponseBase (const std::string &className, const std::string &uuid, const ResponseStatus &status)

const ResponseStatus &	getStatus (void) const

ResponseStatus &	getStatus (void)

Public Member Functions inherited from TRM::MessageBase
const std::string &	getClassName (void) const

const MessageType &	getType (void) const

const std::string &	getUUID (void) const

Static Public Member Functions
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::SimpleTRMResponse
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::ResponseBase
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::MessageBase
static const char *	klassName (void)

Private Attributes
std::map< std::string, std::string >	tunerStates

std::map< std::string, DetailedTunerState >	tunerDetailedStates

Additional Inherited Members
Public Types inherited from TRM::ResponseBase
typedef NoResponse	ResponseType

Protected Member Functions inherited from TRM::MessageBase
	MessageBase (const std::string &className, MessageType type, const std::string &uuid)

Protected Attributes inherited from TRM::ResponseBase
ResponseStatus	status

Member Function Documentation

◆ getTunerStates()

const std::map<std::string, std::string>& TRM::GetAllTunerStatesResponse::getTunerStates ( void ) const

inline

This function will return the tuner states which is an enumeration of detailed tuner states at time of request.

Returns: Returns the list of detailed tuner states.

Definition at line 1585 of file Messages.h.

◆ addTunerState() [1/2]

void TRM::GetAllTunerStatesResponse::addTunerState	(	const std::string &	tid,
		const std::string &	state
	)

inline

This function will add the new state value against the specified tuner id.

Parameters

[in]	tid	The unique tuner identifier.
[in]	state	The new state represented as a string value.

Definition at line 1595 of file Messages.h.

◆ addTunerState() [2/2]

void TRM::GetAllTunerStatesResponse::addTunerState	(	const std::string &	tid,
		const std::string &	state,
		const std::string &	serviceLocator,
		const std::string &	reservedDeviceId
	)

inline

This function will add the detailed tuner state value against the specified tuner id.

Parameters

[in]	tid	The unique tuner identifier.
[in]	state	The new state represented as a string value.
[in]	serviceLocator	The Source Locator string.
[in]	reservedDeciceId	The remote Device making the request.

Definition at line 1634 of file Messages.h.

◆ addTunerOwner()

void TRM::GetAllTunerStatesResponse::addTunerOwner	(	const std::string &	tid,
		const std::string &	activity,
		const std::string &	device
	)

inline

This function will add the supplied device to the corresponding owners activity list.

Parameters

[in]	tid	The unique tuner identifier.
[in]	activity	Tuner activity string which may "Live", "Record", "Hybrid" etc.
[in]	device	The Remote device name.

Definition at line 1648 of file Messages.h.

◆ TRM::GetAllTunerStates

class TRM::GetAllTunerStates

Implements a request message for getting the state of all tuners in the system.

The state field indicates the activity state of a tuner, which can be one of following:

Live: the tuner is reserved for Live activity (Streaming or Playback).
Record: the tuner is reserved for Record activity.
Hybrid: the tuner is reserved for Live and Record activity.
EAS: the tuner is reserved for EAS.
Free: the Tuner is not reserved.

Definition at line 1668 of file Messages.h.

Inheritance diagram for TRM::GetAllTunerStates:

Collaboration diagram for TRM::GetAllTunerStates:

Public Types
typedef GetAllTunerStatesResponse	ResponseType

Public Member Functions
	GetAllTunerStates (const std::string &uuid, const std::string &device="")

Public Member Functions inherited from TRM::SimpleTRMRequest
virtual void	print (void) const

const std::string &	getReservationToken (void) const

	SimpleTRMRequest (const std::string &className, const std::string &uuid, const std::string &device, const std::string &reservationToken)

	SimpleTRMRequest (const std::string &className, const std::string &uuid, const std::string &reservationToken)

Public Member Functions inherited from TRM::RequestBase
	RequestBase (const std::string &className, const std::string &uuid, const std::string &device)

	RequestBase (const std::string &className, const std::string &uuid)

const std::string &	getDevice (void) const

Public Member Functions inherited from TRM::MessageBase
const std::string &	getClassName (void) const

const MessageType &	getType (void) const

const std::string &	getUUID (void) const

Static Public Member Functions
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::SimpleTRMRequest
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::RequestBase
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::MessageBase
static const char *	klassName (void)

Additional Inherited Members
Protected Member Functions inherited from TRM::MessageBase
	MessageBase (const std::string &className, MessageType type, const std::string &uuid)

Protected Attributes inherited from TRM::RequestBase
std::string	device

◆ TRM::GetAllReservationsResponse

class TRM::GetAllReservationsResponse

Implements the response message for the request to get All tuner reservation details.

Definition at line 1692 of file Messages.h.

Inheritance diagram for TRM::GetAllReservationsResponse:

Collaboration diagram for TRM::GetAllReservationsResponse:

Public Member Functions
	GetAllReservationsResponse (const std::string &uuid="")

	GetAllReservationsResponse (const std::string &uuid, const ResponseStatus &status, const std::map< std::string, std::list< TunerReservation > > &reservations=std::map< std::string, std::list< TunerReservation > >())

const std::map< std::string, std::list< TunerReservation > > &	getAllReservations (void) const

void	addTunerReservation (const std::string &tid, const TunerReservation &reservation)

Public Member Functions inherited from TRM::SimpleTRMResponse
virtual void	print (void) const

const std::string &	getReservationToken (void) const

	SimpleTRMResponse (const std::string &className, const std::string &uuid, const ResponseStatus &status, const std::string &reservationToken)

Public Member Functions inherited from TRM::ResponseBase
	ResponseBase (const std::string &className, const std::string &uuid, const ResponseStatus &status)

const ResponseStatus &	getStatus (void) const

ResponseStatus &	getStatus (void)

Public Member Functions inherited from TRM::MessageBase
const std::string &	getClassName (void) const

const MessageType &	getType (void) const

const std::string &	getUUID (void) const

Static Public Member Functions
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::SimpleTRMResponse
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::ResponseBase
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::MessageBase
static const char *	klassName (void)

Private Attributes
std::map< std::string, std::list< TunerReservation > >	reservations

Additional Inherited Members
Public Types inherited from TRM::ResponseBase
typedef NoResponse	ResponseType

Protected Member Functions inherited from TRM::MessageBase
	MessageBase (const std::string &className, MessageType type, const std::string &uuid)

Protected Attributes inherited from TRM::ResponseBase
ResponseStatus	status

◆ TRM::GetAllReservations

class TRM::GetAllReservations

Implements a request message to get reservation detail of all the tuners that are valid at that time.

Definition at line 1727 of file Messages.h.

Inheritance diagram for TRM::GetAllReservations:

Collaboration diagram for TRM::GetAllReservations:

Public Types
typedef GetAllReservationsResponse	ResponseType

Public Member Functions
	GetAllReservations (const std::string &uuid, const std::string &filterDevice)

	GetAllReservations (const std::string &uuid, const std::map< std::string, std::string > &filters)

const std::string	getFilterDevice (void) const

void	setFilterDevice (const std::string &filterDevice)

const std::string	getFilter (const std::string filterId) const

void	addFilter (const std::string &filterId, const std::string &filterValue)

const std::map< std::string, std::string >	getFilters (void) const

Public Member Functions inherited from TRM::SimpleTRMRequest
virtual void	print (void) const

const std::string &	getReservationToken (void) const

	SimpleTRMRequest (const std::string &className, const std::string &uuid, const std::string &device, const std::string &reservationToken)

	SimpleTRMRequest (const std::string &className, const std::string &uuid, const std::string &reservationToken)

Public Member Functions inherited from TRM::RequestBase
	RequestBase (const std::string &className, const std::string &uuid, const std::string &device)

	RequestBase (const std::string &className, const std::string &uuid)

const std::string &	getDevice (void) const

Public Member Functions inherited from TRM::MessageBase
const std::string &	getClassName (void) const

const MessageType &	getType (void) const

const std::string &	getUUID (void) const

Static Public Member Functions
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::SimpleTRMRequest
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::RequestBase
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::MessageBase
static const char *	klassName (void)

Private Attributes
std::string	filterDevice

std::map< std::string, std::string >	filters

Additional Inherited Members
Protected Member Functions inherited from TRM::MessageBase
	MessageBase (const std::string &className, MessageType type, const std::string &uuid)

Protected Attributes inherited from TRM::RequestBase
std::string	device

◆ TRM::GetVersionResponse

class TRM::GetVersionResponse

Implements the response message for the queries that request TRM server version.

Definition at line 1783 of file Messages.h.

Inheritance diagram for TRM::GetVersionResponse:

Collaboration diagram for TRM::GetVersionResponse:

Public Member Functions
	GetVersionResponse (const std::string &uuid="")

	GetVersionResponse (const std::string &uuid, const ResponseStatus &status, const std::string &version)

const std::string	getVersion (void) const

void	setVersion (const std::string &version)

void	print (void) const

Public Member Functions inherited from TRM::SimpleTRMResponse
const std::string &	getReservationToken (void) const

	SimpleTRMResponse (const std::string &className, const std::string &uuid, const ResponseStatus &status, const std::string &reservationToken)

Public Member Functions inherited from TRM::ResponseBase
	ResponseBase (const std::string &className, const std::string &uuid, const ResponseStatus &status)

const ResponseStatus &	getStatus (void) const

ResponseStatus &	getStatus (void)

Public Member Functions inherited from TRM::MessageBase
const std::string &	getClassName (void) const

const MessageType &	getType (void) const

const std::string &	getUUID (void) const

Static Public Member Functions
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::SimpleTRMResponse
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::ResponseBase
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::MessageBase
static const char *	klassName (void)

Private Attributes
std::string	version

Additional Inherited Members
Public Types inherited from TRM::ResponseBase
typedef NoResponse	ResponseType

Protected Member Functions inherited from TRM::MessageBase
	MessageBase (const std::string &className, MessageType type, const std::string &uuid)

Protected Attributes inherited from TRM::ResponseBase
ResponseStatus	status

◆ TRM::NotifyTunerReservationRelease

class TRM::NotifyTunerReservationRelease

Class to implement asynchronous Notification from TRM to the owner of a token that its tuner reservation has been terminated. The token is no longer valid after receiving this message.

Definition at line 1845 of file Messages.h.

Inheritance diagram for TRM::NotifyTunerReservationRelease:

Collaboration diagram for TRM::NotifyTunerReservationRelease:

Public Member Functions
	NotifyTunerReservationRelease (const std::string &uuid="")

	NotifyTunerReservationRelease (const std::string &uuid, const std::string &reservationToken, const std::string &reason)

const std::string &	getReservationToken (void) const
	This function will return the reservation token that has been terminated. More...

const std::string &	getReason (void) const
	This function will return the reason for the tuner reservation release. Reason is a message explaining why the reservation is terminated. More...

Public Member Functions inherited from TRM::NotificationBase
	NotificationBase (const std::string &className, const std::string &uuid)

virtual void	print (void) const

Public Member Functions inherited from TRM::MessageBase
const std::string &	getClassName (void) const

const MessageType &	getType (void) const

const std::string &	getUUID (void) const

Static Public Member Functions
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::NotificationBase
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::MessageBase
static const char *	klassName (void)

Private Attributes
std::string	reservationToken

std::string	reason

Additional Inherited Members
Public Types inherited from TRM::NotificationBase
typedef NoResponse	ResponseType

Protected Member Functions inherited from TRM::MessageBase
	MessageBase (const std::string &className, MessageType type, const std::string &uuid)

Member Function Documentation

◆ getReservationToken()

const std::string& TRM::NotifyTunerReservationRelease::getReservationToken ( void ) const

inline

This function will return the reservation token that has been terminated.

Returns: Returns the string value containing termination reservation token.

Definition at line 1863 of file Messages.h.

◆ getReason()

const std::string& TRM::NotifyTunerReservationRelease::getReason ( void ) const

inline

This function will return the reason for the tuner reservation release. Reason is a message explaining why the reservation is terminated.

Returns: Returns the string value containing termination reason.

Definition at line 1874 of file Messages.h.

◆ TRM::NotifyTunerReservationUpdate

class TRM::NotifyTunerReservationUpdate

Implements the asynchronous Notification from TRM whenever a reservation has changed its usage by its owner.

The Server can listen for this notification and synchronize its cached value with the new reservation. In the update message, these fields are guaranteed to be the original value associated with the reservation

Definition at line 1892 of file Messages.h.

Inheritance diagram for TRM::NotifyTunerReservationUpdate:

Collaboration diagram for TRM::NotifyTunerReservationUpdate:

Public Member Functions
	NotifyTunerReservationUpdate (const std::string &uuid="")

	NotifyTunerReservationUpdate (const std::string &uuid, const TunerReservation &updatedReservation)

const TunerReservation &	getTunerReservation (void) const
	This function will return the details of the reservation token that has been updated. More...

TunerReservation &	getTunerReservation (void)
	This function will return the details of the reservation token that has been updated. More...

void	setTunerReservation (const TunerReservation &tunerReservation)
	This function will set the value for the updated reservation token to current message instance for notification. More...

Public Member Functions inherited from TRM::NotificationBase
	NotificationBase (const std::string &className, const std::string &uuid)

virtual void	print (void) const

Public Member Functions inherited from TRM::MessageBase
const std::string &	getClassName (void) const

const MessageType &	getType (void) const

const std::string &	getUUID (void) const

Static Public Member Functions
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::NotificationBase
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::MessageBase
static const char *	klassName (void)

Private Attributes
TunerReservation	updatedReservation

Additional Inherited Members
Public Types inherited from TRM::NotificationBase
typedef NoResponse	ResponseType

Protected Member Functions inherited from TRM::MessageBase
	MessageBase (const std::string &className, MessageType type, const std::string &uuid)

Member Function Documentation

◆ getTunerReservation() [1/2]

const TunerReservation& TRM::NotifyTunerReservationUpdate::getTunerReservation ( void ) const

inline

This function will return the details of the reservation token that has been updated.

Returns: Returns the changed reservation token.

Definition at line 1911 of file Messages.h.

◆ getTunerReservation() [2/2]

TunerReservation& TRM::NotifyTunerReservationUpdate::getTunerReservation ( void )

inline

This function will return the details of the reservation token that has been updated.

Returns: Returns the changed reservation token.

Definition at line 1921 of file Messages.h.

◆ setTunerReservation()

void TRM::NotifyTunerReservationUpdate::setTunerReservation ( const TunerReservation & tunerReservation )

inline

This function will set the value for the updated reservation token to current message instance for notification.

Parameters

[in] tunerReservation The tuner reservation token that has changed.

Definition at line 1931 of file Messages.h.

◆ TRM::NotifyTunerReservationConflicts

class TRM::NotifyTunerReservationConflicts

Class for implementing asynchronous notification from TRM to the owner of a token that a tuner reservation is about to be terminated, unless the owner initiates to resolve the conflict.

Definition at line 1945 of file Messages.h.

Inheritance diagram for TRM::NotifyTunerReservationConflicts:

Collaboration diagram for TRM::NotifyTunerReservationConflicts:

Public Types
typedef std::list< TunerReservation >	ConflictCT

Public Types inherited from TRM::NotificationBase
typedef NoResponse	ResponseType

Public Member Functions
	NotifyTunerReservationConflicts (const std::string &uuid="")

	NotifyTunerReservationConflicts (const std::string &uuid, const TunerReservation &requestedReservation, const ConflictCT &conflicts=ConflictCT())

	NotifyTunerReservationConflicts (const std::string &uuid, const TunerReservation &existingLiveReservation, const TunerReservation &conflictingRecordReservation)

const TunerReservation &	getTunerReservation (void) const
	This function will return the details of the current reservation that has to be cancelled as a result of the conflict. More...

TunerReservation &	getTunerReservation (void)
	This function will return the details of the current reservation that has to be cancelled as a result of the conflict. More...

void	setTunerReservation (const TunerReservation &tunerReservation)
	This function will set the input reservation token to this instance which has to be used for the notification. More...

const ConflictCT &	getConflicts (void) const
	This function will return the array of tuner reservation conflicts. More...

ConflictCT &	getConflicts (void)
	This function will return the array of tuner reservation conflicts. More...

void	addConflict (const TunerReservation &reservation)
	This function will add a tuner reservation request to the existing list of conflicts. More...

Public Member Functions inherited from TRM::NotificationBase
	NotificationBase (const std::string &className, const std::string &uuid)

virtual void	print (void) const

Public Member Functions inherited from TRM::MessageBase
const std::string &	getClassName (void) const

const MessageType &	getType (void) const

const std::string &	getUUID (void) const

Static Public Member Functions
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::NotificationBase
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::MessageBase
static const char *	klassName (void)

Private Attributes
TunerReservation	requestedReservation

ConflictCT	conflicts

Additional Inherited Members
Protected Member Functions inherited from TRM::MessageBase
	MessageBase (const std::string &className, MessageType type, const std::string &uuid)

Member Function Documentation

◆ getTunerReservation() [1/2]

const TunerReservation& TRM::NotifyTunerReservationConflicts::getTunerReservation ( void ) const

inline

This function will return the details of the current reservation that has to be cancelled as a result of the conflict.

Returns: Returns the requested reservation token.

Definition at line 1972 of file Messages.h.

◆ getTunerReservation() [2/2]

TunerReservation& TRM::NotifyTunerReservationConflicts::getTunerReservation ( void )

inline

This function will return the details of the current reservation that has to be cancelled as a result of the conflict.

Returns: Returns the requested reservation token.

Definition at line 1982 of file Messages.h.

◆ setTunerReservation()

void TRM::NotifyTunerReservationConflicts::setTunerReservation ( const TunerReservation & tunerReservation )

inline

This function will set the input reservation token to this instance which has to be used for the notification.

Parameters

[in] tunerReservation The tuner reservation token.

Definition at line 1992 of file Messages.h.

◆ getConflicts() [1/2]

const ConflictCT& TRM::NotifyTunerReservationConflicts::getConflicts ( void ) const

inline

This function will return the array of tuner reservation conflicts.

Returns: Returns the array of conflicts.

Definition at line 2001 of file Messages.h.

◆ getConflicts() [2/2]

ConflictCT& TRM::NotifyTunerReservationConflicts::getConflicts ( void )

inline

This function will return the array of tuner reservation conflicts.

Returns: Returns the array of conflicts.

Definition at line 2010 of file Messages.h.

◆ addConflict()

void TRM::NotifyTunerReservationConflicts::addConflict ( const TunerReservation & reservation )

inline

This function will add a tuner reservation request to the existing list of conflicts.

Parameters

[in] tunerReservation The tuner reservation token.

Definition at line 2019 of file Messages.h.

◆ TRM::NotifyTunerStatesUpdate

class TRM::NotifyTunerStatesUpdate

Class for implementing an asynchronous Notification from TRM whenever a tuner has changed it state.

The TRM client can listen for this notification and keep a local cache of the tuner states.

Note: The payload represents the states when the message is generated. Tuner states could change after the message is sent.

Definition at line 2037 of file Messages.h.

Inheritance diagram for TRM::NotifyTunerStatesUpdate:

Collaboration diagram for TRM::NotifyTunerStatesUpdate:

Public Member Functions
	NotifyTunerStatesUpdate (const std::string &uuid="")

void	addTunerDetailedState (const std::string &tid, const DetailedTunerState &detailedState)
	This function adds the detail state of the tuner specified by it's unique id when a notification has to be issued after tuner has changed it's state. More...

const std::map< std::string, DetailedTunerState > &	getTunerDetailedStates (void) const
	This function returns the detailed tuner state and is used when a notification has to be sent after tuner has changed state. More...

Public Member Functions inherited from TRM::NotificationBase
	NotificationBase (const std::string &className, const std::string &uuid)

virtual void	print (void) const

Public Member Functions inherited from TRM::MessageBase
const std::string &	getClassName (void) const

const MessageType &	getType (void) const

const std::string &	getUUID (void) const

Static Public Member Functions
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::NotificationBase
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::MessageBase
static const char *	klassName (void)

Private Attributes
std::map< std::string, DetailedTunerState >	tunerDetailedStates

Additional Inherited Members
Public Types inherited from TRM::NotificationBase
typedef NoResponse	ResponseType

Protected Member Functions inherited from TRM::MessageBase
	MessageBase (const std::string &className, MessageType type, const std::string &uuid)

Member Function Documentation

◆ addTunerDetailedState()

void TRM::NotifyTunerStatesUpdate::addTunerDetailedState	(	const std::string &	tid,
		const DetailedTunerState &	detailedState
	)

inline

This function adds the detail state of the tuner specified by it's unique id when a notification has to be issued after tuner has changed it's state.

Parameters

[in]	tid	Unique identification number of tuner.
[out]	detailedState	Detailed state of the tuner.

Definition at line 2054 of file Messages.h.

◆ getTunerDetailedStates()

const std::map<std::string, DetailedTunerState>& TRM::NotifyTunerStatesUpdate::getTunerDetailedStates ( void ) const

inline

This function returns the detailed tuner state and is used when a notification has to be sent after tuner has changed state.

Returns: Returns the Detailed tuner state.

Definition at line 2064 of file Messages.h.

◆ TRM::NotifyTunerPretune

class TRM::NotifyTunerPretune

Implements a Notification message when a pre tune has performed.

Definition at line 2076 of file Messages.h.

Inheritance diagram for TRM::NotifyTunerPretune:

Collaboration diagram for TRM::NotifyTunerPretune:

Public Member Functions
	NotifyTunerPretune (const std::string &uuid="")

	NotifyTunerPretune (const std::string &uuid, const std::string &serviceLocator)

const std::string &	getServiceLocator (void) const

Public Member Functions inherited from TRM::NotificationBase
	NotificationBase (const std::string &className, const std::string &uuid)

virtual void	print (void) const

Public Member Functions inherited from TRM::MessageBase
const std::string &	getClassName (void) const

const MessageType &	getType (void) const

const std::string &	getUUID (void) const

Static Public Member Functions
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::NotificationBase
static const char *	klassName (void)

Static Public Member Functions inherited from TRM::MessageBase
static const char *	klassName (void)

Private Attributes
std::string	serviceLocator

Additional Inherited Members
Public Types inherited from TRM::NotificationBase
typedef NoResponse	ResponseType

Protected Member Functions inherited from TRM::MessageBase
	MessageBase (const std::string &className, MessageType type, const std::string &uuid)

Description

Data Structures

Data Structure Documentation

◆ TRM::ReserveTunerResponse

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Member Function Documentation

◆ getTunerReservation()

◆ setTunerReservation()

◆ getConflicts() [1/2]

◆ getConflicts() [2/2]

◆ addConflict()

◆ print()

◆ TRM::ReserveTuner

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Member Function Documentation

◆ getTunerReservation() [1/2]

◆ getTunerReservation() [2/2]

◆ getResurrect()

◆ TRM::ReleaseTunerReservationResponse

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Member Function Documentation

◆ isReleased()

◆ setReleased()

◆ TRM::ReleaseTunerReservation

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

◆ TRM::ValidateTunerReservationResponse

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Member Function Documentation

◆ isValid()

◆ setValid()

◆ TRM::ValidateTunerReservation

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

◆ TRM::CancelRecordingResponse

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Member Function Documentation

◆ isCanceled()

◆ setCanceled()

◆ TRM::CancelRecording

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

◆ TRM::CancelLiveResponse

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Member Function Documentation

◆ isCanceled()

◆ setCanceled()

◆ getServiceLocator()

◆ setServiceLocator()

◆ TRM::CancelLive

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes