QSslCipher Class

The QSslCipher class represents an SSL cryptographic cipher. More...

Header:	`#include <QSslCipher>`
CMake:	`find_package(Qt6 REQUIRED COMPONENTS Network)` `target_link_libraries(mytarget PRIVATE Qt6::Network)`
qmake:	`QT += network`

List of all members, including inherited members
QSslCipher is part of Network Programming API and Implicitly Shared Classes.

Note: All functions in this class are reentrant.

Public Functions

	QSslCipher()
	QSslCipher(const QString &name)
	QSslCipher(const QString &name, QSsl::SslProtocol protocol)
	QSslCipher(const QSslCipher &other)
	~QSslCipher()
QString	authenticationMethod() const
QString	encryptionMethod() const
bool	isNull() const
QString	keyExchangeMethod() const
QString	name() const
QSsl::SslProtocol	protocol() const
QString	protocolString() const
int	supportedBits() const
void	swap(QSslCipher &other)
int	usedBits() const
bool	operator!=(const QSslCipher &other) const
QSslCipher &	operator=(const QSslCipher &other)
bool	operator==(const QSslCipher &other) const

Detailed Description

QSslCipher stores information about one cryptographic cipher. It is most commonly used with QSslSocket, either for configuring which ciphers the socket can use, or for displaying the socket's ciphers to the user.

See also QSslSocket and QSslKey.

Member Function Documentation

QSslCipher::QSslCipher()

Constructs an empty QSslCipher object.

`[explicit]` QSslCipher::QSslCipher(const QString &name)

Constructs a QSslCipher object for the cipher determined by name. The constructor accepts only supported ciphers (i.e., the name must identify a cipher in the list of ciphers returned by QSslSocket::supportedCiphers()).

You can call isNull() after construction to check if name correctly identified a supported cipher.

QSslCipher::QSslCipher(const QString &name, QSsl::SslProtocol protocol)

Constructs a QSslCipher object for the cipher determined by name and protocol. The constructor accepts only supported ciphers (i.e., the name and protocol must identify a cipher in the list of ciphers returned by QSslSocket::supportedCiphers()).

You can call isNull() after construction to check if name and protocol correctly identified a supported cipher.

QSslCipher::QSslCipher(const QSslCipher &other)

Constructs an identical copy of the other cipher.

`[noexcept]` QSslCipher::~QSslCipher()

Destroys the QSslCipher object.

QString QSslCipher::authenticationMethod() const

Returns the cipher's authentication method as a QString.

QString QSslCipher::encryptionMethod() const

Returns the cipher's encryption method as a QString.

bool QSslCipher::isNull() const

Returns true if this is a null cipher; otherwise returns false.

QString QSslCipher::keyExchangeMethod() const

Returns the cipher's key exchange method as a QString.

QString QSslCipher::name() const

Returns the name of the cipher, or an empty QString if this is a null cipher.

See also isNull().

QSsl::SslProtocol QSslCipher::protocol() const

Returns the cipher's protocol type, or QSsl::UnknownProtocol if QSslCipher is unable to determine the protocol (protocolString() may contain more information).

See also protocolString().

QString QSslCipher::protocolString() const

Returns the cipher's protocol as a QString.

See also protocol().

int QSslCipher::supportedBits() const

Returns the number of bits supported by the cipher.

See also usedBits().

`[noexcept]` void QSslCipher::swap(QSslCipher &other)

Swaps this cipher instance with other. This operation is very fast and never fails.

int QSslCipher::usedBits() const

Returns the number of bits used by the cipher.

See also supportedBits().

bool QSslCipher::operator!=(const QSslCipher &other) const

Returns true if this cipher is not the same as other; otherwise, false is returned.

QSslCipher &QSslCipher::operator=(const QSslCipher &other)

Copies the contents of other into this cipher, making the two ciphers identical.

bool QSslCipher::operator==(const QSslCipher &other) const

Returns true if this cipher is the same as other; otherwise, false is returned.

© 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.