PubSubBase::PubSubObject Class Reference

Base class for PubSub management objects. More...

#include <pubsubobject.h>

Inherits ReferenceCounter.

Inherited by PubSubBase::DataSetReader, PubSubBase::DataSetWriter, PubSubBase::PublishedDataSet, PubSubBase::PubSubConfiguration, PubSubBase::PubSubConnection, and PubSubBase::PubSubGroup.

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

Public Member Functions
	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
virtual	~PubSubObject ()
	Destroys the PubSubObject object.

Detailed Description

Base class for PubSub management objects.

Member Enumeration Documentation

enum PubSubBase::PubSubObject::ConfigurationState

PubSub configuration object state.

Enumerator
ConfigurationState_None	No configuration.
ConfigurationState_Deleted	Object is ready for deletion.
ConfigurationState_InSyncWithStruct	Configuration in sync with current configuration structure.
ConfigurationState_New	New configuration.
ConfigurationState_Modified	The configuration is modified.

enum PubSubBase::PubSubObject::PubSubHeaderLayout

PubSub header configuration.

Enumerator
PubSubHeaderLayout_Custom	Custom configuration specific settings.
PubSubHeaderLayout_UADP_PeriodicFixed	Default configuration for peridic fixed layout DataSet messages.
PubSubHeaderLayout_UADP_Dynamic	Default configuration for dynamic layout DataSet messages.

enum PubSubBase::PubSubObject::TransportFacet

PubSub transport facet reflecting the defined TransportProfileUris.

Enumerator
TransportFacet_None	No transport facet set.
TransportFacet_PubSub_UDP_UADP	UDP transport protocol mapping with UADP message mapping.
TransportFacet_PubSub_ETH_UADP	Ethernet transport protocol mapping with UADP message mapping.
TransportFacet_PubSub_AMQP_UADP	AMQP transport protocol mapping with UADP message mapping.
TransportFacet_PubSub_MQTT_UADP	MQTT transport protocol mapping with UADP message mapping.
TransportFacet_PubSub_CUSTOM	Custom transport mapping and message mapping.

---

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

• C:/work/uasdkcpp/src/uabase/pubsubbasecpp/pubsubobject.h
• C:/work/uasdkcpp/src/uabase/pubsubbasecpp/pubsubobject.cpp