openDAQ
Open data acquisition platform
MirroredSignalPrivatePtr Class Reference

Internal functions used by openDAQ core. This interface should never be used in client SDK or module code. More...

Inherits ObjectPtr< IMirroredSignalPrivate >.

Detailed Description

Internal functions used by openDAQ core. This interface should never be used in client SDK or module code.

Public Member Functions

daq::Bool triggerEvent (const daq::EventPacketPtr &eventPacket) const
 Handles event packet e.g. packet with changes of the signals descriptors or signal properties. More...
 
void addStreamingSource (const daq::StreamingPtr &streaming) const
 Adds streaming source for signal. More...
 
void removeStreamingSource (const daq::StringPtr &streamingConnectionString) const
 Removes streaming source for signal. More...
 
void subscribeCompleted (const daq::StringPtr &streamingConnectionString) const
 Handles the completion of subscription acknowledged by the specified streaming source. More...
 
void unsubscribeCompleted (const daq::StringPtr &streamingConnectionString) const
 Handles the completion of unsubscription acknowledged by the specified streaming source. More...
 
void unsubscribeCompletedNoLock (const daq::StringPtr &streamingConnectionString) const
 Acts the same as unsubscribeCompleted() but does not enter a critical section. More...
 

Member Function Documentation

◆ addStreamingSource()

void addStreamingSource ( const daq::StreamingPtr &  streaming) const
inline

Adds streaming source for signal.

Parameters
streamingThe Streaming object representing the data source.

◆ removeStreamingSource()

void removeStreamingSource ( const daq::StringPtr &  streamingConnectionString) const
inline

Removes streaming source for signal.

Parameters
streamingConnectionStringThe connection string of streaming source to be removed.

◆ subscribeCompleted()

void subscribeCompleted ( const daq::StringPtr &  streamingConnectionString) const
inline

Handles the completion of subscription acknowledged by the specified streaming source.

Parameters
streamingConnectionStringThe connection string of the streaming source that completed the subscription for the signal.

◆ triggerEvent()

daq::Bool triggerEvent ( const daq::EventPacketPtr &  eventPacket) const
inline

Handles event packet e.g. packet with changes of the signals descriptors or signal properties.

Parameters
eventPacketThe event packet to be handled.
Returns
True if the eventPacket should be sent along the signal path; False otherwise.

◆ unsubscribeCompleted()

void unsubscribeCompleted ( const daq::StringPtr &  streamingConnectionString) const
inline

Handles the completion of unsubscription acknowledged by the specified streaming source.

Parameters
streamingConnectionStringThe connection string of the streaming source that completed the unsubscription for the signal.

◆ unsubscribeCompletedNoLock()

void unsubscribeCompletedNoLock ( const daq::StringPtr &  streamingConnectionString) const
inline

Acts the same as unsubscribeCompleted() but does not enter a critical section.

Parameters
streamingConnectionStringThe connection string of the streaming source that completed the unsubscription for the signal.