QOpcUaEndpointDescription Class

The OPC UA EndpointDescription. More...

Header:	#include <QOpcUaEndpointDescription>
qmake:	QT += opcua

• List of all members, including inherited members

Public Types

enum	MessageSecurityMode { Invalid, None, Sign, SignAndEncrypt }

Properties

endpointUrl : const QString securityMode : const QOpcUaEndpointDescription::MessageSecurityMode securityPolicy : const QString

server : const QOpcUaApplicationDescription userIdentityTokens : const QList<QOpcUaUserTokenPolicy>

Public Functions

	QOpcUaEndpointDescription(const QOpcUaEndpointDescription &rhs)
QOpcUaEndpointDescription &	operator=(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()
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.

Member Function Documentation

QOpcUaEndpointDescription::QOpcUaEndpointDescription(const QOpcUaEndpointDescription &rhs)

Constructs an endpoint description from rhs.

QOpcUaEndpointDescription &QOpcUaEndpointDescription::operator=(const QOpcUaEndpointDescription &rhs)

Sets the values from rhs in this endpoint description.

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.

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.

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.

bool QOpcUaEndpointDescription::operator==(const QOpcUaEndpointDescription &rhs) const

Returns true if this endpoint description has the same value as rhs.