C++ Based OPC UA Client/Server SDK  1.5.5.355
UaSessionDiagnosticsDataType Class Reference

Wrapper class for the UA stack structure OpcUa_SessionDiagnosticsDataType. More...

#include <uasessiondiagnosticsdatatype.h>

Public Member Functions

 UaSessionDiagnosticsDataType ()
 Constructs an instance of the class UaSessionDiagnosticsDataType with empty default values.
 
 UaSessionDiagnosticsDataType (const UaSessionDiagnosticsDataType &other)
 Constructs an instance of the class UaSessionDiagnosticsDataType with values from another UaSessionDiagnosticsDataType object. More...
 
 UaSessionDiagnosticsDataType (const OpcUa_SessionDiagnosticsDataType &other)
 Constructs an instance of the class UaSessionDiagnosticsDataType with values from another OpcUa_SessionDiagnosticsDataType structure. More...
 
 UaSessionDiagnosticsDataType (const UaNodeId &sessionId, const UaString &sessionName, const UaApplicationDescription &clientDescription, const UaString &serverUri, const UaString &endpointUrl, const UaStringArray &localeIds, OpcUa_Double actualSessionTimeout, OpcUa_UInt32 maxResponseMessageSize, const UaDateTime &clientConnectionTime, const UaDateTime &clientLastContactTime, OpcUa_UInt32 currentSubscriptionsCount, OpcUa_UInt32 currentMonitoredItemsCount, OpcUa_UInt32 currentPublishRequestsInQueue, const UaServiceCounterDataType &totalRequestCount, OpcUa_UInt32 unauthorizedRequestCount, const UaServiceCounterDataType &readCount, const UaServiceCounterDataType &historyReadCount, const UaServiceCounterDataType &writeCount, const UaServiceCounterDataType &historyUpdateCount, const UaServiceCounterDataType &callCount, const UaServiceCounterDataType &createMonitoredItemsCount, const UaServiceCounterDataType &modifyMonitoredItemsCount, const UaServiceCounterDataType &setMonitoringModeCount, const UaServiceCounterDataType &setTriggeringCount, const UaServiceCounterDataType &deleteMonitoredItemsCount, const UaServiceCounterDataType &createSubscriptionCount, const UaServiceCounterDataType &modifySubscriptionCount, const UaServiceCounterDataType &setPublishingModeCount, const UaServiceCounterDataType &publishCount, const UaServiceCounterDataType &republishCount, const UaServiceCounterDataType &transferSubscriptionsCount, const UaServiceCounterDataType &deleteSubscriptionsCount, const UaServiceCounterDataType &addNodesCount, const UaServiceCounterDataType &addReferencesCount, const UaServiceCounterDataType &deleteNodesCount, const UaServiceCounterDataType &deleteReferencesCount, const UaServiceCounterDataType &browseCount, const UaServiceCounterDataType &browseNextCount, const UaServiceCounterDataType &translateBrowsePathsToNodeIdsCount, const UaServiceCounterDataType &queryFirstCount, const UaServiceCounterDataType &queryNextCount, const UaServiceCounterDataType &registerNodesCount, const UaServiceCounterDataType &unregisterNodesCount)
 Constructs an instance of the class UaSessionDiagnosticsDataType with values provided in the constructor.
 
 UaSessionDiagnosticsDataType (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaSessionDiagnosticsDataType initialized with value from a UaExtensionObject. More...
 
 UaSessionDiagnosticsDataType (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaSessionDiagnosticsDataType initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~UaSessionDiagnosticsDataType ()
 Destroys the UaSessionDiagnosticsDataType object.
 
void clear ()
 Clear the data of the UaSessionDiagnosticsDataType. More...
 
bool operator== (const UaSessionDiagnosticsDataType &other) const
 Compare two UaSessionDiagnosticsDataType for equality. More...
 
bool operator!= (const UaSessionDiagnosticsDataType &other) const
 Compare two UaSessionDiagnosticsDataType for inequality. More...
 
UaSessionDiagnosticsDataTypeoperator= (const UaSessionDiagnosticsDataType &other)
 Assignment operator. More...
 
OpcUa_SessionDiagnosticsDataTypecopy () const
 Copy UaSessionDiagnosticsDataType data to a newly allocated OpcUa_SessionDiagnosticsDataType. More...
 
void copyTo (OpcUa_SessionDiagnosticsDataType *pDst) const
 Copy UaSessionDiagnosticsDataType data to an existing OpcUa_SessionDiagnosticsDataType structure. More...
 
void attach (OpcUa_SessionDiagnosticsDataType *pValue)
 Attaches to an existing OpcUa_SessionDiagnosticsDataType structure. More...
 
OpcUa_SessionDiagnosticsDataTypedetach (OpcUa_SessionDiagnosticsDataType *pDst)
 Detaches the internal SessionDiagnosticsDataType structure from this class. More...
 
UaNodeId getSessionId () const
 Server-assigned identifier of the session.
 
UaString getSessionName () const
 The name of the session provided in the CreateSession request.
 
UaApplicationDescription getClientDescription () const
 The description provided by the client in the CreateSession request.
 
UaString getServerUri () const
 The serverUri request in the CreateSession request.
 
UaString getEndpointUrl () const
 The endpointUrl passed by the client to the CreateSession request.
 
void getLocaleIds (UaStringArray &localeIds) const
 Array of LocaleIds specified by the client in the open session call.
 
OpcUa_Double getActualSessionTimeout () const
 The requested session timeout specified by the client in the open session call.
 
OpcUa_UInt32 getMaxResponseMessageSize () const
 The maximum size for the response message sent to the client.
 
UaDateTime getClientConnectionTime () const
 The server timestamp when the client opens the session.
 
UaDateTime getClientLastContactTime () const
 The server timestamp of the last request of the client in the context of the session.
 
OpcUa_UInt32 getCurrentSubscriptionsCount () const
 The number of subscriptions currently used by the session.
 
OpcUa_UInt32 getCurrentMonitoredItemsCount () const
 The number of MonitoredItems currently used by the session.
 
OpcUa_UInt32 getCurrentPublishRequestsInQueue () const
 The number of publish timer expirations when there are data to be sent, but there are no publish requests for this session. More...
 
UaServiceCounterDataType getTotalRequestCount () const
 Counter of allServices, identifying the number of received requests of any Services on the session.
 
OpcUa_UInt32 getUnauthorizedRequestCount () const
 Counter of all Services, identifying the number of Service requests that were rejected due to authorization failure.
 
UaServiceCounterDataType getReadCount () const
 Counter of the Read Service, identifying the number of received requests of this Service on the session.
 
UaServiceCounterDataType getHistoryReadCount () const
 Counter of the HistoryRead Service, identifying the number of received requests of this Service on the session.
 
UaServiceCounterDataType getWriteCount () const
 Counter of the Write Service, identifying the number of received requests of this Service on the session.
 
UaServiceCounterDataType getHistoryUpdateCount () const
 Counter of the HistoryUpdate Service, identifying the number of received requests of this Service on the session.
 
UaServiceCounterDataType getCallCount () const
 Counter of the Call Service, identifying the number of received requests of this Service on the session.
 
UaServiceCounterDataType getCreateMonitoredItemsCount () const
 Counter of the CreateMonitoredItems Service, identifying the number of received requests of this Service on the session.
 
UaServiceCounterDataType getModifyMonitoredItemsCount () const
 Counter of the ModifyMonitoredItems Service, identifying the number of received requests of this Service on the session.
 
UaServiceCounterDataType getSetMonitoringModeCount () const
 Counter of the SetMonitoringMode Service, identifying the number of received requests of this Service on the session.
 
UaServiceCounterDataType getSetTriggeringCount () const
 Counter of the SetTriggering Service, identifying the number of received requests of this Service on the session.
 
UaServiceCounterDataType getDeleteMonitoredItemsCount () const
 Counter of the DeleteMonitoredItems Service, identifying the number of received requests of this Service on the session.
 
UaServiceCounterDataType getCreateSubscriptionCount () const
 Counter of the CreateSubscription Service, identifying the number of received requests of this Service on the session.
 
UaServiceCounterDataType getModifySubscriptionCount () const
 Counter of the ModifySubscription Service, identifying the number of received requests of this Service on the session.
 
UaServiceCounterDataType getSetPublishingModeCount () const
 Counter of the SetPublishingMode Service, identifying the number of received requests of this Service on the session.
 
UaServiceCounterDataType getPublishCount () const
 Counter of the Publish Service, identifying the number of received requests of this Service on the session.
 
UaServiceCounterDataType getRepublishCount () const
 Counter of the Republish Service, identifying the number of received requests of this Service on the session.
 
UaServiceCounterDataType getTransferSubscriptionsCount () const
 Counter of the TransferSubscriptions Service, identifying the number of received requests of this Service on the session.
 
UaServiceCounterDataType getDeleteSubscriptionsCount () const
 Counter of the DeleteSubscriptions Service, identifying the number of received requests of this Service on the session.
 
UaServiceCounterDataType getAddNodesCount () const
 Counter of the AddNodes Service, identifying the number of received requests of this Service on the session.
 
UaServiceCounterDataType getAddReferencesCount () const
 Counter of the AddReferences Service, identifying the number of received requests of this Service on the session.
 
UaServiceCounterDataType getDeleteNodesCount () const
 Counter of the DeleteNodes Service, identifying the number of received requests of this Service on the session.
 
UaServiceCounterDataType getDeleteReferencesCount () const
 Counter of the DeleteReferences Service, identifying the number of received requests of this Service on the session.
 
UaServiceCounterDataType getBrowseCount () const
 Counter of the Browse Service, identifying the number of received requests of this Service on the session.
 
UaServiceCounterDataType getBrowseNextCount () const
 Counter of the BrowseNext Service, identifying the number of received requests of this Service on the session.
 
UaServiceCounterDataType getTranslateBrowsePathsToNodeIdsCount () const
 Counter of the TranslateBrowsePathsToNodeIds Service, identifying the number of received requests of this Service on the session.
 
UaServiceCounterDataType getQueryFirstCount () const
 Counter of the QueryFirst Service, identifying the number of received requests of this Service on the session.
 
UaServiceCounterDataType getQueryNextCount () const
 Counter of the QueryNext Service, identifying the number of received requests of this Service on the session.
 
UaServiceCounterDataType getRegisterNodesCount () const
 Counter of the RegisterNodes Service, identifying the number of received requests of this Service on the session.
 
UaServiceCounterDataType getUnregisterNodesCount () const
 Counter of the UnregisterNodesService, identifying the number of received requests of this Service on the session.
 
void setSessionId (const UaNodeId &sessionId)
 Server-assigned identifier of the session.
 
void setSessionName (const UaString &sessionName)
 The name of the session provided in the CreateSession request.
 
void setClientDescription (const UaApplicationDescription &clientDescription)
 The description provided by the client in the CreateSession request.
 
void setServerUri (const UaString &serverUri)
 The serverUri request in the CreateSession request.
 
void setEndpointUrl (const UaString &endpointUrl)
 The endpointUrl passed by the client to the CreateSession request.
 
void setLocaleIds (const UaStringArray &localeIds)
 Array of LocaleIds specified by the client in the open session call.
 
void setActualSessionTimeout (OpcUa_Double actualSessionTimeout)
 The requested session timeout specified by the client in the open session call.
 
void setMaxResponseMessageSize (OpcUa_UInt32 maxResponseMessageSize)
 The maximum size for the response message sent to the client.
 
void setClientConnectionTime (const UaDateTime &clientConnectionTime)
 The server timestamp when the client opens the session.
 
void setClientLastContactTime (const UaDateTime &clientLastContactTime)
 The server timestamp of the last request of the client in the context of the session.
 
void setCurrentSubscriptionsCount (OpcUa_UInt32 currentSubscriptionsCount)
 The number of subscriptions currently used by the session.
 
void setCurrentMonitoredItemsCount (OpcUa_UInt32 currentMonitoredItemsCount)
 The number of MonitoredItems currently used by the session.
 
void setCurrentPublishRequestsInQueue (OpcUa_UInt32 currentPublishRequestsInQueue)
 The number of publish timer expirations when there are data to be sent, but there are no publish requests for this session. More...
 
void setTotalRequestCount (const UaServiceCounterDataType &totalRequestCount)
 Counter of allServices, identifying the number of received requests of any Services on the session.
 
void setUnauthorizedRequestCount (OpcUa_UInt32 unauthorizedRequestCount)
 Counter of all Services, identifying the number of Service requests that were rejected due to authorization failure.
 
void setReadCount (const UaServiceCounterDataType &readCount)
 Counter of the Read Service, identifying the number of received requests of this Service on the session.
 
void setHistoryReadCount (const UaServiceCounterDataType &historyReadCount)
 Counter of the HistoryRead Service, identifying the number of received requests of this Service on the session.
 
void setWriteCount (const UaServiceCounterDataType &writeCount)
 Counter of the Write Service, identifying the number of received requests of this Service on the session.
 
void setHistoryUpdateCount (const UaServiceCounterDataType &historyUpdateCount)
 Counter of the HistoryUpdate Service, identifying the number of received requests of this Service on the session.
 
void setCallCount (const UaServiceCounterDataType &callCount)
 Counter of the Call Service, identifying the number of received requests of this Service on the session.
 
void setCreateMonitoredItemsCount (const UaServiceCounterDataType &createMonitoredItemsCount)
 Counter of the CreateMonitoredItems Service, identifying the number of received requests of this Service on the session.
 
void setModifyMonitoredItemsCount (const UaServiceCounterDataType &modifyMonitoredItemsCount)
 Counter of the ModifyMonitoredItems Service, identifying the number of received requests of this Service on the session.
 
void setSetMonitoringModeCount (const UaServiceCounterDataType &setMonitoringModeCount)
 Counter of the SetMonitoringMode Service, identifying the number of received requests of this Service on the session.
 
void setSetTriggeringCount (const UaServiceCounterDataType &setTriggeringCount)
 Counter of the SetTriggering Service, identifying the number of received requests of this Service on the session.
 
void setDeleteMonitoredItemsCount (const UaServiceCounterDataType &deleteMonitoredItemsCount)
 Counter of the DeleteMonitoredItems Service, identifying the number of received requests of this Service on the session.
 
void setCreateSubscriptionCount (const UaServiceCounterDataType &createSubscriptionCount)
 Counter of the CreateSubscription Service, identifying the number of received requests of this Service on the session.
 
void setModifySubscriptionCount (const UaServiceCounterDataType &modifySubscriptionCount)
 Counter of the ModifySubscription Service, identifying the number of received requests of this Service on the session.
 
void setSetPublishingModeCount (const UaServiceCounterDataType &setPublishingModeCount)
 Counter of the SetPublishingMode Service, identifying the number of received requests of this Service on the session.
 
void setPublishCount (const UaServiceCounterDataType &publishCount)
 Counter of the Publish Service, identifying the number of received requests of this Service on the session.
 
void setRepublishCount (const UaServiceCounterDataType &republishCount)
 Counter of the Republish Service, identifying the number of received requests of this Service on the session.
 
void setTransferSubscriptionsCount (const UaServiceCounterDataType &transferSubscriptionsCount)
 Counter of the TransferSubscriptions Service, identifying the number of received requests of this Service on the session.
 
void setDeleteSubscriptionsCount (const UaServiceCounterDataType &deleteSubscriptionsCount)
 Counter of the DeleteSubscriptions Service, identifying the number of received requests of this Service on the session.
 
void setAddNodesCount (const UaServiceCounterDataType &addNodesCount)
 Counter of the AddNodes Service, identifying the number of received requests of this Service on the session.
 
void setAddReferencesCount (const UaServiceCounterDataType &addReferencesCount)
 Counter of the AddReferences Service, identifying the number of received requests of this Service on the session.
 
void setDeleteNodesCount (const UaServiceCounterDataType &deleteNodesCount)
 Counter of the DeleteNodes Service, identifying the number of received requests of this Service on the session.
 
void setDeleteReferencesCount (const UaServiceCounterDataType &deleteReferencesCount)
 Counter of the DeleteReferences Service, identifying the number of received requests of this Service on the session.
 
void setBrowseCount (const UaServiceCounterDataType &browseCount)
 Counter of the Browse Service, identifying the number of received requests of this Service on the session.
 
void setBrowseNextCount (const UaServiceCounterDataType &browseNextCount)
 Counter of the BrowseNext Service, identifying the number of received requests of this Service on the session.
 
void setTranslateBrowsePathsToNodeIdsCount (const UaServiceCounterDataType &translateBrowsePathsToNodeIdsCount)
 Counter of the TranslateBrowsePathsToNodeIds Service, identifying the number of received requests of this Service on the session.
 
void setQueryFirstCount (const UaServiceCounterDataType &queryFirstCount)
 Counter of the QueryFirst Service, identifying the number of received requests of this Service on the session.
 
void setQueryNextCount (const UaServiceCounterDataType &queryNextCount)
 Counter of the QueryNext Service, identifying the number of received requests of this Service on the session.
 
void setRegisterNodesCount (const UaServiceCounterDataType &registerNodesCount)
 Counter of the RegisterNodes Service, identifying the number of received requests of this Service on the session.
 
void setUnregisterNodesCount (const UaServiceCounterDataType &unregisterNodesCount)
 Counter of the UnregisterNodesService, identifying the number of received requests of this Service on the session.
 

Static Public Member Functions

static
OpcUa_SessionDiagnosticsDataType
clone (const OpcUa_SessionDiagnosticsDataType &source)
 Copy OpcUa_SessionDiagnosticsDataType data to a newly allocated OpcUa_SessionDiagnosticsDataType. More...
 
static void cloneTo (const OpcUa_SessionDiagnosticsDataType &source, OpcUa_SessionDiagnosticsDataType &copy)
 Copy OpcUa_SessionDiagnosticsDataType data to an existing OpcUa_SessionDiagnosticsDataType structure. More...
 

Detailed Description

Wrapper class for the UA stack structure OpcUa_SessionDiagnosticsDataType.

This class encapsulates the native OpcUa_SessionDiagnosticsDataType structure and handles memory allocation and cleanup for you. UaSessionDiagnosticsDataType uses implicit sharing to avoid needless copying and to boost the performance. Only if you modify a shared SessionDiagnosticsDataType it creates a copy for that (copy-on-write). So assigning another UaSessionDiagnosticsDataType or passing it as parameter needs constant time and is nearly as fast as assigning a pointer.

Contains diagnostic information about client sessions.

Most of the values represented in this structure provide information about the number of calls of a Service, the number of currently used MonitoredItems, etc. Those numbers need not provide the exact value; they need only provide the approximate number, so that the Server is not burdened with providing the exact numbers.

Constructor & Destructor Documentation

UaSessionDiagnosticsDataType::UaSessionDiagnosticsDataType ( const UaSessionDiagnosticsDataType other)

Constructs an instance of the class UaSessionDiagnosticsDataType with values from another UaSessionDiagnosticsDataType object.

Parameters
otherthe other UaSessionDiagnosticsDataType used to initialize the object
UaSessionDiagnosticsDataType::UaSessionDiagnosticsDataType ( const OpcUa_SessionDiagnosticsDataType other)

Constructs an instance of the class UaSessionDiagnosticsDataType with values from another OpcUa_SessionDiagnosticsDataType structure.

Parameters
otherthe other OpcUa_SessionDiagnosticsDataType used to initialize the object
UaSessionDiagnosticsDataType::UaSessionDiagnosticsDataType ( const UaExtensionObject extensionObject)

Constructs an instance of the class UaSessionDiagnosticsDataType initialized with value from a UaExtensionObject.

Parameters
extensionObjectthe extension object containing the SessionDiagnosticsDataType
UaSessionDiagnosticsDataType::UaSessionDiagnosticsDataType ( const OpcUa_ExtensionObject extensionObject)

Constructs an instance of the class UaSessionDiagnosticsDataType initialized with value from an OpcUa_ExtensionObject structure.

Parameters
extensionObjectthe extension object containing the SessionDiagnosticsDataType

Member Function Documentation

void UaSessionDiagnosticsDataType::attach ( OpcUa_SessionDiagnosticsDataType pValue)

Attaches to an existing OpcUa_SessionDiagnosticsDataType structure.

Don't manually free the attached structure afterwards, because UaSessionDiagnosticsDataType is responsible for it now.

Parameters
pValue[in] Parameter to attach to.
void UaSessionDiagnosticsDataType::clear ( )

Clear the data of the UaSessionDiagnosticsDataType.

OpcUa_SessionDiagnosticsDataType * UaSessionDiagnosticsDataType::clone ( const OpcUa_SessionDiagnosticsDataType source)
static

Copy OpcUa_SessionDiagnosticsDataType data to a newly allocated OpcUa_SessionDiagnosticsDataType.

Parameters
sourceSource to clone.
Returns
pointer to a newly allocated OpcUa_SessionDiagnosticsDataType.
void UaSessionDiagnosticsDataType::cloneTo ( const OpcUa_SessionDiagnosticsDataType source,
OpcUa_SessionDiagnosticsDataType copy 
)
static

Copy OpcUa_SessionDiagnosticsDataType data to an existing OpcUa_SessionDiagnosticsDataType structure.

Parameters
sourcethe source of the clone operation.
copythe destination of the clone operation.
OpcUa_SessionDiagnosticsDataType * UaSessionDiagnosticsDataType::copy ( ) const

Copy UaSessionDiagnosticsDataType data to a newly allocated OpcUa_SessionDiagnosticsDataType.

Returns
pointer to a newly allocated OpcUa_SessionDiagnosticsDataType.
void UaSessionDiagnosticsDataType::copyTo ( OpcUa_SessionDiagnosticsDataType pDst) const

Copy UaSessionDiagnosticsDataType data to an existing OpcUa_SessionDiagnosticsDataType structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_SessionDiagnosticsDataType * UaSessionDiagnosticsDataType::detach ( OpcUa_SessionDiagnosticsDataType pDst)

Detaches the internal SessionDiagnosticsDataType structure from this class.

This way you take over the control of freeing the SessionDiagnosticsDataType data. If more than one reference exists, the data is copied to pDst instead of being detached.

Parameters
pDst[out] Pointer to an OpcUa_SessionDiagnosticsDataType structure that receives the SessionDiagnosticsDataType data.
Returns
If the function succeeds, pDst is returned, otherwise 0 is returned.
OpcUa_UInt32 UaSessionDiagnosticsDataType::getCurrentPublishRequestsInQueue ( ) const

The number of publish timer expirations when there are data to be sent, but there are no publish requests for this session.

The value shall be 0 if there are no data to be sent or publish requests queued.

bool UaSessionDiagnosticsDataType::operator!= ( const UaSessionDiagnosticsDataType other) const

Compare two UaSessionDiagnosticsDataType for inequality.

See also
operator==
Parameters
otherthe UaSessionDiagnosticsDataType to compare with.
Returns
true if not equal, false otherwise.
UaSessionDiagnosticsDataType & UaSessionDiagnosticsDataType::operator= ( const UaSessionDiagnosticsDataType other)

Assignment operator.

Parameters
otherthe UaSessionDiagnosticsDataType to assign.
Returns
reference to itself.
bool UaSessionDiagnosticsDataType::operator== ( const UaSessionDiagnosticsDataType other) const

Compare two UaSessionDiagnosticsDataType for equality.

Parameters
otherthe UaSessionDiagnosticsDataType to compare with.
Returns
true if equal, false if not.
void UaSessionDiagnosticsDataType::setCurrentPublishRequestsInQueue ( OpcUa_UInt32  currentPublishRequestsInQueue)

The number of publish timer expirations when there are data to be sent, but there are no publish requests for this session.

The value shall be 0 if there are no data to be sent or publish requests queued.


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