rtctk::componentFramework::RepositorySubscriberIf::UnsubscribeRequest Class Reference

A request object to pass information about datapoints to unsubscribe from. More...

#include <rtctk/componentFramework/repositorySubscriberIf.hpp>

Classes
class	Parameters
	A structure to hold the arguments passed with one of the Add methods. More...

Public Member Functions
void	AddRemovedHandler (const DataPointPath &path)
	Adds a request to unsubscribe from removal notifications.
void	AddNewValueHandler (const DataPointPath &path)
	Adds a request to unsubscribe from new value notifications for a datapoint.
const std::vector< Parameters > &	GetParams () const

Detailed Description

A request object to pass information about datapoints to unsubscribe from.

Thread Safety

thread-compatible

Deprecated

Use BatchRequest instead.

Member Function Documentation

AddNewValueHandler()

void rtctk::componentFramework::RepositorySubscriberIf::UnsubscribeRequest::AddNewValueHandler

(

const DataPointPath &

path

)

Adds a request to unsubscribe from new value notifications for a datapoint.

Once the request has been sent with the SendUnsubscribeRequest method and it completes, i.e. the Responce::Wait method returns, new values will no longer be received for the indicated datapoint.

Parameters

[in]

path

The path of the datapoint to unsubscribe from.

Thread Safety

❗thread-hostile❗ – Intended to be used in one thread only.

Exception Safety

basic

AddRemovedHandler()

void rtctk::componentFramework::RepositorySubscriberIf::UnsubscribeRequest::AddRemovedHandler

(

const DataPointPath &

path

)

Adds a request to unsubscribe from removal notifications.

Once the request has been sent with the SendUnsubscribeRequest method and it completes, i.e. the Responce::Wait method returns, no further notifications will be received that a datapoint has been removed.

Parameters

[in]

path

The path of the datapoint to unsubscribe from.

Thread Safety

❗thread-hostile❗ – Intended to be used in one thread only.

Exception Safety

basic

GetParams()

const std::vector< Parameters > & rtctk::componentFramework::RepositorySubscriberIf::UnsubscribeRequest::GetParams ( ) const

inline

---

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

• componentFramework/services/common/src/include/rtctk/componentFramework/repositorySubscriberIf.hpp
• componentFramework/services/common/src/repositorySubscriberIf.cpp