Management object for ReaderGroups. More...

#include <readergroup.h>

Public Member Functions
UaStatus	startUp ()
	Start up the ReaderGroup object.

UaStatus	shutDown ()
	Shut down the ReaderGroup object.

OpcUa_MessageSecurityMode	securityMode () const
	Returns the security mode setting for the ReaderGroup.

void	setSecurityMode (OpcUa_MessageSecurityMode securityMode)
	Set the security mode for the ReaderGroup. More...

DataSetReader *	addDataSetReader (OpcUa_WriterGroupDataType pWriterGroup, OpcUa_DataSetWriterDataType pDataSetWriter, OpcUa_DataSetMetaDataType *pDataSetMetaData)
	Adds a DataSetReader to the ReaderGroup.

DataSetReader *	addDataSetReader (const UaString &name, bool enabled, const UaVariant &publisherId, OpcUa_Double messageReceiveTimeout, OpcUa_Double receiveOffset, OpcUa_Double processingOffset, OpcUa_WriterGroupDataType pWriterGroup, OpcUa_DataSetWriterDataType pDataSetWriter, OpcUa_DataSetMetaDataType *pDataSetMetaData)
	Adds a DataSetReader to the ReaderGroup.

DataSetReader *	addDataSetReader (const UaDataSetReaderDataType &dataSetReader)
	Adds a DataSetReader with passed configuration structure. More...

DataSetReader *	addDataSetReader (const OpcUa_DataSetReaderDataType &dataSetReader)
	Adds a DataSetReader with passed configuration structure. More...

OpcUa_UInt32	dataSetReaderCount () const
	Returns the number of DataSetReaders.

DataSetReader *	getDataSetReader (OpcUa_UInt32 index)
	Returns the DataSetReader at index or NULL if index is outside the valid range.

UaStatus	removeDataSetReader (DataSetReader *pDataSetReader)
	Removes the passed DataSetReader.

Public Member Functions inherited from PubSubBase::PubSubGroup
	PubSubGroup (PubSubResources *pPubSubResources, TransportFacet transportFacet, ConfigurationState configurationState)
	Creates an instance of the PubSubGroup.

Public Member Functions inherited from PubSubBase::PubSubObject
	PubSubObject (PubSubResources *pPubSubResources, TransportFacet transportFacet, ConfigurationState configurationState)
	Creates an instance of the PubSubObject.

UaMutex *	pConfigMutex () const
	Get the shared mutex for the complete configuration.

void	incrementErrorCounter ()
	Increments the error counter for the PubSub object.

void	decrementErrorCounter ()
	Decrements the error counter for the PubSub object.

Public Member Functions inherited from ReferenceCounter
	ReferenceCounter ()
	construction

virtual	~ReferenceCounter ()
	destruction

Protected Member Functions
	ReaderGroup (PubSubConnection pParent, OpcUa_ReaderGroupDataType pConfigData, OpcUa_UInt32 configIndex, OpcUa_Int32 stackHandle)
	Creates an instance of the ReaderGroup from central configuration structure tree. More...

	ReaderGroup (PubSubConnection pParent, OpcUa_ReaderGroupDataType pConfigData)
	Creates an instance of the ReaderGroup with new structure. More...

virtual	~ReaderGroup ()
	Destroys the ReaderGroup object.

Protected Member Functions inherited from PubSubBase::PubSubGroup
virtual	~PubSubGroup ()
	Destroys the PubSubGroup object.

Protected Member Functions inherited from PubSubBase::PubSubObject
virtual	~PubSubObject ()
	Destroys the PubSubObject object.

Additional Inherited Members
Public Types inherited from PubSubBase::PubSubObject
enum	PubSubObjectType
	PubSub transport facet reflecting the defined TransportProfileUris.

enum	TransportFacet { TransportFacet_None = 0x0, TransportFacet_PubSub_UDP_UADP = 0x11, TransportFacet_PubSub_ETH_UADP = 0x21, TransportFacet_PubSub_AMQP_UADP = 0x31, TransportFacet_PubSub_MQTT_UADP = 0x41, TransportFacet_PubSub_CUSTOM = 0xFF }
	PubSub transport facet reflecting the defined TransportProfileUris. More...

enum	ConfigurationState { ConfigurationState_None, ConfigurationState_Deleted, ConfigurationState_InSyncWithStruct, ConfigurationState_New, ConfigurationState_Modified }
	PubSub configuration object state. More...

enum	PubSubHeaderLayout { PubSubHeaderLayout_Custom, PubSubHeaderLayout_UADP_PeriodicFixed, PubSubHeaderLayout_UADP_Dynamic }
	PubSub header configuration. More...

Detailed Description

Management object for ReaderGroups.

Constructor & Destructor Documentation

PubSubBase::ReaderGroup::ReaderGroup	(	PubSubConnection *	pParent,
		OpcUa_ReaderGroupDataType *	pConfigData,
		OpcUa_UInt32	configIndex,
		OpcUa_Int32	stackHandle
	)

protected

Creates an instance of the ReaderGroup from central configuration structure tree.

Parameters

[in]	pParent	Parent connection
[in]	pConfigData	Configuration structure for the ReaderGroup
[in]	configIndex	Index of the structure in the list of reader groups in a connection
[in]	stackHandle	Handle of the ReaderGroup in the stack. PUBSUB_INVALID_STACKHANDLE if no corresponding stack object exists.

PubSubBase::ReaderGroup::ReaderGroup	(	PubSubConnection *	pParent,
		OpcUa_ReaderGroupDataType *	pConfigData
	)

protected

Creates an instance of the ReaderGroup with new structure.

Parameters

[in]	pParent	Parent connection
[in]	pConfigData	Configuration structure for the ReaderGroup

Member Function Documentation

DataSetReader * PubSubBase::ReaderGroup::addDataSetReader ( const UaDataSetReaderDataType & dataSetReader )

Adds a DataSetReader with passed configuration structure.

Parameters

[in] dataSetReader DataSetReader configuration structure

DataSetReader * PubSubBase::ReaderGroup::addDataSetReader ( const OpcUa_DataSetReaderDataType & dataSetReader )

Adds a DataSetReader with passed configuration structure.

Parameters

[in] dataSetReader DataSetReader configuration structure

void PubSubBase::ReaderGroup::setSecurityMode ( OpcUa_MessageSecurityMode securityMode )

Set the security mode for the ReaderGroup.

If the security mode is None or Invalid, the SecurityGroupId and the SecurityKeyServices are set to null.

If the security mode is Invalid, it is set to None.

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

C:/work/uasdkcpp/src/uabase/pubsubbasecpp/readergroup.h
C:/work/uasdkcpp/src/uabase/pubsubbasecpp/readergroup.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation