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...

virtual ErrCode INTERFACE_FUNC	setOwnerDevice (const DevicePtr &device)=0
	Sets the reference to the device that owns the streaming object. More...

virtual ErrCode INTERFACE_FUNC	registerStreamedClientSignals (IList *signals)=0
	Registers client signal within the streaming source of the input port it is connected to. More...

virtual ErrCode INTERFACE_FUNC	unregisterStreamedClientSignals (IList *signals)=0
	Unregisters client signal within the streaming source of the input port it is disconnected from. More...

virtual ErrCode INTERFACE_FUNC	detachRemovedInputPort (IString *inputPortRemoteId)=0
	Removes added input port 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

◆ detachRemovedInputPort()

virtual ErrCode INTERFACE_FUNC detachRemovedInputPort ( IString * inputPortRemoteId )

pure virtual

Removes added input port without removing the streaming source from it.

Parameters

inputPortRemoteId The global remote ID of the removed input port.

Return values

OPENDAQ_ERR_NOTFOUND if an input port with corresponding remote Id was not added to the Streaming.

◆ detachRemovedSignal()

virtual ErrCode INTERFACE_FUNC detachRemovedSignal ( const StringPtr & signalRemoteId )

pure virtual

Removes added signal without removing the streaming source from it.

Parameters

signalRemoteId The global remote ID of the removed signal.

Return values

OPENDAQ_ERR_NOTFOUND if a signal with corresponding remote Id was not added to the Streaming.

◆ registerStreamedClientSignals()

virtual ErrCode INTERFACE_FUNC registerStreamedClientSignals ( IList * signals )

pure virtual

Registers client signal within the streaming source of the input port it is connected to.

Parameters

signals The list of client signals to register, typically including the connected signal and its associated domain signal.

Forwarding of signal data via streaming is enabled for these signals once they are registered.

◆ setOwnerDevice()

virtual ErrCode INTERFACE_FUNC setOwnerDevice ( const DevicePtr & device )

pure virtual

Sets the reference to the device that owns the streaming object.

Parameters

device The device to which the streaming object is attached.

◆ 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

signalRemoteId	The global remote ID of the signal to be subscribed.
domainSignalRemoteId	The global remote ID of the domain signal of the signal to be subscribed.

◆ unregisterStreamedClientSignals()

virtual ErrCode INTERFACE_FUNC unregisterStreamedClientSignals ( IList * signals )

pure virtual

Unregisters client signal within the streaming source of the input port it is disconnected from.

Parameters

signals The list of client signals to unregister, typically including the disconnected signal and its associated domain signal.

Unregistered signals will not be transmitted through the streaming protocol.

◆ 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

signalRemoteId	The global remote ID of the signal to be unsubscribed.
domainSignalRemoteId	The remote global ID of the domain signal of the signal to be unsubscribed.

Detailed Description

Public Member Functions

Member Function Documentation

◆ detachRemovedInputPort()

◆ detachRemovedSignal()

◆ registerStreamedClientSignals()

◆ setOwnerDevice()

◆ subscribeSignal()

◆ unregisterStreamedClientSignals()

◆ unsubscribeSignal()