Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
QSslCipher Class Reference

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

#include <qsslcipher.h>

+ Collaboration diagram for QSslCipher:

Public Member Functions

 QSslCipher ()
 Constructs an empty QSslCipher object.
 
 QSslCipher (const QString &name)
 
 QSslCipher (const QString &name, QSsl::SslProtocol protocol)
 Constructs a QSslCipher object for the cipher determined by name and protocol.
 
 QSslCipher (const QSslCipher &other)
 Constructs an identical copy of the other cipher.
 
QSslCipher & operator= (QSslCipher &&other) noexcept
 
QSslCipher & operator= (const QSslCipher &other)
 Copies the contents of other into this cipher, making the two ciphers identical.
 
 ~QSslCipher ()
 Destroys the QSslCipher object.
 
void swap (QSslCipher &other) noexcept
 
bool operator== (const QSslCipher &other) const
 Returns true if this cipher is the same as other; otherwise, false is returned.
 
bool operator!= (const QSslCipher &other) const
 Returns true if this cipher is not the same as other; otherwise, false is returned.
 
bool isNull () const
 Returns true if this is a null cipher; otherwise returns false.
 
QString name () const
 Returns the name of the cipher, or an empty QString if this is a null cipher.
 
int supportedBits () const
 Returns the number of bits supported by the cipher.
 
int usedBits () const
 Returns the number of bits used by the cipher.
 
QString keyExchangeMethod () const
 Returns the cipher's key exchange method as a QString.
 
QString authenticationMethod () const
 Returns the cipher's authentication method as a QString.
 
QString encryptionMethod () const
 Returns the cipher's encryption method as a QString.
 
QString protocolString () const
 Returns the cipher's protocol as a QString.
 
QSsl::SslProtocol protocol () const
 Returns the cipher's protocol type, or \l QSsl::UnknownProtocol if QSslCipher is unable to determine the protocol (protocolString() may contain more information).
 

Friends

class QTlsBackend
 

Detailed Description

The QSslCipher class represents an SSL cryptographic cipher.

Since
4.3

\reentrant

\inmodule QtNetwork

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, QSslKey

Definition at line 21 of file qsslcipher.h.

Constructor & Destructor Documentation

◆ QSslCipher() [1/4]

QSslCipher::QSslCipher ( )

Constructs an empty QSslCipher object.

Definition at line 41 of file qsslcipher.cpp.

◆ QSslCipher() [2/4]

QSslCipher::QSslCipher ( const QString & name)
explicit
Since
5.3

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.

Definition at line 57 of file qsslcipher.cpp.

◆ QSslCipher() [3/4]

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.

Definition at line 79 of file qsslcipher.cpp.

◆ QSslCipher() [4/4]

QSslCipher::QSslCipher ( const QSslCipher & other)

Constructs an identical copy of the other cipher.

Definition at line 94 of file qsslcipher.cpp.

◆ ~QSslCipher()

QSslCipher::~QSslCipher ( )

Destroys the QSslCipher object.

Definition at line 103 of file qsslcipher.cpp.

Member Function Documentation

◆ authenticationMethod()

QString QSslCipher::authenticationMethod ( ) const

Returns the cipher's authentication method as a QString.

Definition at line 189 of file qsslcipher.cpp.

◆ encryptionMethod()

QString QSslCipher::encryptionMethod ( ) const

Returns the cipher's encryption method as a QString.

Definition at line 197 of file qsslcipher.cpp.

◆ isNull()

bool QSslCipher::isNull ( ) const

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

Definition at line 142 of file qsslcipher.cpp.

◆ keyExchangeMethod()

QString QSslCipher::keyExchangeMethod ( ) const

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

Definition at line 181 of file qsslcipher.cpp.

◆ name()

QString QSslCipher::name ( ) const

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

See also
isNull()

Definition at line 153 of file qsslcipher.cpp.

◆ operator!=()

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

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

Definition at line 36 of file qsslcipher.h.

◆ operator=() [1/2]

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

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

Definition at line 111 of file qsslcipher.cpp.

◆ operator=() [2/2]

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

Definition at line 28 of file qsslcipher.h.

◆ operator==()

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

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

Definition at line 127 of file qsslcipher.cpp.

◆ protocol()

QSsl::SslProtocol QSslCipher::protocol ( ) const

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

See also
protocolString()

Definition at line 219 of file qsslcipher.cpp.

◆ protocolString()

QString QSslCipher::protocolString ( ) const

Returns the cipher's protocol as a QString.

See also
protocol()

Definition at line 207 of file qsslcipher.cpp.

◆ supportedBits()

int QSslCipher::supportedBits ( ) const

Returns the number of bits supported by the cipher.

See also
usedBits()

Definition at line 163 of file qsslcipher.cpp.

◆ swap()

void QSslCipher::swap ( QSslCipher & other)
inlinenoexcept
Since
5.0 \memberswap{cipher instance}

Definition at line 32 of file qsslcipher.h.

◆ usedBits()

int QSslCipher::usedBits ( ) const

Returns the number of bits used by the cipher.

See also
supportedBits()

Definition at line 173 of file qsslcipher.cpp.

Friends And Related Symbol Documentation

◆ QTlsBackend

friend class QTlsBackend
friend

Definition at line 52 of file qsslcipher.h.

The documentation for this class was generated from the following files: