openDAQ
Open data acquisition platform
IMirroredSignalPrivate Struct Referenceabstract

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

+ Inheritance diagram for IMirroredSignalPrivate:
+ Collaboration diagram for IMirroredSignalPrivate:

Detailed Description

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

Public Member Functions

virtual ErrCode INTERFACE_FUNC triggerEvent (IEventPacket *eventPacket, Bool *forward)=0
 Handles event packet e.g. packet with changes of the signals descriptors or signal properties. More...
 
virtual ErrCode INTERFACE_FUNC addStreamingSource (IStreaming *streaming)=0
 Adds streaming source for signal. More...
 
virtual ErrCode INTERFACE_FUNC removeStreamingSource (IString *streamingConnectionString)=0
 Removes streaming source for signal. More...
 
virtual ErrCode INTERFACE_FUNC subscribeCompleted (IString *streamingConnectionString)=0
 Handles the completion of subscription acknowledged by the specified streaming source. More...
 
virtual ErrCode INTERFACE_FUNC unsubscribeCompleted (IString *streamingConnectionString)=0
 Handles the completion of unsubscription acknowledged by the specified streaming source. More...
 
virtual ErrCode INTERFACE_FUNC unsubscribeCompletedNoLock (IString *streamingConnectionString)=0
 Acts the same as unsubscribeCompleted() but does not enter a critical section. More...
 
- Public Member Functions inherited from IBaseObject
virtual ErrCode INTERFACE_FUNC borrowInterface (const IntfID &intfID, void **obj) const =0
 Returns another interface which is supported by the object without incrementing the reference count. More...
 
virtual ErrCode INTERFACE_FUNC dispose ()=0
 Disposes all references held by the object. More...
 
virtual ErrCode INTERFACE_FUNC getHashCode (SizeT *hashCode)=0
 Returns hash code of the object. More...
 
virtual ErrCode INTERFACE_FUNC equals (IBaseObject *other, Bool *equal) const =0
 Compares object to another object for equality. More...
 
virtual ErrCode INTERFACE_FUNC toString (CharPtr *str)=0
 Returns a string representation of the object. More...
 
- Public Member Functions inherited from IUnknown
virtual ErrCode INTERFACE_FUNC queryInterface (const IntfID &intfID, void **obj)=0
 Returns another interface which is supported by the object and increments the reference count. More...
 
virtual int INTERFACE_FUNC addRef ()=0
 Increments the reference count for an interface on an object. More...
 
virtual int INTERFACE_FUNC releaseRef ()=0
 Decrements the reference count for an interface on an object. More...
 

Member Function Documentation

◆ addStreamingSource()

virtual ErrCode INTERFACE_FUNC addStreamingSource ( IStreaming streaming)
pure virtual

Adds streaming source for signal.

Parameters
streamingThe Streaming object representing the data source.

◆ removeStreamingSource()

virtual ErrCode INTERFACE_FUNC removeStreamingSource ( IString streamingConnectionString)
pure virtual

Removes streaming source for signal.

Parameters
streamingConnectionStringThe connection string of streaming source to be removed.

◆ subscribeCompleted()

virtual ErrCode INTERFACE_FUNC subscribeCompleted ( IString streamingConnectionString)
pure virtual

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()

virtual ErrCode INTERFACE_FUNC triggerEvent ( IEventPacket eventPacket,
Bool *  forward 
)
pure virtual

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()

virtual ErrCode INTERFACE_FUNC unsubscribeCompleted ( IString streamingConnectionString)
pure virtual

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()

virtual ErrCode INTERFACE_FUNC unsubscribeCompletedNoLock ( IString streamingConnectionString)
pure virtual

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.