CopperSpice API  1.7.2
QSslCipher Class Reference

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

Public Methods

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

Detailed Description

The QSslCipher class represents an SSL cryptographic cipher.

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

Constructor & Destructor Documentation

QSslCipher::QSslCipher ( )

Constructs an empty QSslCipher object.

QSslCipher::QSslCipher ( const QString name)
explicit

Constructs a QSslCipher object for the cipher determined by name. The constructor accepts only supported ciphers For example, the name must identify a cipher in the list of ciphers returned by QSslConfiguration::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. For example the name and protocol must identify a cipher in the list of ciphers returned by QSslConfiguration::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.

QSslCipher::~QSslCipher ( )

Destroys the QSslCipher object.

Method Documentation

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()
bool QSslCipher::operator!= ( const QSslCipher &  other) const
inline

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

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

Copy assigns from other and returns a reference to this object.

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

Move assigns from other and returns a reference to this object.

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

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

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()
void QSslCipher::swap ( QSslCipher &  other)
inline

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

int QSslCipher::usedBits ( ) const

Returns the number of bits used by the cipher.

See also
supportedBits()