UA Bundle SDK .NET  2.2.0.255
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Groups Pages
UnifiedAutomation.UaBase.RequestHeader Class Reference

Common parameters for all requests submitted on a Session. More...

Inherits UnifiedAutomation.UaBase.IEncodeable.

Public Member Functions

 RequestHeader ()
 The default constructor. More...
 
virtual void Encode (IEncoder encoder)
 
 
virtual void Decode (IDecoder decoder)
 
 
virtual bool IsEqual (IEncodeable encodeable)
 Checks if encodeable is the same object or has the same content More...
 
virtual object Clone ()
 
 

Properties

NodeId AuthenticationToken [get, set]
 The secret Session identifier used to verify that the request is associated with the Session. The SessionAuthenticationToken type is defined in 7.29. More...
 
DateTime Timestamp [get, set]
 The time the Client sent the request. The parameter is only used for diagnostic and logging purposes in the server. More...
 
uint RequestHandle [get, set]
 A requestHandle associated with the request. This client defined handle can be used to cancel the request. It is also returned in the response. More...
 
uint ReturnDiagnostics [get, set]
 A bit mask that identifies the types of vendor-specific diagnostics to be returned in diagnosticInfo response parameters. The value of this parameter may consist of zero, one or more of the following values. No value indicates that diagnostics are not to be returned. Tabelle Each of these values is composed of two components, level and type, as described below. If none are requested, as indicated by a 0 value, or if no diagnostic information was encountered in processing of the request, then diagnostics information is not returned. Tabelle More...
 
string AuditEntryId [get, set]
 An identifier that identifies the Client’s security audit log entry associated with this request. An empty string value means that this parameter is not used. The AuditEntryId typically contains who initiated the action and from where it was initiated. The AuditEventId is included in the AuditEvent to allow human readers to correlate an Event with the initiating action. More details of the Audit mechanisms are defined in 6.2 and in Part 3. More...
 
uint TimeoutHint [get, set]
 This timeout in milliseconds is used in the Client side Communication Stack to set the timeout on a per-call base. For a Server this timeout is only a hint and can be used to cancel long running operations to free resources. If the Server detects a timeout, he can cancel the operation by sending the Service result Bad_Timeout. The Server should wait at minimum the timeout after he received the request before cancelling the operation. The value of 0 indicates no timeout. More...
 
ExtensionObject AdditionalHeader [get, set]
 Reserved for future use. Applications that do not understand the header should ignore it. More...
 
virtual ExpandedNodeId TypeId [get]
 
 
virtual ExpandedNodeId BinaryEncodingId [get]
 
 
virtual ExpandedNodeId XmlEncodingId [get]
 
 
- Properties inherited from UnifiedAutomation.UaBase.IEncodeable
ExpandedNodeId TypeId [get]
 Returns the UA type identifier for the encodable type. More...
 
ExpandedNodeId BinaryEncodingId [get]
 Returns the UA type identifier for the default binary encoding for the type. More...
 
ExpandedNodeId XmlEncodingId [get]
 Returns the UA type identifier for the default XML encoding for the type. More...
 

Detailed Description

Common parameters for all requests submitted on a Session.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.RequestHeader.RequestHeader ( )
inline

The default constructor.

Member Function Documentation

virtual bool UnifiedAutomation.UaBase.RequestHeader.IsEqual ( IEncodeable  encodeable)
inlinevirtual

Checks if encodeable is the same object or has the same content

Parameters
encodeable
Returns

Property Documentation

ExtensionObject UnifiedAutomation.UaBase.RequestHeader.AdditionalHeader
getset

Reserved for future use. Applications that do not understand the header should ignore it.

string UnifiedAutomation.UaBase.RequestHeader.AuditEntryId
getset

An identifier that identifies the Client’s security audit log entry associated with this request. An empty string value means that this parameter is not used. The AuditEntryId typically contains who initiated the action and from where it was initiated. The AuditEventId is included in the AuditEvent to allow human readers to correlate an Event with the initiating action. More details of the Audit mechanisms are defined in 6.2 and in Part 3.

NodeId UnifiedAutomation.UaBase.RequestHeader.AuthenticationToken
getset

The secret Session identifier used to verify that the request is associated with the Session. The SessionAuthenticationToken type is defined in 7.29.

uint UnifiedAutomation.UaBase.RequestHeader.RequestHandle
getset

A requestHandle associated with the request. This client defined handle can be used to cancel the request. It is also returned in the response.

uint UnifiedAutomation.UaBase.RequestHeader.ReturnDiagnostics
getset

A bit mask that identifies the types of vendor-specific diagnostics to be returned in diagnosticInfo response parameters. The value of this parameter may consist of zero, one or more of the following values. No value indicates that diagnostics are not to be returned. Tabelle Each of these values is composed of two components, level and type, as described below. If none are requested, as indicated by a 0 value, or if no diagnostic information was encountered in processing of the request, then diagnostics information is not returned. Tabelle

uint UnifiedAutomation.UaBase.RequestHeader.TimeoutHint
getset

This timeout in milliseconds is used in the Client side Communication Stack to set the timeout on a per-call base. For a Server this timeout is only a hint and can be used to cancel long running operations to free resources. If the Server detects a timeout, he can cancel the operation by sending the Service result Bad_Timeout. The Server should wait at minimum the timeout after he received the request before cancelling the operation. The value of 0 indicates no timeout.

DateTime UnifiedAutomation.UaBase.RequestHeader.Timestamp
getset

The time the Client sent the request. The parameter is only used for diagnostic and logging purposes in the server.


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