C++ Based OPC UA Client/Server/PubSub SDK
1.7.9.586
|
Wrapper class for the UA stack structure OpcUa_SessionSecurityDiagnosticsDataType. More...
#include <uasessionsecuritydiagnosticsdatatype.h>
Public Member Functions | |
UaSessionSecurityDiagnosticsDataType () | |
Constructs an instance of the class UaSessionSecurityDiagnosticsDataType with empty default values. | |
UaSessionSecurityDiagnosticsDataType (const UaSessionSecurityDiagnosticsDataType &other) | |
Constructs an instance of the class UaSessionSecurityDiagnosticsDataType with values from another UaSessionSecurityDiagnosticsDataType object. More... | |
UaSessionSecurityDiagnosticsDataType (const OpcUa_SessionSecurityDiagnosticsDataType &other) | |
Constructs an instance of the class UaSessionSecurityDiagnosticsDataType with values from another OpcUa_SessionSecurityDiagnosticsDataType structure. More... | |
UaSessionSecurityDiagnosticsDataType (const UaNodeId &sessionId, const UaString &clientUserIdOfSession, const UaStringArray &clientUserIdHistory, const UaString &authenticationMechanism, const UaString &encoding, const UaString &transportProtocol, OpcUa_MessageSecurityMode securityMode, const UaString &securityPolicyUri, const UaByteString &clientCertificate) | |
Constructs an instance of the class UaSessionSecurityDiagnosticsDataType with values provided in the constructor. | |
UaSessionSecurityDiagnosticsDataType (const UaExtensionObject &extensionObject) | |
Constructs an instance of the class UaSessionSecurityDiagnosticsDataType initialized with value from a UaExtensionObject. More... | |
UaSessionSecurityDiagnosticsDataType (const OpcUa_ExtensionObject &extensionObject) | |
Constructs an instance of the class UaSessionSecurityDiagnosticsDataType initialized with value from an OpcUa_ExtensionObject structure. More... | |
~UaSessionSecurityDiagnosticsDataType () | |
Destroys the UaSessionSecurityDiagnosticsDataType object. | |
void | clear () |
Clear the data of the UaSessionSecurityDiagnosticsDataType. More... | |
bool | operator== (const UaSessionSecurityDiagnosticsDataType &other) const |
Compare two UaSessionSecurityDiagnosticsDataType for equality. More... | |
bool | operator!= (const UaSessionSecurityDiagnosticsDataType &other) const |
Compare two UaSessionSecurityDiagnosticsDataType for inequality. More... | |
UaSessionSecurityDiagnosticsDataType & | operator= (const UaSessionSecurityDiagnosticsDataType &other) |
Assignment operator. More... | |
OpcUa_SessionSecurityDiagnosticsDataType * | copy () const |
Copy UaSessionSecurityDiagnosticsDataType data to a newly allocated OpcUa_SessionSecurityDiagnosticsDataType. More... | |
void | copyTo (OpcUa_SessionSecurityDiagnosticsDataType *pDst) const |
Copy UaSessionSecurityDiagnosticsDataType data to an existing OpcUa_SessionSecurityDiagnosticsDataType structure. More... | |
void | attach (OpcUa_SessionSecurityDiagnosticsDataType *pValue) |
Attaches to an existing OpcUa_SessionSecurityDiagnosticsDataType structure. More... | |
OpcUa_SessionSecurityDiagnosticsDataType * | detach (OpcUa_SessionSecurityDiagnosticsDataType *pDst) |
Detaches the internal SessionSecurityDiagnosticsDataType structure from this class. More... | |
UaNodeId | getSessionId () const |
Server-assigned identifier of the session. | |
UaString | getClientUserIdOfSession () const |
Name of authenticated user when creating the session. | |
void | getClientUserIdHistory (UaStringArray &clientUserIdHistory) const |
Array containing the name of the authenticated user currently active (either from creating the session or from calling the ActivateSession Service) and the history of those names. More... | |
UaString | getAuthenticationMechanism () const |
Type of authentication currently used by the session. More... | |
UaString | getEncoding () const |
Which encoding is used on the wire. More... | |
UaString | getTransportProtocol () const |
Which transport protocol is used. More... | |
OpcUa_MessageSecurityMode | getSecurityMode () const |
The message security mode used for the session. | |
UaString | getSecurityPolicyUri () const |
The name of the security policy used for the session. | |
UaByteString | getClientCertificate () const |
The application instance certificate provided by the client in the CreateSession request. | |
void | setSessionId (const UaNodeId &sessionId) |
Server-assigned identifier of the session. | |
void | setClientUserIdOfSession (const UaString &clientUserIdOfSession) |
Name of authenticated user when creating the session. | |
void | setClientUserIdHistory (const UaStringArray &clientUserIdHistory) |
Array containing the name of the authenticated user currently active (either from creating the session or from calling the ActivateSession Service) and the history of those names. More... | |
void | setAuthenticationMechanism (const UaString &authenticationMechanism) |
Type of authentication currently used by the session. More... | |
void | setEncoding (const UaString &encoding) |
Which encoding is used on the wire. More... | |
void | setTransportProtocol (const UaString &transportProtocol) |
Which transport protocol is used. More... | |
void | setSecurityMode (OpcUa_MessageSecurityMode securityMode) |
The message security mode used for the session. | |
void | setSecurityPolicyUri (const UaString &securityPolicyUri) |
The name of the security policy used for the session. | |
void | setClientCertificate (const UaByteString &clientCertificate) |
The application instance certificate provided by the client in the CreateSession request. | |
Static Public Member Functions | |
static OpcUa_SessionSecurityDiagnosticsDataType * | clone (const OpcUa_SessionSecurityDiagnosticsDataType &source) |
Copy OpcUa_SessionSecurityDiagnosticsDataType data to a newly allocated OpcUa_SessionSecurityDiagnosticsDataType. More... | |
static void | cloneTo (const OpcUa_SessionSecurityDiagnosticsDataType &source, OpcUa_SessionSecurityDiagnosticsDataType ©) |
Copy OpcUa_SessionSecurityDiagnosticsDataType data to an existing OpcUa_SessionSecurityDiagnosticsDataType structure. More... | |
Wrapper class for the UA stack structure OpcUa_SessionSecurityDiagnosticsDataType.
This class encapsulates the native OpcUa_SessionSecurityDiagnosticsDataType structure and handles memory allocation and cleanup for you. UaSessionSecurityDiagnosticsDataType uses implicit sharing to avoid needless copying and to boost the performance. Only if you modify a shared SessionSecurityDiagnosticsDataType it creates a copy for that (copy-on-write). So assigning another UaSessionSecurityDiagnosticsDataType or passing it as parameter needs constant time and is nearly as fast as assigning a pointer.
contains security-related diagnostic information about client sessions.
Because this information is security-related, it should not be made accessible to all users, but only to authorised users.
UaSessionSecurityDiagnosticsDataType::UaSessionSecurityDiagnosticsDataType | ( | const UaSessionSecurityDiagnosticsDataType & | other | ) |
Constructs an instance of the class UaSessionSecurityDiagnosticsDataType with values from another UaSessionSecurityDiagnosticsDataType object.
other | the other UaSessionSecurityDiagnosticsDataType used to initialize the object |
UaSessionSecurityDiagnosticsDataType::UaSessionSecurityDiagnosticsDataType | ( | const OpcUa_SessionSecurityDiagnosticsDataType & | other | ) |
Constructs an instance of the class UaSessionSecurityDiagnosticsDataType with values from another OpcUa_SessionSecurityDiagnosticsDataType structure.
other | the other OpcUa_SessionSecurityDiagnosticsDataType used to initialize the object |
UaSessionSecurityDiagnosticsDataType::UaSessionSecurityDiagnosticsDataType | ( | const UaExtensionObject & | extensionObject | ) |
Constructs an instance of the class UaSessionSecurityDiagnosticsDataType initialized with value from a UaExtensionObject.
extensionObject | the extension object containing the SessionSecurityDiagnosticsDataType |
UaSessionSecurityDiagnosticsDataType::UaSessionSecurityDiagnosticsDataType | ( | const OpcUa_ExtensionObject & | extensionObject | ) |
Constructs an instance of the class UaSessionSecurityDiagnosticsDataType initialized with value from an OpcUa_ExtensionObject structure.
extensionObject | the extension object containing the SessionSecurityDiagnosticsDataType |
void UaSessionSecurityDiagnosticsDataType::attach | ( | OpcUa_SessionSecurityDiagnosticsDataType * | pValue | ) |
Attaches to an existing OpcUa_SessionSecurityDiagnosticsDataType structure.
Don't manually free the attached structure afterwards, because UaSessionSecurityDiagnosticsDataType is responsible for it now.
pValue | [in] Parameter to attach to. |
void UaSessionSecurityDiagnosticsDataType::clear | ( | ) |
Clear the data of the UaSessionSecurityDiagnosticsDataType.
|
static |
Copy OpcUa_SessionSecurityDiagnosticsDataType data to a newly allocated OpcUa_SessionSecurityDiagnosticsDataType.
source | Source to clone. |
|
static |
Copy OpcUa_SessionSecurityDiagnosticsDataType data to an existing OpcUa_SessionSecurityDiagnosticsDataType structure.
source | the source of the clone operation. |
copy | the destination of the clone operation. |
OpcUa_SessionSecurityDiagnosticsDataType * UaSessionSecurityDiagnosticsDataType::copy | ( | ) | const |
Copy UaSessionSecurityDiagnosticsDataType data to a newly allocated OpcUa_SessionSecurityDiagnosticsDataType.
void UaSessionSecurityDiagnosticsDataType::copyTo | ( | OpcUa_SessionSecurityDiagnosticsDataType * | pDst | ) | const |
Copy UaSessionSecurityDiagnosticsDataType data to an existing OpcUa_SessionSecurityDiagnosticsDataType structure.
pDst | the destination of this copy operation. |
OpcUa_SessionSecurityDiagnosticsDataType * UaSessionSecurityDiagnosticsDataType::detach | ( | OpcUa_SessionSecurityDiagnosticsDataType * | pDst | ) |
Detaches the internal SessionSecurityDiagnosticsDataType structure from this class.
This way you take over the control of freeing the SessionSecurityDiagnosticsDataType data. If more than one reference exists, the data is copied to pDst instead of being detached.
pDst | [out] Pointer to an OpcUa_SessionSecurityDiagnosticsDataType structure that receives the SessionSecurityDiagnosticsDataType data. |
UaString UaSessionSecurityDiagnosticsDataType::getAuthenticationMechanism | ( | ) | const |
Type of authentication currently used by the session.
The string shall be one of the UserIdentityTokenType enum.
void UaSessionSecurityDiagnosticsDataType::getClientUserIdHistory | ( | UaStringArray & | clientUserIdHistory | ) | const |
Array containing the name of the authenticated user currently active (either from creating the session or from calling the ActivateSession Service) and the history of those names.
Each time the active user changes, an entry shall be made at the end of the array. The active user is always at the end of the array. Servers may restrict the size of this array, but shall support at least a size of 2.
UaString UaSessionSecurityDiagnosticsDataType::getEncoding | ( | ) | const |
Which encoding is used on the wire.
The string shall be “XML” or “UA Binary”.
UaString UaSessionSecurityDiagnosticsDataType::getTransportProtocol | ( | ) | const |
Which transport protocol is used.
The string shall be the scheme from the URL used to establish the session, for example “opc.tcp” or “https”.
bool UaSessionSecurityDiagnosticsDataType::operator!= | ( | const UaSessionSecurityDiagnosticsDataType & | other | ) | const |
Compare two UaSessionSecurityDiagnosticsDataType for inequality.
other | the UaSessionSecurityDiagnosticsDataType to compare with. |
UaSessionSecurityDiagnosticsDataType & UaSessionSecurityDiagnosticsDataType::operator= | ( | const UaSessionSecurityDiagnosticsDataType & | other | ) |
Assignment operator.
other | the UaSessionSecurityDiagnosticsDataType to assign. |
bool UaSessionSecurityDiagnosticsDataType::operator== | ( | const UaSessionSecurityDiagnosticsDataType & | other | ) | const |
Compare two UaSessionSecurityDiagnosticsDataType for equality.
other | the UaSessionSecurityDiagnosticsDataType to compare with. |
void UaSessionSecurityDiagnosticsDataType::setAuthenticationMechanism | ( | const UaString & | authenticationMechanism | ) |
Type of authentication currently used by the session.
The string shall be one of the UserIdentityTokenType enum.
void UaSessionSecurityDiagnosticsDataType::setClientUserIdHistory | ( | const UaStringArray & | clientUserIdHistory | ) |
Array containing the name of the authenticated user currently active (either from creating the session or from calling the ActivateSession Service) and the history of those names.
Each time the active user changes, an entry shall be made at the end of the array. The active user is always at the end of the array. Servers may restrict the size of this array, but shall support at least a size of 2.
void UaSessionSecurityDiagnosticsDataType::setEncoding | ( | const UaString & | encoding | ) |
Which encoding is used on the wire.
The string shall be “XML” or “UA Binary”.
void UaSessionSecurityDiagnosticsDataType::setTransportProtocol | ( | const UaString & | transportProtocol | ) |
Which transport protocol is used.
The string shall be the scheme from the URL used to establish the session, for example “opc.tcp” or “https”.