API reference - Class QSslConfiguration

!=

Signature: [const] bool != (const QSslConfiguration other)

Description: Method bool QSslConfiguration::operator!=(const QSslConfiguration &other)

==

Signature: [const] bool == (const QSslConfiguration other)

Description: Method bool QSslConfiguration::operator==(const QSslConfiguration &other)

NextProtocolNegotiationNegotiated

Signature: [static,const] QSslConfiguration_NextProtocolNegotiationStatus NextProtocolNegotiationNegotiated

Description: Enum constant QSslConfiguration::NextProtocolNegotiationNegotiated

Python specific notes:
The object exposes a readable attribute 'NextProtocolNegotiationNegotiated'. This is the getter.

NextProtocolNegotiationNone

Signature: [static,const] QSslConfiguration_NextProtocolNegotiationStatus NextProtocolNegotiationNone

Description: Enum constant QSslConfiguration::NextProtocolNegotiationNone

Python specific notes:
The object exposes a readable attribute 'NextProtocolNegotiationNone'. This is the getter.

NextProtocolNegotiationUnsupported

Signature: [static,const] QSslConfiguration_NextProtocolNegotiationStatus NextProtocolNegotiationUnsupported

Description: Enum constant QSslConfiguration::NextProtocolNegotiationUnsupported

Python specific notes:
The object exposes a readable attribute 'NextProtocolNegotiationUnsupported'. This is the getter.

_assign

Signature: void _assign (const QSslConfiguration other)

Description: Assigns another object to self

_const_cast

Signature: [const] QSslConfiguration ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

allowedNextProtocols

Signature: [const] bytes[] allowedNextProtocols

Description: Method QList<QByteArray> QSslConfiguration::allowedNextProtocols()

Python specific notes:
The object exposes a readable attribute 'allowedNextProtocols'. This is the getter.

allowedNextProtocols=

Signature: void allowedNextProtocols= (bytes[] protocols)

Description: Method void QSslConfiguration::setAllowedNextProtocols(QList<QByteArray> protocols)

Python specific notes:
The object exposes a writable attribute 'allowedNextProtocols'. This is the setter.

assign

Signature: QSslConfiguration assign (const QSslConfiguration other)

Description: Method QSslConfiguration &QSslConfiguration::operator=(const QSslConfiguration &other)

backendConfiguration

Signature: [const] map<bytes,variant> backendConfiguration

Description: Method QMap<QByteArray, QVariant> QSslConfiguration::backendConfiguration()

Python specific notes:
The object exposes a readable attribute 'backendConfiguration'. This is the getter.

backendConfiguration=

Signature: void backendConfiguration= (map<bytes,variant> backendConfiguration = QMap<QByteArray, QVariant>())

Description: Method void QSslConfiguration::setBackendConfiguration(const QMap<QByteArray, QVariant> &backendConfiguration)

Python specific notes:
The object exposes a writable attribute 'backendConfiguration'. This is the setter.

caCertificates

Signature: [const] QSslCertificate[] caCertificates

Description: Method QList<QSslCertificate> QSslConfiguration::caCertificates()

Python specific notes:
The object exposes a readable attribute 'caCertificates'. This is the getter.

caCertificates=

Signature: void caCertificates= (QSslCertificate[] certificates)

Description: Method void QSslConfiguration::setCaCertificates(const QList<QSslCertificate> &certificates)

Python specific notes:
The object exposes a writable attribute 'caCertificates'. This is the setter.

ciphers

Signature: [const] QSslCipher[] ciphers

Description: Method QList<QSslCipher> QSslConfiguration::ciphers()

Python specific notes:
The object exposes a readable attribute 'ciphers'. This is the getter.

ciphers=

Signature: void ciphers= (QSslCipher[] ciphers)

Description: Method void QSslConfiguration::setCiphers(const QList<QSslCipher> &ciphers)

Python specific notes:
The object exposes a writable attribute 'ciphers'. This is the setter.

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

defaultConfiguration

Signature: [static] QSslConfiguration defaultConfiguration

Description: Static method QSslConfiguration QSslConfiguration::defaultConfiguration()

This method is static and can be called without an instance.

Python specific notes:
The object exposes a readable attribute 'defaultConfiguration'. This is the getter.

defaultConfiguration=

Signature: [static] void defaultConfiguration= (const QSslConfiguration configuration)

Description: Static method void QSslConfiguration::setDefaultConfiguration(const QSslConfiguration &configuration)

This method is static and can be called without an instance.

Python specific notes:
The object exposes a writable attribute 'defaultConfiguration'. This is the setter.

defaultDtlsConfiguration

Signature: [static] QSslConfiguration defaultDtlsConfiguration

Description: Static method QSslConfiguration QSslConfiguration::defaultDtlsConfiguration()

This method is static and can be called without an instance.

Python specific notes:
The object exposes a readable attribute 'defaultDtlsConfiguration'. This is the getter.

defaultDtlsConfiguration=

Signature: [static] void defaultDtlsConfiguration= (const QSslConfiguration configuration)

Description: Static method void QSslConfiguration::setDefaultDtlsConfiguration(const QSslConfiguration &configuration)

This method is static and can be called without an instance.

Python specific notes:
The object exposes a writable attribute 'defaultDtlsConfiguration'. This is the setter.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

diffieHellmanParameters

Signature: [const] QSslDiffieHellmanParameters diffieHellmanParameters

Description: Method QSslDiffieHellmanParameters QSslConfiguration::diffieHellmanParameters()

Python specific notes:
The object exposes a readable attribute 'diffieHellmanParameters'. This is the getter.

diffieHellmanParameters=

Signature: void diffieHellmanParameters= (const QSslDiffieHellmanParameters dhparams)

Description: Method void QSslConfiguration::setDiffieHellmanParameters(const QSslDiffieHellmanParameters &dhparams)

Python specific notes:
The object exposes a writable attribute 'diffieHellmanParameters'. This is the setter.

dtlsCookieVerificationEnabled

Signature: [const] bool dtlsCookieVerificationEnabled

Description: Method bool QSslConfiguration::dtlsCookieVerificationEnabled()

Python specific notes:
The object exposes a readable attribute 'dtlsCookieVerificationEnabled'. This is the getter.

dtlsCookieVerificationEnabled=

Signature: void dtlsCookieVerificationEnabled= (bool enable)

Description: Method void QSslConfiguration::setDtlsCookieVerificationEnabled(bool enable)

Python specific notes:
The object exposes a writable attribute 'dtlsCookieVerificationEnabled'. This is the setter.

dup

Signature: [const] new QSslConfiguration ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

ellipticCurves

Signature: [const] QSslEllipticCurve[] ellipticCurves

Description: Method QVector<QSslEllipticCurve> QSslConfiguration::ellipticCurves()

Python specific notes:
The object exposes a readable attribute 'ellipticCurves'. This is the getter.

ellipticCurves=

Signature: void ellipticCurves= (QSslEllipticCurve[] curves)

Description: Method void QSslConfiguration::setEllipticCurves(const QVector<QSslEllipticCurve> &curves)

Python specific notes:
The object exposes a writable attribute 'ellipticCurves'. This is the setter.

ephemeralServerKey

Signature: [const] QSslKey ephemeralServerKey

Description: Method QSslKey QSslConfiguration::ephemeralServerKey()

isNull?

Signature: [const] bool isNull?

Description: Method bool QSslConfiguration::isNull()

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

localCertificate

Signature: [const] QSslCertificate localCertificate

Description: Method QSslCertificate QSslConfiguration::localCertificate()

Python specific notes:
The object exposes a readable attribute 'localCertificate'. This is the getter.

localCertificate=

Signature: void localCertificate= (const QSslCertificate certificate)

Description: Method void QSslConfiguration::setLocalCertificate(const QSslCertificate &certificate)

Python specific notes:
The object exposes a writable attribute 'localCertificate'. This is the setter.

localCertificateChain

Signature: [const] QSslCertificate[] localCertificateChain

Description: Method QList<QSslCertificate> QSslConfiguration::localCertificateChain()

Python specific notes:
The object exposes a readable attribute 'localCertificateChain'. This is the getter.

localCertificateChain=

Signature: void localCertificateChain= (QSslCertificate[] localChain)

Description: Method void QSslConfiguration::setLocalCertificateChain(const QList<QSslCertificate> &localChain)

Python specific notes:
The object exposes a writable attribute 'localCertificateChain'. This is the setter.

new

(1) Signature: [static] new QSslConfiguration new

Description: Constructor QSslConfiguration::QSslConfiguration()

This method creates an object of class QSslConfiguration.

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QSslConfiguration new (const QSslConfiguration other)

Description: Constructor QSslConfiguration::QSslConfiguration(const QSslConfiguration &other)

This method creates an object of class QSslConfiguration.

Python specific notes:
This method is the default initializer of the object.

nextNegotiatedProtocol

Signature: [const] bytes nextNegotiatedProtocol

Description: Method QByteArray QSslConfiguration::nextNegotiatedProtocol()

nextProtocolNegotiationStatus

Signature: [const] QSslConfiguration_NextProtocolNegotiationStatus nextProtocolNegotiationStatus

Description: Method QSslConfiguration::NextProtocolNegotiationStatus QSslConfiguration::nextProtocolNegotiationStatus()

peerCertificate

Signature: [const] QSslCertificate peerCertificate

Description: Method QSslCertificate QSslConfiguration::peerCertificate()

peerCertificateChain

Signature: [const] QSslCertificate[] peerCertificateChain

Description: Method QList<QSslCertificate> QSslConfiguration::peerCertificateChain()

peerVerifyDepth

Signature: [const] int peerVerifyDepth

Description: Method int QSslConfiguration::peerVerifyDepth()

Python specific notes:
The object exposes a readable attribute 'peerVerifyDepth'. This is the getter.

peerVerifyDepth=

Signature: void peerVerifyDepth= (int depth)

Description: Method void QSslConfiguration::setPeerVerifyDepth(int depth)

Python specific notes:
The object exposes a writable attribute 'peerVerifyDepth'. This is the setter.

peerVerifyMode

Signature: [const] QSslSocket_PeerVerifyMode peerVerifyMode

Description: Method QSslSocket::PeerVerifyMode QSslConfiguration::peerVerifyMode()

Python specific notes:
The object exposes a readable attribute 'peerVerifyMode'. This is the getter.

peerVerifyMode=

Signature: void peerVerifyMode= (const QSslSocket_PeerVerifyMode mode)

Description: Method void QSslConfiguration::setPeerVerifyMode(QSslSocket::PeerVerifyMode mode)

Python specific notes:
The object exposes a writable attribute 'peerVerifyMode'. This is the setter.

preSharedKeyIdentityHint

Signature: [const] bytes preSharedKeyIdentityHint

Description: Method QByteArray QSslConfiguration::preSharedKeyIdentityHint()

Python specific notes:
The object exposes a readable attribute 'preSharedKeyIdentityHint'. This is the getter.

preSharedKeyIdentityHint=

Signature: void preSharedKeyIdentityHint= (bytes hint)

Description: Method void QSslConfiguration::setPreSharedKeyIdentityHint(const QByteArray &hint)

Python specific notes:
The object exposes a writable attribute 'preSharedKeyIdentityHint'. This is the setter.

privateKey

Signature: [const] QSslKey privateKey

Description: Method QSslKey QSslConfiguration::privateKey()

Python specific notes:
The object exposes a readable attribute 'privateKey'. This is the getter.

privateKey=

Signature: void privateKey= (const QSslKey key)

Description: Method void QSslConfiguration::setPrivateKey(const QSslKey &key)

Python specific notes:
The object exposes a writable attribute 'privateKey'. This is the setter.

protocol

Signature: [const] QSsl_SslProtocol protocol

Description: Method QSsl::SslProtocol QSslConfiguration::protocol()

Python specific notes:
The object exposes a readable attribute 'protocol'. This is the getter.

protocol=

Signature: void protocol= (const QSsl_SslProtocol protocol)

Description: Method void QSslConfiguration::setProtocol(QSsl::SslProtocol protocol)

Python specific notes:
The object exposes a writable attribute 'protocol'. This is the setter.

sessionCipher

Signature: [const] QSslCipher sessionCipher

Description: Method QSslCipher QSslConfiguration::sessionCipher()

sessionProtocol

Signature: [const] QSsl_SslProtocol sessionProtocol

Description: Method QSsl::SslProtocol QSslConfiguration::sessionProtocol()

sessionTicket

Signature: [const] bytes sessionTicket

Description: Method QByteArray QSslConfiguration::sessionTicket()

Python specific notes:
The object exposes a readable attribute 'sessionTicket'. This is the getter.

sessionTicket=

Signature: void sessionTicket= (bytes sessionTicket)

Description: Method void QSslConfiguration::setSessionTicket(const QByteArray &sessionTicket)

Python specific notes:
The object exposes a writable attribute 'sessionTicket'. This is the setter.

sessionTicketLifeTimeHint

Signature: [const] int sessionTicketLifeTimeHint

Description: Method int QSslConfiguration::sessionTicketLifeTimeHint()

setAllowedNextProtocols

Signature: void setAllowedNextProtocols (bytes[] protocols)

Description: Method void QSslConfiguration::setAllowedNextProtocols(QList<QByteArray> protocols)

Python specific notes:
The object exposes a writable attribute 'allowedNextProtocols'. This is the setter.

setBackendConfiguration

Signature: void setBackendConfiguration (map<bytes,variant> backendConfiguration = QMap<QByteArray, QVariant>())

Description: Method void QSslConfiguration::setBackendConfiguration(const QMap<QByteArray, QVariant> &backendConfiguration)

Python specific notes:
The object exposes a writable attribute 'backendConfiguration'. This is the setter.

setBackendConfigurationOption

Signature: void setBackendConfigurationOption (bytes name, variant value)

Description: Method void QSslConfiguration::setBackendConfigurationOption(const QByteArray &name, const QVariant &value)

setCaCertificates

Signature: void setCaCertificates (QSslCertificate[] certificates)

Description: Method void QSslConfiguration::setCaCertificates(const QList<QSslCertificate> &certificates)

Python specific notes:
The object exposes a writable attribute 'caCertificates'. This is the setter.

setCiphers

Signature: void setCiphers (QSslCipher[] ciphers)

Description: Method void QSslConfiguration::setCiphers(const QList<QSslCipher> &ciphers)

Python specific notes:
The object exposes a writable attribute 'ciphers'. This is the setter.

setDefaultConfiguration

Signature: [static] void setDefaultConfiguration (const QSslConfiguration configuration)

Description: Static method void QSslConfiguration::setDefaultConfiguration(const QSslConfiguration &configuration)

This method is static and can be called without an instance.

Python specific notes:
The object exposes a writable attribute 'defaultConfiguration'. This is the setter.

setDefaultDtlsConfiguration

Signature: [static] void setDefaultDtlsConfiguration (const QSslConfiguration configuration)

Description: Static method void QSslConfiguration::setDefaultDtlsConfiguration(const QSslConfiguration &configuration)

This method is static and can be called without an instance.

Python specific notes:
The object exposes a writable attribute 'defaultDtlsConfiguration'. This is the setter.

setDiffieHellmanParameters

Signature: void setDiffieHellmanParameters (const QSslDiffieHellmanParameters dhparams)

Description: Method void QSslConfiguration::setDiffieHellmanParameters(const QSslDiffieHellmanParameters &dhparams)

Python specific notes:
The object exposes a writable attribute 'diffieHellmanParameters'. This is the setter.

setDtlsCookieVerificationEnabled

Signature: void setDtlsCookieVerificationEnabled (bool enable)

Description: Method void QSslConfiguration::setDtlsCookieVerificationEnabled(bool enable)

Python specific notes:
The object exposes a writable attribute 'dtlsCookieVerificationEnabled'. This is the setter.

setEllipticCurves

Signature: void setEllipticCurves (QSslEllipticCurve[] curves)

Description: Method void QSslConfiguration::setEllipticCurves(const QVector<QSslEllipticCurve> &curves)

Python specific notes:
The object exposes a writable attribute 'ellipticCurves'. This is the setter.

setLocalCertificate

Signature: void setLocalCertificate (const QSslCertificate certificate)

Description: Method void QSslConfiguration::setLocalCertificate(const QSslCertificate &certificate)

Python specific notes:
The object exposes a writable attribute 'localCertificate'. This is the setter.

setLocalCertificateChain

Signature: void setLocalCertificateChain (QSslCertificate[] localChain)

Description: Method void QSslConfiguration::setLocalCertificateChain(const QList<QSslCertificate> &localChain)

Python specific notes:
The object exposes a writable attribute 'localCertificateChain'. This is the setter.

setPeerVerifyDepth

Signature: void setPeerVerifyDepth (int depth)

Description: Method void QSslConfiguration::setPeerVerifyDepth(int depth)

Python specific notes:
The object exposes a writable attribute 'peerVerifyDepth'. This is the setter.

setPeerVerifyMode

Signature: void setPeerVerifyMode (const QSslSocket_PeerVerifyMode mode)

Description: Method void QSslConfiguration::setPeerVerifyMode(QSslSocket::PeerVerifyMode mode)

Python specific notes:
The object exposes a writable attribute 'peerVerifyMode'. This is the setter.

setPreSharedKeyIdentityHint

Signature: void setPreSharedKeyIdentityHint (bytes hint)

Description: Method void QSslConfiguration::setPreSharedKeyIdentityHint(const QByteArray &hint)

Python specific notes:
The object exposes a writable attribute 'preSharedKeyIdentityHint'. This is the setter.

setPrivateKey

Signature: void setPrivateKey (const QSslKey key)

Description: Method void QSslConfiguration::setPrivateKey(const QSslKey &key)

Python specific notes:
The object exposes a writable attribute 'privateKey'. This is the setter.

setProtocol

Signature: void setProtocol (const QSsl_SslProtocol protocol)

Description: Method void QSslConfiguration::setProtocol(QSsl::SslProtocol protocol)

Python specific notes:
The object exposes a writable attribute 'protocol'. This is the setter.

setSessionTicket

Signature: void setSessionTicket (bytes sessionTicket)

Description: Method void QSslConfiguration::setSessionTicket(const QByteArray &sessionTicket)

Python specific notes:
The object exposes a writable attribute 'sessionTicket'. This is the setter.

setSslOption

Signature: void setSslOption (const QSsl_SslOption option, bool on)

Description: Method void QSslConfiguration::setSslOption(QSsl::SslOption option, bool on)

supportedCiphers

Signature: [static] QSslCipher[] supportedCiphers

Description: Static method QList<QSslCipher> QSslConfiguration::supportedCiphers()

This method is static and can be called without an instance.

supportedEllipticCurves

Signature: [static] QSslEllipticCurve[] supportedEllipticCurves

Description: Static method QVector<QSslEllipticCurve> QSslConfiguration::supportedEllipticCurves()

This method is static and can be called without an instance.

swap

Signature: void swap (QSslConfiguration other)

Description: Method void QSslConfiguration::swap(QSslConfiguration &other)

systemCaCertificates

Signature: [static] QSslCertificate[] systemCaCertificates

Description: Static method QList<QSslCertificate> QSslConfiguration::systemCaCertificates()

This method is static and can be called without an instance.

testSslOption

Signature: [const] bool testSslOption (const QSsl_SslOption option)

Description: Method bool QSslConfiguration::testSslOption(QSsl::SslOption option)