QOpcUaEndpointDescription Class
The OPC UA EndpointDescription. More...
| Header: | #include <QOpcUaEndpointDescription> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS OpcUa)target_link_libraries(mytarget PRIVATE Qt6::OpcUa) |
| qmake: | QT += opcua |
Public Types
| enum | MessageSecurityMode { Invalid, None, Sign, SignAndEncrypt } |
Properties
|
|
Public Functions
| QOpcUaEndpointDescription() | |
| QOpcUaEndpointDescription(const QOpcUaEndpointDescription &rhs) | |
| QString | endpointUrl() const |
| quint8 | securityLevel() const |
| QOpcUaEndpointDescription::MessageSecurityMode | securityMode() const |
| QString | securityPolicy() const |
| QOpcUaApplicationDescription | server() const |
| QByteArray | serverCertificate() const |
| QOpcUaApplicationDescription & | serverRef() |
| void | setEndpointUrl(const QString &endpointUrl) |
| void | setSecurityLevel(quint8 securityLevel) |
| void | setSecurityMode(QOpcUaEndpointDescription::MessageSecurityMode securityMode) |
| void | setSecurityPolicy(const QString &securityPolicy) |
| void | setServer(const QOpcUaApplicationDescription &server) |
| void | setServerCertificate(const QByteArray &serverCertificate) |
| void | setTransportProfileUri(const QString &transportProfileUri) |
| void | setUserIdentityTokens(const QList<QOpcUaUserTokenPolicy> &userIdentityTokens) |
| QString | transportProfileUri() const |
| QList<QOpcUaUserTokenPolicy> | userIdentityTokens() const |
| QList<QOpcUaUserTokenPolicy> & | userIdentityTokensRef() |
| QOpcUaEndpointDescription & | operator=(const QOpcUaEndpointDescription &rhs) |
| bool | operator==(const QOpcUaEndpointDescription &rhs) const |
Detailed Description
An endpoint description contains information about an endpoint and how to connect to it.
Member Type Documentation
enum QOpcUaEndpointDescription::MessageSecurityMode
This enum type holds the security mode supported by the endpoint.
| Constant | Value | Description |
|---|---|---|
QOpcUaEndpointDescription::Invalid | 0 | The default value, will be rejected by the server. |
QOpcUaEndpointDescription::None | 1 | No security. |
QOpcUaEndpointDescription::Sign | 2 | Messages are signed but not encrypted. |
QOpcUaEndpointDescription::SignAndEncrypt | 3 | Messages are signed and encrypted. |
Property Documentation
[read-only] endpointUrl : const QString
The URL for the endpoint.
Access functions:
| QString | endpointUrl() const |
[read-only] securityMode : const QOpcUaEndpointDescription::MessageSecurityMode
Security mode supported by this endpoint.
Access functions:
| QOpcUaEndpointDescription::MessageSecurityMode | securityMode() const |
[read-only] securityPolicy : const QString
The URI of the security policy.
Access functions:
| QString | securityPolicy() const |
[read-only] server : const QOpcUaApplicationDescription
The application description of the server.
Access functions:
| QOpcUaApplicationDescription | server() const |
[read-only] userIdentityTokens : const QList<QOpcUaUserTokenPolicy>
List of user identity tokens the endpoint will accept.
Access functions:
| QList<QOpcUaUserTokenPolicy> | userIdentityTokens() const |
Member Function Documentation
QOpcUaEndpointDescription::QOpcUaEndpointDescription()
Default constructs an endpoint description with no parameters set.
QOpcUaEndpointDescription::QOpcUaEndpointDescription(const QOpcUaEndpointDescription &rhs)
Constructs an endpoint description from rhs.
QString QOpcUaEndpointDescription::endpointUrl() const
Returns the URL for the endpoint.
Note: Getter function for property endpointUrl.
See also setEndpointUrl().
quint8 QOpcUaEndpointDescription::securityLevel() const
Returns a relative index assigned by the server. It describes how secure this endpoint is compared to other endpoints of the same server. An endpoint with strong security measures has a higher security level than one with weaker or no security measures.
Security level 0 indicates an endpoint for backward compatibility purposes which should only be used if the client does not support the security measures required by more secure endpoints.
See also setSecurityLevel().
QOpcUaEndpointDescription::MessageSecurityMode QOpcUaEndpointDescription::securityMode() const
Returns the security mode supported by this endpoint.
Note: Getter function for property securityMode.
See also setSecurityMode().
QString QOpcUaEndpointDescription::securityPolicy() const
Returns the URI of the security policy.
The Basic128Rsa15 and Basic256 security policies are deprecated and should only be used for backward compatibility if the server doesn't support any of the policies currently considered as secure.
Note: Getter function for property securityPolicy.
See also setSecurityPolicy().
QOpcUaApplicationDescription QOpcUaEndpointDescription::server() const
Returns the application description of the server.
Note: Getter function for property server.
See also setServer().
QByteArray QOpcUaEndpointDescription::serverCertificate() const
Returns the application instance certificate of the server.
See also setServerCertificate().
QOpcUaApplicationDescription &QOpcUaEndpointDescription::serverRef()
Returns a reference to the application description of the server.
void QOpcUaEndpointDescription::setEndpointUrl(const QString &endpointUrl)
Sets the URL for the endpoint to endpointUrl.
See also endpointUrl().
void QOpcUaEndpointDescription::setSecurityLevel(quint8 securityLevel)
Sets the security level to securityLevel.
See also securityLevel().
void QOpcUaEndpointDescription::setSecurityMode(QOpcUaEndpointDescription::MessageSecurityMode securityMode)
Sets the security mode supported by this endpoint to securityMode.
See also securityMode().
void QOpcUaEndpointDescription::setSecurityPolicy(const QString &securityPolicy)
Sets the URI of the security policy to securityPolicy.
The Basic128Rsa15 and Basic256 security policies are deprecated and should only be used for backward compatibility if the server doesn't support any of the policies currently considered as secure.
See also securityPolicy().
void QOpcUaEndpointDescription::setServer(const QOpcUaApplicationDescription &server)
Sets the application description of the server to server.
See also server().
void QOpcUaEndpointDescription::setServerCertificate(const QByteArray &serverCertificate)
Sets the application instance certificate of the server to serverCertificate.
See also serverCertificate().
void QOpcUaEndpointDescription::setTransportProfileUri(const QString &transportProfileUri)
Sets the URI of the transport profile supported by the endpoint to transportProfileUri.
See also transportProfileUri().
void QOpcUaEndpointDescription::setUserIdentityTokens(const QList<QOpcUaUserTokenPolicy> &userIdentityTokens)
Sets the user identity tokens to userIdentityTokens.
See also userIdentityTokens().
QString QOpcUaEndpointDescription::transportProfileUri() const
Returns the URI of the transport profile supported by the endpoint.
See also setTransportProfileUri().
QList<QOpcUaUserTokenPolicy> QOpcUaEndpointDescription::userIdentityTokens() const
Returns a list of user identity tokens the endpoint will accept.
Note: Getter function for property userIdentityTokens.
See also setUserIdentityTokens().
QList<QOpcUaUserTokenPolicy> &QOpcUaEndpointDescription::userIdentityTokensRef()
Returns a reference to a list of user identity tokens the endpoint will accept.
QOpcUaEndpointDescription &QOpcUaEndpointDescription::operator=(const QOpcUaEndpointDescription &rhs)
Sets the values from rhs in this endpoint description.
bool QOpcUaEndpointDescription::operator==(const QOpcUaEndpointDescription &rhs) const
Returns true if this endpoint description has the same value as rhs.
© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.
