C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537
Public Types | Public Member Functions | List of all members
OpcUa::PubSubStatusCallback Class Referenceabstract

Callback interface for PubSubStatus object This callback is used to forward enable and disable commands from clients to the corresponding management objects. More...

#include <opcua_pubsubstatustype.h>

Inherited by OpcUa::DataSetReaderType, OpcUa::DataSetWriterType, OpcUa::PublishSubscribeType, OpcUa::PubSubConnectionType, and OpcUa::PubSubGroupType.

Public Types

enum  PubSubStatusInternal {
  PubSubStatus_DisabledStopped = 0, PubSubStatus_DisabledStarted, PubSubStatus_Paused, PubSubStatus_Operational,
  PubSubStatus_Error
}
 Enumeration used to define State of a PubSub object. More...
 

Public Member Functions

virtual UaStatus enableObject (const ServiceContext &serviceContext)=0
 Enable command from a client. More...
 
virtual UaStatus disableObject (const ServiceContext &serviceContext)=0
 Disable command from a client. More...
 
virtual void startObject ()=0
 Start command from the parent object.
 
virtual void stopObject ()=0
 Stop command from the parent object.
 

Detailed Description

Callback interface for PubSubStatus object This callback is used to forward enable and disable commands from clients to the corresponding management objects.

Member Enumeration Documentation

enum OpcUa::PubSubStatusCallback::PubSubStatusInternal

Enumeration used to define State of a PubSub object.

Enumerator
PubSubStatus_DisabledStopped 

The object is disabled and the parent is disabled or paused.

PubSubStatus_DisabledStarted 

The object is disabled and the parent is enabled.

PubSubStatus_Paused 

The object is enabled but the parent is disabled.

PubSubStatus_Operational 

The object is operational (enabled and parent operational).

PubSubStatus_Error 

The object is eabled and started but in an error state.

Member Function Documentation

virtual UaStatus OpcUa::PubSubStatusCallback::disableObject ( const ServiceContext &  serviceContext)
pure virtual

Disable command from a client.

Parameters
[in]serviceContextGeneral context for the service calls containing information like the session object, return diagnostic mask and timeout hint.

Implemented in OpcUa::DataSetReaderType, OpcUa::PublishSubscribeType, OpcUa::DataSetWriterType, OpcUa::PubSubConnectionType, and OpcUa::PubSubGroupType.

virtual UaStatus OpcUa::PubSubStatusCallback::enableObject ( const ServiceContext &  serviceContext)
pure virtual

Enable command from a client.

Parameters
[in]serviceContextGeneral context for the service calls containing information like the session object, return diagnostic mask and timeout hint.

Implemented in OpcUa::DataSetReaderType, OpcUa::PublishSubscribeType, OpcUa::DataSetWriterType, OpcUa::PubSubConnectionType, and OpcUa::PubSubGroupType.

The documentation for this class was generated from the following files: