C++ Based OPC UA Client/Server SDK
1.5.5.355
|
Wrapper class for the UA stack structure OpcUa_EndpointDescription. More...
#include <uaendpointdescription.h>
Public Member Functions | |
UaEndpointDescription () | |
Constructs an instance of the class UaEndpointDescription with empty default values. | |
UaEndpointDescription (const UaEndpointDescription &other) | |
Constructs an instance of the class UaEndpointDescription with values from another UaEndpointDescription object. More... | |
UaEndpointDescription (const OpcUa_EndpointDescription &other) | |
Constructs an instance of the class UaEndpointDescription with values from another OpcUa_EndpointDescription structure. More... | |
UaEndpointDescription (const UaString &endpointUrl, const UaApplicationDescription &server, const UaByteString &serverCertificate, OpcUa_MessageSecurityMode securityMode, const UaString &securityPolicyUri, const UaUserTokenPolicys &userIdentityTokens, const UaString &transportProfileUri, OpcUa_Byte securityLevel) | |
Constructs an instance of the class UaEndpointDescription with values provided in the constructor. | |
UaEndpointDescription (const UaExtensionObject &extensionObject) | |
Constructs an instance of the class UaEndpointDescription initialized with value from a UaExtensionObject. More... | |
UaEndpointDescription (const OpcUa_ExtensionObject &extensionObject) | |
Constructs an instance of the class UaEndpointDescription initialized with value from an OpcUa_ExtensionObject structure. More... | |
~UaEndpointDescription () | |
Destroys the UaEndpointDescription object. | |
void | clear () |
Clear the data of the UaEndpointDescription. More... | |
bool | operator== (const UaEndpointDescription &other) const |
Compare two UaEndpointDescription for equality. More... | |
bool | operator!= (const UaEndpointDescription &other) const |
Compare two UaEndpointDescription for inequality. More... | |
UaEndpointDescription & | operator= (const UaEndpointDescription &other) |
Assignment operator. More... | |
OpcUa_EndpointDescription * | copy () const |
Copy UaEndpointDescription data to a newly allocated OpcUa_EndpointDescription. More... | |
void | copyTo (OpcUa_EndpointDescription *pDst) const |
Copy UaEndpointDescription data to an existing OpcUa_EndpointDescription structure. More... | |
void | attach (OpcUa_EndpointDescription *pValue) |
Attaches to an existing OpcUa_EndpointDescription structure. More... | |
OpcUa_EndpointDescription * | detach (OpcUa_EndpointDescription *pDst) |
Detaches the internal EndpointDescription structure from this class. More... | |
UaString | getEndpointUrl () const |
The URL for the Endpoint described. | |
UaApplicationDescription | getServer () const |
The description for the Server that the Endpoint belongs to. | |
UaByteString | getServerCertificate () const |
The application instance Certificate issued to the Server. | |
OpcUa_MessageSecurityMode | getSecurityMode () const |
The type of security to apply to the messages. More... | |
UaString | getSecurityPolicyUri () const |
The URI for SecurityPolicy to use when securing messages. | |
void | getUserIdentityTokens (UaUserTokenPolicys &userIdentityTokens) const |
The user identity tokens that the Server will accept. More... | |
UaString | getTransportProfileUri () const |
The URI of the Transport Profile supported by the Endpoint. | |
OpcUa_Byte | getSecurityLevel () const |
A numeric value that indicates how secure the EndpointDescription is compared to other EndpointDescriptions for the same Server. More... | |
void | setEndpointUrl (const UaString &endpointUrl) |
The URL for the Endpoint described. | |
void | setServer (const UaApplicationDescription &server) |
The description for the Server that the Endpoint belongs to. | |
void | setServerCertificate (const UaByteString &serverCertificate) |
The application instance Certificate issued to the Server. | |
void | setSecurityMode (OpcUa_MessageSecurityMode securityMode) |
The type of security to apply to the messages. More... | |
void | setSecurityPolicyUri (const UaString &securityPolicyUri) |
The URI for SecurityPolicy to use when securing messages. | |
void | setUserIdentityTokens (const UaUserTokenPolicys &userIdentityTokens) |
The user identity tokens that the Server will accept. More... | |
void | setTransportProfileUri (const UaString &transportProfileUri) |
The URI of the Transport Profile supported by the Endpoint. | |
void | setSecurityLevel (OpcUa_Byte securityLevel) |
A numeric value that indicates how secure the EndpointDescription is compared to other EndpointDescriptions for the same Server. More... | |
Static Public Member Functions | |
static OpcUa_EndpointDescription * | clone (const OpcUa_EndpointDescription &source) |
Copy OpcUa_EndpointDescription data to a newly allocated OpcUa_EndpointDescription. More... | |
static void | cloneTo (const OpcUa_EndpointDescription &source, OpcUa_EndpointDescription ©) |
Copy OpcUa_EndpointDescription data to an existing OpcUa_EndpointDescription structure. More... | |
Wrapper class for the UA stack structure OpcUa_EndpointDescription.
This class encapsulates the native OpcUa_EndpointDescription structure and handles memory allocation and cleanup for you. UaEndpointDescription uses implicit sharing to avoid needless copying and to boost the performance. Only if you modify a shared EndpointDescription it creates a copy for that (copy-on-write). So assigning another UaEndpointDescription or passing it as parameter needs constant time and is nearly as fast as assigning a pointer.
Describes an Endpoint for a Server
UaEndpointDescription::UaEndpointDescription | ( | const UaEndpointDescription & | other | ) |
Constructs an instance of the class UaEndpointDescription with values from another UaEndpointDescription object.
other | the other UaEndpointDescription used to initialize the object |
UaEndpointDescription::UaEndpointDescription | ( | const OpcUa_EndpointDescription & | other | ) |
Constructs an instance of the class UaEndpointDescription with values from another OpcUa_EndpointDescription structure.
other | the other OpcUa_EndpointDescription used to initialize the object |
UaEndpointDescription::UaEndpointDescription | ( | const UaExtensionObject & | extensionObject | ) |
Constructs an instance of the class UaEndpointDescription initialized with value from a UaExtensionObject.
extensionObject | the extension object containing the EndpointDescription |
UaEndpointDescription::UaEndpointDescription | ( | const OpcUa_ExtensionObject & | extensionObject | ) |
Constructs an instance of the class UaEndpointDescription initialized with value from an OpcUa_ExtensionObject structure.
extensionObject | the extension object containing the EndpointDescription |
void UaEndpointDescription::attach | ( | OpcUa_EndpointDescription * | pValue | ) |
Attaches to an existing OpcUa_EndpointDescription structure.
Don't manually free the attached structure afterwards, because UaEndpointDescription is responsible for it now.
pValue | [in] Parameter to attach to. |
void UaEndpointDescription::clear | ( | ) |
Clear the data of the UaEndpointDescription.
|
static |
Copy OpcUa_EndpointDescription data to a newly allocated OpcUa_EndpointDescription.
source | Source to clone. |
|
static |
Copy OpcUa_EndpointDescription data to an existing OpcUa_EndpointDescription structure.
source | the source of the clone operation. |
copy | the destination of the clone operation. |
OpcUa_EndpointDescription * UaEndpointDescription::copy | ( | ) | const |
Copy UaEndpointDescription data to a newly allocated OpcUa_EndpointDescription.
void UaEndpointDescription::copyTo | ( | OpcUa_EndpointDescription * | pDst | ) | const |
Copy UaEndpointDescription data to an existing OpcUa_EndpointDescription structure.
pDst | the destination of this copy operation. |
OpcUa_EndpointDescription * UaEndpointDescription::detach | ( | OpcUa_EndpointDescription * | pDst | ) |
Detaches the internal EndpointDescription structure from this class.
This way you take over the control of freeing the EndpointDescription data. If more than one reference exists, the data is copied to pDst instead of being detached.
pDst | [out] Pointer to an OpcUa_EndpointDescription structure that receives the EndpointDescription data. |
OpcUa_Byte UaEndpointDescription::getSecurityLevel | ( | ) | const |
A numeric value that indicates how secure the EndpointDescription is compared to other EndpointDescriptions for the same Server.
A value of 0 indicates that the EndpointDescription is not recommended and is only supported for backward compatibility.
A higher value indicates better security.
OpcUa_MessageSecurityMode UaEndpointDescription::getSecurityMode | ( | ) | const |
The type of security to apply to the messages.
A SecureChannel may have to be created even if the securityMode is NONE.
void UaEndpointDescription::getUserIdentityTokens | ( | UaUserTokenPolicys & | userIdentityTokens | ) | const |
The user identity tokens that the Server will accept.
The Client shall pass one of the UserIdentityTokens in the ActivateSession request.
bool UaEndpointDescription::operator!= | ( | const UaEndpointDescription & | other | ) | const |
Compare two UaEndpointDescription for inequality.
other | the UaEndpointDescription to compare with. |
UaEndpointDescription & UaEndpointDescription::operator= | ( | const UaEndpointDescription & | other | ) |
Assignment operator.
other | the UaEndpointDescription to assign. |
bool UaEndpointDescription::operator== | ( | const UaEndpointDescription & | other | ) | const |
Compare two UaEndpointDescription for equality.
other | the UaEndpointDescription to compare with. |
void UaEndpointDescription::setSecurityLevel | ( | OpcUa_Byte | securityLevel | ) |
A numeric value that indicates how secure the EndpointDescription is compared to other EndpointDescriptions for the same Server.
A value of 0 indicates that the EndpointDescription is not recommended and is only supported for backward compatibility.
A higher value indicates better security.
void UaEndpointDescription::setSecurityMode | ( | OpcUa_MessageSecurityMode | securityMode | ) |
The type of security to apply to the messages.
A SecureChannel may have to be created even if the securityMode is NONE.
void UaEndpointDescription::setUserIdentityTokens | ( | const UaUserTokenPolicys & | userIdentityTokens | ) |
The user identity tokens that the Server will accept.
The Client shall pass one of the UserIdentityTokens in the ActivateSession request.