openDAQ
Open data acquisition platform
IStreamingPrivate Struct Referenceabstract

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

+ Inheritance diagram for IStreamingPrivate:
+ Collaboration diagram for IStreamingPrivate:

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 subscribeSignal (const StringPtr &signalRemoteId, const StringPtr &domainSignalRemoteId)=0
 Enables delivering packets from server to client for signal via the streaming. More...
 
virtual ErrCode INTERFACE_FUNC unsubscribeSignal (const StringPtr &signalRemoteId, const StringPtr &domainSignalRemoteId)=0
 Disables delivering packets from server to client for signal via the streaming. More...
 
virtual ErrCode INTERFACE_FUNC detachRemovedSignal (const StringPtr &signalRemoteId)=0
 Removes added signal without removing the streaming source from it. 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

◆ detachRemovedSignal()

virtual ErrCode INTERFACE_FUNC detachRemovedSignal ( const StringPtr signalRemoteId)
pure virtual

Removes added signal without removing the streaming source from it.

Parameters
signalRemoteIdThe global remote ID of the removed signal.
Return values
OPENDAQ_ERR_NOTFOUNDif a signal with corresponding remote Id was not added to the Streaming.

◆ subscribeSignal()

virtual ErrCode INTERFACE_FUNC subscribeSignal ( const StringPtr signalRemoteId,
const StringPtr domainSignalRemoteId 
)
pure virtual

Enables delivering packets from server to client for signal via the streaming.

Parameters
signalRemoteIdThe global remote ID of the signal to be subscribed.
domainSignalRemoteIdThe global remote ID of the domain signal of the signal to be subscribed.

◆ unsubscribeSignal()

virtual ErrCode INTERFACE_FUNC unsubscribeSignal ( const StringPtr signalRemoteId,
const StringPtr domainSignalRemoteId 
)
pure virtual

Disables delivering packets from server to client for signal via the streaming.

Parameters
signalRemoteIdThe global remote ID of the signal to be unsubscribed.
domainSignalRemoteIdThe remote global ID of the domain signal of the signal to be unsubscribed.