API reference - Class QDtls

HandshakeComplete

Signature: [static,const] QDtls_HandshakeState HandshakeComplete

Description: Enum constant QDtls::HandshakeComplete

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

HandshakeInProgress

Signature: [static,const] QDtls_HandshakeState HandshakeInProgress

Description: Enum constant QDtls::HandshakeInProgress

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

HandshakeNotStarted

Signature: [static,const] QDtls_HandshakeState HandshakeNotStarted

Description: Enum constant QDtls::HandshakeNotStarted

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

PeerVerificationFailed

Signature: [static,const] QDtls_HandshakeState PeerVerificationFailed

Description: Enum constant QDtls::PeerVerificationFailed

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

_const_cast

Signature: [const] QDtls 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.

abortHandshake

Signature: bool abortHandshake (QUdpSocket ptr socket)

Description: Method bool QDtls::abortHandshake(QUdpSocket *socket)

childEvent

Signature: void childEvent (QChildEvent ptr event)

Description: Virtual method void QDtls::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

cookieGeneratorParameters

Signature: [const] QDtlsClientVerifier_GeneratorParameters cookieGeneratorParameters

Description: Method QDtls::GeneratorParameters QDtls::cookieGeneratorParameters()

customEvent

Signature: void customEvent (QEvent ptr event)

Description: Virtual method void QDtls::customEvent(QEvent *event)

This method can be reimplemented in a derived class.

decryptDatagram

Signature: bytes decryptDatagram (QUdpSocket ptr socket, bytes dgram)

Description: Method QByteArray QDtls::decryptDatagram(QUdpSocket *socket, const QByteArray &dgram)

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QDtls::destroyed(QObject *)

You can bind a procedure to this signal.

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

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QDtls::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

doHandshake

Signature: bool doHandshake (QUdpSocket ptr socket, bytes dgram = {})

Description: Method bool QDtls::doHandshake(QUdpSocket *socket, const QByteArray &dgram)

dtlsConfiguration

Signature: [const] QSslConfiguration dtlsConfiguration

Description: Method QSslConfiguration QDtls::dtlsConfiguration()

dtlsError

Signature: [const] QDtlsError dtlsError

Description: Method QDtlsError QDtls::dtlsError()

dtlsErrorString

Signature: [const] string dtlsErrorString

Description: Method QString QDtls::dtlsErrorString()

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QDtls::destroyed(QObject *)

Call this method to emit this signal.

emit_handshakeTimeout

Signature: void emit_handshakeTimeout

Description: Emitter for signal void QDtls::handshakeTimeout()

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QDtls::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

emit_pskRequired

Signature: void emit_pskRequired (QSslPreSharedKeyAuthenticator ptr authenticator)

Description: Emitter for signal void QDtls::pskRequired(QSslPreSharedKeyAuthenticator *authenticator)

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QDtls::event(QEvent *event)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr watched, QEvent ptr event)

Description: Virtual method bool QDtls::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

handleTimeout

Signature: bool handleTimeout (QUdpSocket ptr socket)

Description: Method bool QDtls::handleTimeout(QUdpSocket *socket)

handshakeState

Signature: [const] QDtls_HandshakeState handshakeState

Description: Method QDtls::HandshakeState QDtls::handshakeState()

handshakeTimeout

Signature: [signal] void handshakeTimeout

Description: Signal declaration for QDtls::handshakeTimeout()

You can bind a procedure to this signal.

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

ignoreVerificationErrors

Signature: void ignoreVerificationErrors (QSslError[] errorsToIgnore)

Description: Method void QDtls::ignoreVerificationErrors(const QVector<QSslError> &errorsToIgnore)

isConnectionEncrypted?

Signature: [const] bool isConnectionEncrypted?

Description: Method bool QDtls::isConnectionEncrypted()

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QDtls::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

mtuHint

Signature: [const] unsigned short mtuHint

Description: Method quint16 QDtls::mtuHint()

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

mtuHint=

Signature: void mtuHint= (unsigned short mtuHint)

Description: Method void QDtls::setMtuHint(quint16 mtuHint)

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

new

Signature: [static] new QDtls new (const QSslSocket_SslMode mode, QObject ptr parent = nullptr)

Description: Constructor QDtls::QDtls(QSslSocket::SslMode mode, QObject *parent)

This method creates an object of class QDtls.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QDtls::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

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

peerAddress

Signature: [const] QHostAddress peerAddress

Description: Method QHostAddress QDtls::peerAddress()

peerPort

Signature: [const] unsigned short peerPort

Description: Method quint16 QDtls::peerPort()

peerVerificationErrors

Signature: [const] QSslError[] peerVerificationErrors

Description: Method QVector<QSslError> QDtls::peerVerificationErrors()

peerVerificationName

Signature: [const] string peerVerificationName

Description: Method QString QDtls::peerVerificationName()

pskRequired

Signature: [signal] void pskRequired (QSslPreSharedKeyAuthenticator ptr authenticator)

Description: Signal declaration for QDtls::pskRequired(QSslPreSharedKeyAuthenticator *authenticator)

You can bind a procedure to this signal.

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

receivers

Signature: [const] int receivers (string signal)

Description: Method int QDtls::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

resumeHandshake

Signature: bool resumeHandshake (QUdpSocket ptr socket)

Description: Method bool QDtls::resumeHandshake(QUdpSocket *socket)

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QDtls::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QDtls::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

sessionCipher

Signature: [const] QSslCipher sessionCipher

Description: Method QSslCipher QDtls::sessionCipher()

sessionProtocol

Signature: [const] QSsl_SslProtocol sessionProtocol

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

setCookieGeneratorParameters

Signature: bool setCookieGeneratorParameters (const QDtlsClientVerifier_GeneratorParameters params)

Description: Method bool QDtls::setCookieGeneratorParameters(const QDtls::GeneratorParameters &params)

setDtlsConfiguration

Signature: bool setDtlsConfiguration (const QSslConfiguration configuration)

Description: Method bool QDtls::setDtlsConfiguration(const QSslConfiguration &configuration)

setMtuHint

Signature: void setMtuHint (unsigned short mtuHint)

Description: Method void QDtls::setMtuHint(quint16 mtuHint)

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

setPeer

Signature: bool setPeer (const QHostAddress address, unsigned short port, string verificationName = {})

Description: Method bool QDtls::setPeer(const QHostAddress &address, quint16 port, const QString &verificationName)

setPeerVerificationName

Signature: bool setPeerVerificationName (string name)

Description: Method bool QDtls::setPeerVerificationName(const QString &name)

shutdown

Signature: bool shutdown (QUdpSocket ptr socket)

Description: Method bool QDtls::shutdown(QUdpSocket *socket)

sslMode

Signature: [const] QSslSocket_SslMode sslMode

Description: Method QSslSocket::SslMode QDtls::sslMode()

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QDtls::timerEvent(QTimerEvent *event)

This method can be reimplemented in a derived class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QDtls::tr(const char *s, const char *c, int n)

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

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QDtls::trUtf8(const char *s, const char *c, int n)

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

writeDatagramEncrypted

Signature: long long writeDatagramEncrypted (QUdpSocket ptr socket, bytes dgram)

Description: Method qint64 QDtls::writeDatagramEncrypted(QUdpSocket *socket, const QByteArray &dgram)