Ocean
Public Types | Protected Member Functions
Ocean::ScopedSubscriptionHandler Class Reference
Ocean Base Library

This class implements the base class for all subscription handlers. More...

Inheritance diagram for Ocean::ScopedSubscriptionHandler:

Public Types

using ScopedSubscriptionType = ScopedSubscriptionT< unsigned int, ScopedSubscriptionHandler >
 Definition of a scoped subscription object. More...
 

Protected Member Functions

ScopedSubscriptionType scopedSubscription (const unsigned int &subscriptionId, ScopedSubscriptionType::ReleaseCallbackFunction releaseCallbackFunction)
 Returns the subscription object for a given subscription id. More...
 

Detailed Description

This class implements the base class for all subscription handlers.

Member Typedef Documentation

◆ ScopedSubscriptionType

using Ocean::ScopedSubscriptionHandler::ScopedSubscriptionType = ScopedSubscriptionT<unsigned int, ScopedSubscriptionHandler>

Definition of a scoped subscription object.

Member Function Documentation

◆ scopedSubscription()

ScopedSubscriptionHandler::ScopedSubscriptionType Ocean::ScopedSubscriptionHandler::scopedSubscription ( const unsigned int &  subscriptionId,
ScopedSubscriptionType::ReleaseCallbackFunction  releaseCallbackFunction 
)
inlineprotected

Returns the subscription object for a given subscription id.

Parameters
subscriptionIdThe subscription id of the resulting subscription object
releaseCallbackFunctionThe release function of the subscription, must be valid
Returns
The subscription object
The documentation for this class was generated from the following file: