KLayout Manual: Main Index » Class Index » API reference - Class QSslSocket

API reference - Class QSslSocket

Notation used in Ruby API documentation

Description: Binding of QSslSocket

Class hierarchy: QSslSocket » QTcpSocket » QAbstractSocket » QIODevice » QObject

Sub-classes: PeerVerifyMode, SslMode

• Public constructors
• Public methods
• Public static methods and constants
• Deprecated methods (protected, public, static, non-static and constructors)
• Detailed description

Public constructors

Public methods

Public static methods and constants

Deprecated methods (protected, public, static, non-static and constructors)

Detailed description

[static,const] new QSslSocket_PeerVerifyMode ptr AutoVerifyPeer

Description: Enum constant QSslSocket::AutoVerifyPeer

[static,const] new QSslSocket_PeerVerifyMode ptr QueryPeer

Description: Enum constant QSslSocket::QueryPeer

[static,const] new QSslSocket_SslMode ptr SslClientMode

Description: Enum constant QSslSocket::SslClientMode

[static,const] new QSslSocket_SslMode ptr SslServerMode

Description: Enum constant QSslSocket::SslServerMode

[static,const] new QSslSocket_SslMode ptr UnencryptedMode

Description: Enum constant QSslSocket::UnencryptedMode

[static,const] new QSslSocket_PeerVerifyMode ptr VerifyNone

Description: Enum constant QSslSocket::VerifyNone

[static,const] new QSslSocket_PeerVerifyMode ptr VerifyPeer

Description: Enum constant QSslSocket::VerifyPeer

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.

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.

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

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

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.

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.

void abort

Description: Method void QSslSocket::abort()

[event] void aboutToClose

Description: Signal declaration for QSslSocket::aboutToClose()

You can bind a procedure to this signal.

void addCaCertificate(const QSslCertificate certificate)

Description: Method void QSslSocket::addCaCertificate(const QSslCertificate &certificate)

bool addCaCertificates(string path,const QSsl_EncodingFormat format = QSsl::Pem,const QRegExp_PatternSyntax syntax = QRegExp::FixedString)

Description: Method bool QSslSocket::addCaCertificates(const QString &path, QSsl::EncodingFormat format, QRegExp::PatternSyntax syntax)

void addCaCertificates(QSslCertificate[] certificates)

Description: Method void QSslSocket::addCaCertificates(const QList<QSslCertificate> &certificates)

[static] void addDefaultCaCertificate(const QSslCertificate certificate)

Description: Static method void QSslSocket::addDefaultCaCertificate(const QSslCertificate &certificate)

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

[static] bool addDefaultCaCertificates(string path,const QSsl_EncodingFormat format = QSsl::Pem,const QRegExp_PatternSyntax syntax = QRegExp::FixedString)

Description: Static method bool QSslSocket::addDefaultCaCertificates(const QString &path, QSsl::EncodingFormat format, QRegExp::PatternSyntax syntax)

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

[static] void addDefaultCaCertificates(QSslCertificate[] certificates)

Description: Static method void QSslSocket::addDefaultCaCertificates(const QList<QSslCertificate> &certificates)

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

[const] bool atEnd

Description: Method bool QSslSocket::atEnd()

This is a reimplementation of QAbstractSocket::atEnd

[const] long long bytesAvailable

Description: Method qint64 QSslSocket::bytesAvailable()

This is a reimplementation of QAbstractSocket::bytesAvailable

[const] long long bytesToWrite

Description: Method qint64 QSslSocket::bytesToWrite()

This is a reimplementation of QAbstractSocket::bytesToWrite

[event] void bytesWritten(long long bytes)

Description: Signal declaration for QSslSocket::bytesWritten(qint64 bytes)

You can bind a procedure to this signal.

[const] QSslCertificate[] caCertificates

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

Python specific notes:

The object exposes a readable attribute 'caCertificates'. This is the getter.

void caCertificates=(QSslCertificate[] certificates)

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

Python specific notes:

The object exposes a writable attribute 'caCertificates'. This is the setter.

[const] bool canReadLine

Description: Method bool QSslSocket::canReadLine()

This is a reimplementation of QAbstractSocket::canReadLine

[const] QSslCipher[] ciphers

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

Python specific notes:

The object exposes a readable attribute 'ciphers'. This is the getter.

void ciphers=(QSslCipher[] ciphers)

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

Python specific notes:

The object exposes a writable attribute 'ciphers'. This is the setter.

void ciphers=(string ciphers)

Description: Method void QSslSocket::setCiphers(const QString &ciphers)

Python specific notes:

The object exposes a writable attribute 'ciphers'. This is the setter.

void close

Description: Method void QSslSocket::close()

This is a reimplementation of QAbstractSocket::close

void connectToHostEncrypted(string hostName,unsigned short port,const QIODevice_QFlags_OpenModeFlag mode = QIODevice::ReadWrite)

Description: Method void QSslSocket::connectToHostEncrypted(const QString &hostName, quint16 port, QFlags<QIODevice::OpenModeFlag> mode)

void connectToHostEncrypted(string hostName,unsigned short port,string sslPeerName,const QIODevice_QFlags_OpenModeFlag mode = QIODevice::ReadWrite)

Description: Method void QSslSocket::connectToHostEncrypted(const QString &hostName, quint16 port, const QString &sslPeerName, QFlags<QIODevice::OpenModeFlag> mode)

[event] void connected

Description: Signal declaration for QSslSocket::connected()

You can bind a procedure to this signal.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[static] QSslCertificate[] defaultCaCertificates

Description: Static method QList<QSslCertificate> QSslSocket::defaultCaCertificates()

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

Python specific notes:

The object exposes a readable attribute 'defaultCaCertificates'. This is the getter.

[static] void defaultCaCertificates=(QSslCertificate[] certificates)

Description: Static method void QSslSocket::setDefaultCaCertificates(const QList<QSslCertificate> &certificates)

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

Python specific notes:

The object exposes a writable attribute 'defaultCaCertificates'. This is the setter.

[static] QSslCipher[] defaultCiphers

Description: Static method QList<QSslCipher> QSslSocket::defaultCiphers()

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

Python specific notes:

The object exposes a readable attribute 'defaultCiphers'. This is the getter.

[static] void defaultCiphers=(QSslCipher[] ciphers)

Description: Static method void QSslSocket::setDefaultCiphers(const QList<QSslCipher> &ciphers)

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

Python specific notes:

The object exposes a writable attribute 'defaultCiphers'. This is the setter.

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[event] void destroyed(QObject ptr arg1)

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

You can bind a procedure to this signal.

[event] void disconnected

Description: Signal declaration for QSslSocket::disconnected()

You can bind a procedure to this signal.

[event] void encrypted

Description: Signal declaration for QSslSocket::encrypted()

You can bind a procedure to this signal.

[const] long long encryptedBytesAvailable

Description: Method qint64 QSslSocket::encryptedBytesAvailable()

[const] long long encryptedBytesToWrite

Description: Method qint64 QSslSocket::encryptedBytesToWrite()

[event] void encryptedBytesWritten(long long totalBytes)

Description: Signal declaration for QSslSocket::encryptedBytesWritten(qint64 totalBytes)

You can bind a procedure to this signal.

[event] void error(const QAbstractSocket_SocketError arg1)

Description: Signal declaration for QSslSocket::error(QAbstractSocket::SocketError)

You can bind a procedure to this signal.

bool flush

Description: Method bool QSslSocket::flush()

[event] void hostFound

Description: Signal declaration for QSslSocket::hostFound()

You can bind a procedure to this signal.

void ignoreSslErrors(QSslError[] errors)

Description: Method void QSslSocket::ignoreSslErrors(const QList<QSslError> &errors)

void ignoreSslErrors

Description: Method void QSslSocket::ignoreSslErrors()

[const] bool isEncrypted?

Description: Method bool QSslSocket::isEncrypted()

[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

[const] QSslCertificate localCertificate

Description: Method QSslCertificate QSslSocket::localCertificate()

Python specific notes:

The object exposes a readable attribute 'localCertificate'. This is the getter.

void localCertificate=(const QSslCertificate certificate)

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

Python specific notes:

The object exposes a writable attribute 'localCertificate'. This is the setter.

[const] QSslSocket_SslMode mode

Description: Method QSslSocket::SslMode QSslSocket::mode()

[event] void modeChanged(const QSslSocket_SslMode newMode)

Description: Signal declaration for QSslSocket::modeChanged(QSslSocket::SslMode newMode)

You can bind a procedure to this signal.

[static] new QSslSocket new(QObject ptr parent = 0)

Description: Constructor QSslSocket::QSslSocket(QObject *parent)

This method creates an object of class QSslSocket.

Python specific notes:

This method is the default initializer of the object

[const] QSslCertificate peerCertificate

Description: Method QSslCertificate QSslSocket::peerCertificate()

[const] QSslCertificate[] peerCertificateChain

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

[const] int peerVerifyDepth

Description: Method int QSslSocket::peerVerifyDepth()

Python specific notes:

The object exposes a readable attribute 'peerVerifyDepth'. This is the getter.

void peerVerifyDepth=(int depth)

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

Python specific notes:

The object exposes a writable attribute 'peerVerifyDepth'. This is the setter.

[event] void peerVerifyError(const QSslError error)

Description: Signal declaration for QSslSocket::peerVerifyError(const QSslError &error)

You can bind a procedure to this signal.

[const] QSslSocket_PeerVerifyMode peerVerifyMode

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

Python specific notes:

The object exposes a readable attribute 'peerVerifyMode'. This is the getter.

void peerVerifyMode=(const QSslSocket_PeerVerifyMode mode)

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

Python specific notes:

The object exposes a writable attribute 'peerVerifyMode'. This is the setter.

[const] QSslKey privateKey

Description: Method QSslKey QSslSocket::privateKey()

Python specific notes:

The object exposes a readable attribute 'privateKey'. This is the getter.

void privateKey=(const QSslKey key)

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

Python specific notes:

The object exposes a writable attribute 'privateKey'. This is the setter.

[const] QSsl_SslProtocol protocol

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

Python specific notes:

The object exposes a readable attribute 'protocol'. This is the getter.

void protocol=(const QSsl_SslProtocol protocol)

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

Python specific notes:

The object exposes a writable attribute 'protocol'. This is the setter.

[event] void proxyAuthenticationRequired(const QNetworkProxy proxy,QAuthenticator ptr authenticator)

Description: Signal declaration for QSslSocket::proxyAuthenticationRequired(const QNetworkProxy &proxy, QAuthenticator *authenticator)

You can bind a procedure to this signal.

void readBufferSize=(long long size)

Description: Method void QSslSocket::setReadBufferSize(qint64 size)

Python specific notes:

The object exposes a writable attribute 'readBufferSize'. This is the setter.

[event] void readChannelFinished

Description: Signal declaration for QSslSocket::readChannelFinished()

You can bind a procedure to this signal.

[event] void readyRead

Description: Signal declaration for QSslSocket::readyRead()

You can bind a procedure to this signal.

[const] QSslCipher sessionCipher

Description: Method QSslCipher QSslSocket::sessionCipher()

void setCaCertificates(QSslCertificate[] certificates)

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

Python specific notes:

The object exposes a writable attribute 'caCertificates'. This is the setter.

void setCiphers(QSslCipher[] ciphers)

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

Python specific notes:

The object exposes a writable attribute 'ciphers'. This is the setter.

void setCiphers(string ciphers)

Description: Method void QSslSocket::setCiphers(const QString &ciphers)

Python specific notes:

The object exposes a writable attribute 'ciphers'. This is the setter.

[static] void setDefaultCaCertificates(QSslCertificate[] certificates)

Description: Static method void QSslSocket::setDefaultCaCertificates(const QList<QSslCertificate> &certificates)

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

Python specific notes:

The object exposes a writable attribute 'defaultCaCertificates'. This is the setter.

[static] void setDefaultCiphers(QSslCipher[] ciphers)

Description: Static method void QSslSocket::setDefaultCiphers(const QList<QSslCipher> &ciphers)

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

Python specific notes:

The object exposes a writable attribute 'defaultCiphers'. This is the setter.

void setLocalCertificate(const QSslCertificate certificate)

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

Python specific notes:

The object exposes a writable attribute 'localCertificate'. This is the setter.

void setLocalCertificate(string fileName,const QSsl_EncodingFormat format = QSsl::Pem)

Description: Method void QSslSocket::setLocalCertificate(const QString &fileName, QSsl::EncodingFormat format)

void setPeerVerifyDepth(int depth)

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

Python specific notes:

The object exposes a writable attribute 'peerVerifyDepth'. This is the setter.

void setPeerVerifyMode(const QSslSocket_PeerVerifyMode mode)

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

Python specific notes:

The object exposes a writable attribute 'peerVerifyMode'. This is the setter.

void setPrivateKey(const QSslKey key)

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

Python specific notes:

The object exposes a writable attribute 'privateKey'. This is the setter.

void setPrivateKey(string fileName,const QSsl_KeyAlgorithm algorithm = QSsl::Rsa,const QSsl_EncodingFormat format = QSsl::Pem,string passPhrase = QByteArray())

Description: Method void QSslSocket::setPrivateKey(const QString &fileName, QSsl::KeyAlgorithm algorithm, QSsl::EncodingFormat format, const QByteArray &passPhrase)

void setProtocol(const QSsl_SslProtocol protocol)

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

Python specific notes:

The object exposes a writable attribute 'protocol'. This is the setter.

void setReadBufferSize(long long size)

Description: Method void QSslSocket::setReadBufferSize(qint64 size)

Python specific notes:

The object exposes a writable attribute 'readBufferSize'. This is the setter.

bool setSocketDescriptor(int socketDescriptor,const QAbstractSocket_SocketState state = QAbstractSocket::ConnectedState,const QIODevice_QFlags_OpenModeFlag openMode = QIODevice::ReadWrite)

Description: Method bool QSslSocket::setSocketDescriptor(int socketDescriptor, QAbstractSocket::SocketState state, QFlags<QIODevice::OpenModeFlag> openMode)

void setSocketOption(const QAbstractSocket_SocketOption option,const QVariant value)

Description: Method void QSslSocket::setSocketOption(QAbstractSocket::SocketOption option, const QVariant &value)

void setSslConfiguration(const QSslConfiguration config)

Description: Method void QSslSocket::setSslConfiguration(const QSslConfiguration &config)

Python specific notes:

The object exposes a writable attribute 'sslConfiguration'. This is the setter.

QVariant socketOption(const QAbstractSocket_SocketOption option)

Description: Method QVariant QSslSocket::socketOption(QAbstractSocket::SocketOption option)

[const] QSslConfiguration sslConfiguration

Description: Method QSslConfiguration QSslSocket::sslConfiguration()

Python specific notes:

The object exposes a readable attribute 'sslConfiguration'. This is the getter.

void sslConfiguration=(const QSslConfiguration config)

Description: Method void QSslSocket::setSslConfiguration(const QSslConfiguration &config)

Python specific notes:

The object exposes a writable attribute 'sslConfiguration'. This is the setter.

[const] QSslError[] sslErrors

Description: Method QList<QSslError> QSslSocket::sslErrors()

[event] void sslErrors(QSslError[] errors)

Description: Signal declaration for QSslSocket::sslErrors(const QList<QSslError> &errors)

You can bind a procedure to this signal.

void startClientEncryption

Description: Method void QSslSocket::startClientEncryption()

void startServerEncryption

Description: Method void QSslSocket::startServerEncryption()

[event] void stateChanged(const QAbstractSocket_SocketState arg1)

Description: Signal declaration for QSslSocket::stateChanged(QAbstractSocket::SocketState)

You can bind a procedure to this signal.

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[static] QSslCipher[] supportedCiphers

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

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

[static] bool supportsSsl

Description: Static method bool QSslSocket::supportsSsl()

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

[static] QSslCertificate[] systemCaCertificates

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

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

[static] string tr(string s,string c = 0)

Description: Static method QString QSslSocket::tr(const char *s, const char *c)

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

[static] string tr(string s,string c,int n)

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

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

[static] string trUtf8(string s,string c = 0)

Description: Static method QString QSslSocket::trUtf8(const char *s, const char *c)

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

[static] string trUtf8(string s,string c,int n)

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

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

bool waitForBytesWritten(int msecs = 30000)

Description: Method bool QSslSocket::waitForBytesWritten(int msecs)

This is a reimplementation of QAbstractSocket::waitForBytesWritten

bool waitForConnected(int msecs = 30000)

Description: Method bool QSslSocket::waitForConnected(int msecs)

bool waitForDisconnected(int msecs = 30000)

Description: Method bool QSslSocket::waitForDisconnected(int msecs)

bool waitForEncrypted(int msecs = 30000)

Description: Method bool QSslSocket::waitForEncrypted(int msecs)

bool waitForReadyRead(int msecs = 30000)

Description: Method bool QSslSocket::waitForReadyRead(int msecs)

This is a reimplementation of QAbstractSocket::waitForReadyRead