ccf::control::RecWaitRequest Class Reference

Record Wait Request class, allocated when a client submits a RecWait Request. More...

#include <recWaitRequest.hpp>

Public Member Functions
	RecWaitRequest (const std::string &rec_id, rad::cii::Request< std::shared_ptr< recif::RecWaitStatus >, std::shared_ptr< recif::RecWaitSpec >> *rec_req)
	Constructor registering the Record ID and reference to the RecWait Request handle to be able to send the response. More...
virtual	~RecWaitRequest ()
rad::cii::Request< std::shared_ptr< recif::RecWaitStatus >, std::shared_ptr< recif::RecWaitSpec > > &	GetReq ()
	Return reference to the RecWait Request handle used to send the response. More...
double	GetReqTime () const
	Get the time for when the RecWait Request was received. Used to handle the timeout specified for the request. More...
std::string	GetRecId () const
	Return the Recording ID of the associated Recording Session. More...
void	SetResponseSent ()
	Set flag indicating that a response to the associated RecWait Request has been sent. More...
bool	GetResponseSent () const
	Return true if a response to the associated RecWait Request has been sent. More...
double	GetResponseSentTime () const
	Get the time for sending the response. More...

Detailed Description

Record Wait Request class, allocated when a client submits a RecWait Request.

The class is used to handle RecWait Requests submitted during a Recording Session.

Constructor & Destructor Documentation

RecWaitRequest()

ccf::control::RecWaitRequest::RecWaitRequest	(	const std::string &	rec_id,
		rad::cii::Request< std::shared_ptr< recif::RecWaitStatus >, std::shared_ptr< recif::RecWaitSpec >> *	rec_req
	)

Constructor registering the Record ID and reference to the RecWait Request handle to be able to send the response.

~RecWaitRequest()

ccf::control::RecWaitRequest::~RecWaitRequest ( )

virtual

Member Function Documentation

GetRecId()

std::string ccf::control::RecWaitRequest::GetRecId

(

)

const

Return the Recording ID of the associated Recording Session.

GetReq()

rad::cii::Request< std::shared_ptr< recif::RecWaitStatus >, std::shared_ptr< recif::RecWaitSpec > > & ccf::control::RecWaitRequest::GetReq

(

)

Return reference to the RecWait Request handle used to send the response.

GetReqTime()

double ccf::control::RecWaitRequest::GetReqTime

(

)

const

Get the time for when the RecWait Request was received. Used to handle the timeout specified for the request.

GetResponseSent()

bool ccf::control::RecWaitRequest::GetResponseSent

(

)

const

Return true if a response to the associated RecWait Request has been sent.

GetResponseSentTime()

double ccf::control::RecWaitRequest::GetResponseSentTime

(

)

const

Get the time for sending the response.

SetResponseSent()

void ccf::control::RecWaitRequest::SetResponseSent

(

)

Set flag indicating that a response to the associated RecWait Request has been sent.

---

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

• control/src/include/ccf/control/recWaitRequest.hpp
• control/src/recWaitRequest.cpp