IConnectionStatusContainerPrivate Struct Reference

Provides access to private methods for managing the Device's connection statuses. More...

Inheritance diagram for IConnectionStatusContainerPrivate:

Collaboration diagram for IConnectionStatusContainerPrivate:

Detailed Description

Provides access to private methods for managing the Device's connection statuses.

Enables adding, removing, and updating statuses stored in the connection status container. Statuses are identified by unique connection strings and can be accessed via IComponentStatusContainer using name aliases. A configuration status, accessible via alias "ConfigurationStatus", is unique per container and cannot be removed if added.

On the other hand, multiple streaming statuses are supported, one per each streaming source attached to the device. Aliases for these follow the pattern "StreamingStatus_n," with optional protocol-based prefixes (e.g., "OpenDAQNativeStreamingStatus_1", "OpenDAQLTStreamingStatus_2", "StreamingStatus_3" etc.).

"ConnectionStatusChanged" Core events are triggered whenever there is a change in the connection status of the openDAQ Device, including parameters such as status name alias, value, protocol type, connection string, and streaming object (nullptr for configuration statuses). Removing streaming statuses also triggers said Core event with "Removed" as the value and nullptr for the streaming object parameters.

Public Member Functions
virtual ErrCode INTERFACE_FUNC	addConfigurationConnectionStatus (IString *connectionString, IEnumeration *initialValue)=0
	Adds a new configuration connection status with the specified connection string and initial value. More...
virtual ErrCode INTERFACE_FUNC	addStreamingConnectionStatus (IString *connectionString, IEnumeration *initialValue, IStreaming *streamingObject)=0
	Adds a new streaming connection status with the specified connection string, initial value, and streaming object. More...
virtual ErrCode INTERFACE_FUNC	removeStreamingConnectionStatus (IString *connectionString)=0
	Removes a streaming connection status associated with the specified connection string. More...
virtual ErrCode INTERFACE_FUNC	updateConnectionStatus (IString *connectionString, IEnumeration *value, IStreaming *streamingObject)=0
	Updates the value of an existing connection status. More...
virtual ErrCode INTERFACE_FUNC	updateConnectionStatusWithMessage (IString *connectionString, IEnumeration *value, IStreaming *streamingObject, IString *message)=0
	Updates the value of an existing connection status with a message. 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

addConfigurationConnectionStatus()

virtual ErrCode INTERFACE_FUNC addConfigurationConnectionStatus ( IString *  connectionString, IEnumeration *  initialValue  )

pure virtual

Adds a new configuration connection status with the specified connection string and initial value.

Parameters

connectionString	The connection string identifying the status.
initialValue	The initial value of the status.

addStreamingConnectionStatus()

virtual ErrCode INTERFACE_FUNC addStreamingConnectionStatus ( IString *  connectionString, IEnumeration *  initialValue, IStreaming *  streamingObject  )

pure virtual

Adds a new streaming connection status with the specified connection string, initial value, and streaming object.

Parameters

connectionString	The connection string identifying the status.
initialValue	The initial value of the status.
streamingObject	The streaming object associated with the status.

removeStreamingConnectionStatus()

virtual ErrCode INTERFACE_FUNC removeStreamingConnectionStatus ( IString *  connectionString )

pure virtual

Removes a streaming connection status associated with the specified connection string.

Parameters

connectionString

The connection string identifying the status to remove.

updateConnectionStatus()

virtual ErrCode INTERFACE_FUNC updateConnectionStatus ( IString *  connectionString, IEnumeration *  value, IStreaming *  streamingObject  )

pure virtual

Updates the value of an existing connection status.

Parameters

connectionString	The connection string identifying the status to update.
value	The new value of the status.
streamingObject	The streaming object associated with the connection, used in triggered Core events. Set to nullptr for configuration connections.

updateConnectionStatusWithMessage()

virtual ErrCode INTERFACE_FUNC updateConnectionStatusWithMessage ( IString *  connectionString, IEnumeration *  value, IStreaming *  streamingObject, IString *  message  )

pure virtual

Updates the value of an existing connection status with a message.

Parameters

connectionString	The connection string identifying the status to update.
value	The new value of the status.
streamingObject	The streaming object associated with the connection, used in triggered Core events. Set to nullptr for configuration connections.
message	The new message of the connection status. Usually describes last reconnect attempt failure.