API reference - Class QSsl

Notation used in Ruby API documentation

Module: QtNetwork

Description: This class represents the QSsl namespace

Sub-classes: AlternativeNameEntryType, QFlags_AlternativeNameEntryType, EncodingFormat, QFlags_EncodingFormat, KeyAlgorithm, QFlags_KeyAlgorithm, KeyType, QFlags_KeyType, SslOption, QFlags_SslOption, SslProtocol, QFlags_SslProtocol

Public constructors

new QSsl ptrnewCreates a new object of this class

Public methods

[const]QSsl ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
voidassign(const QSsl other)Assigns another object to self
[const]new QSsl ptrdupCreates a copy of self

Public static methods and constants

[static,const]QSsl_SslProtocolAnyProtocolEnum constant QSsl::AnyProtocol
[static,const]QSsl_EncodingFormatDerEnum constant QSsl::Der
[static,const]QSsl_AlternativeNameEntryTypeDnsEntryEnum constant QSsl::DnsEntry
[static,const]QSsl_KeyAlgorithmDsaEnum constant QSsl::Dsa
[static,const]QSsl_SslProtocolDtlsV1_0Enum constant QSsl::DtlsV1_0
[static,const]QSsl_SslProtocolDtlsV1_0OrLaterEnum constant QSsl::DtlsV1_0OrLater
[static,const]QSsl_SslProtocolDtlsV1_2Enum constant QSsl::DtlsV1_2
[static,const]QSsl_SslProtocolDtlsV1_2OrLaterEnum constant QSsl::DtlsV1_2OrLater
[static,const]QSsl_KeyAlgorithmEcEnum constant QSsl::Ec
[static,const]QSsl_AlternativeNameEntryTypeEmailEntryEnum constant QSsl::EmailEntry
[static,const]QSsl_KeyAlgorithmOpaqueEnum constant QSsl::Opaque
[static,const]QSsl_EncodingFormatPemEnum constant QSsl::Pem
[static,const]QSsl_KeyTypePrivateKeyEnum constant QSsl::PrivateKey
[static,const]QSsl_KeyTypePublicKeyEnum constant QSsl::PublicKey
[static,const]QSsl_KeyAlgorithmRsaEnum constant QSsl::Rsa
[static,const]QSsl_SslProtocolSecureProtocolsEnum constant QSsl::SecureProtocols
[static,const]QSsl_SslOptionSslOptionDisableCompressionEnum constant QSsl::SslOptionDisableCompression
[static,const]QSsl_SslOptionSslOptionDisableEmptyFragmentsEnum constant QSsl::SslOptionDisableEmptyFragments
[static,const]QSsl_SslOptionSslOptionDisableLegacyRenegotiationEnum constant QSsl::SslOptionDisableLegacyRenegotiation
[static,const]QSsl_SslOptionSslOptionDisableServerCipherPreferenceEnum constant QSsl::SslOptionDisableServerCipherPreference
[static,const]QSsl_SslOptionSslOptionDisableServerNameIndicationEnum constant QSsl::SslOptionDisableServerNameIndication
[static,const]QSsl_SslOptionSslOptionDisableSessionPersistenceEnum constant QSsl::SslOptionDisableSessionPersistence
[static,const]QSsl_SslOptionSslOptionDisableSessionSharingEnum constant QSsl::SslOptionDisableSessionSharing
[static,const]QSsl_SslOptionSslOptionDisableSessionTicketsEnum constant QSsl::SslOptionDisableSessionTickets
[static,const]QSsl_SslProtocolSslV2Enum constant QSsl::SslV2
[static,const]QSsl_SslProtocolSslV3Enum constant QSsl::SslV3
[static,const]QSsl_SslProtocolTlsV1SslV3Enum constant QSsl::TlsV1SslV3
[static,const]QSsl_SslProtocolTlsV1_0Enum constant QSsl::TlsV1_0
[static,const]QSsl_SslProtocolTlsV1_0OrLaterEnum constant QSsl::TlsV1_0OrLater
[static,const]QSsl_SslProtocolTlsV1_1Enum constant QSsl::TlsV1_1
[static,const]QSsl_SslProtocolTlsV1_1OrLaterEnum constant QSsl::TlsV1_1OrLater
[static,const]QSsl_SslProtocolTlsV1_2Enum constant QSsl::TlsV1_2
[static,const]QSsl_SslProtocolTlsV1_2OrLaterEnum constant QSsl::TlsV1_2OrLater
[static,const]QSsl_SslProtocolTlsV1_3Enum constant QSsl::TlsV1_3
[static,const]QSsl_SslProtocolTlsV1_3OrLaterEnum constant QSsl::TlsV1_3OrLater
[static,const]QSsl_SslProtocolUnknownProtocolEnum constant QSsl::UnknownProtocol

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

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

AnyProtocol

Signature: [static,const] QSsl_SslProtocol AnyProtocol

Description: Enum constant QSsl::AnyProtocol

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

Der

Signature: [static,const] QSsl_EncodingFormat Der

Description: Enum constant QSsl::Der

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

DnsEntry

Signature: [static,const] QSsl_AlternativeNameEntryType DnsEntry

Description: Enum constant QSsl::DnsEntry

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

Dsa

Signature: [static,const] QSsl_KeyAlgorithm Dsa

Description: Enum constant QSsl::Dsa

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

DtlsV1_0

Signature: [static,const] QSsl_SslProtocol DtlsV1_0

Description: Enum constant QSsl::DtlsV1_0

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

DtlsV1_0OrLater

Signature: [static,const] QSsl_SslProtocol DtlsV1_0OrLater

Description: Enum constant QSsl::DtlsV1_0OrLater

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

DtlsV1_2

Signature: [static,const] QSsl_SslProtocol DtlsV1_2

Description: Enum constant QSsl::DtlsV1_2

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

DtlsV1_2OrLater

Signature: [static,const] QSsl_SslProtocol DtlsV1_2OrLater

Description: Enum constant QSsl::DtlsV1_2OrLater

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

Ec

Signature: [static,const] QSsl_KeyAlgorithm Ec

Description: Enum constant QSsl::Ec

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

EmailEntry

Signature: [static,const] QSsl_AlternativeNameEntryType EmailEntry

Description: Enum constant QSsl::EmailEntry

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

Opaque

Signature: [static,const] QSsl_KeyAlgorithm Opaque

Description: Enum constant QSsl::Opaque

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

Pem

Signature: [static,const] QSsl_EncodingFormat Pem

Description: Enum constant QSsl::Pem

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

PrivateKey

Signature: [static,const] QSsl_KeyType PrivateKey

Description: Enum constant QSsl::PrivateKey

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

PublicKey

Signature: [static,const] QSsl_KeyType PublicKey

Description: Enum constant QSsl::PublicKey

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

Rsa

Signature: [static,const] QSsl_KeyAlgorithm Rsa

Description: Enum constant QSsl::Rsa

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

SecureProtocols

Signature: [static,const] QSsl_SslProtocol SecureProtocols

Description: Enum constant QSsl::SecureProtocols

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

SslOptionDisableCompression

Signature: [static,const] QSsl_SslOption SslOptionDisableCompression

Description: Enum constant QSsl::SslOptionDisableCompression

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

SslOptionDisableEmptyFragments

Signature: [static,const] QSsl_SslOption SslOptionDisableEmptyFragments

Description: Enum constant QSsl::SslOptionDisableEmptyFragments

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

SslOptionDisableLegacyRenegotiation

Signature: [static,const] QSsl_SslOption SslOptionDisableLegacyRenegotiation

Description: Enum constant QSsl::SslOptionDisableLegacyRenegotiation

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

SslOptionDisableServerCipherPreference

Signature: [static,const] QSsl_SslOption SslOptionDisableServerCipherPreference

Description: Enum constant QSsl::SslOptionDisableServerCipherPreference

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

SslOptionDisableServerNameIndication

Signature: [static,const] QSsl_SslOption SslOptionDisableServerNameIndication

Description: Enum constant QSsl::SslOptionDisableServerNameIndication

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

SslOptionDisableSessionPersistence

Signature: [static,const] QSsl_SslOption SslOptionDisableSessionPersistence

Description: Enum constant QSsl::SslOptionDisableSessionPersistence

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

SslOptionDisableSessionSharing

Signature: [static,const] QSsl_SslOption SslOptionDisableSessionSharing

Description: Enum constant QSsl::SslOptionDisableSessionSharing

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

SslOptionDisableSessionTickets

Signature: [static,const] QSsl_SslOption SslOptionDisableSessionTickets

Description: Enum constant QSsl::SslOptionDisableSessionTickets

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

SslV2

Signature: [static,const] QSsl_SslProtocol SslV2

Description: Enum constant QSsl::SslV2

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

SslV3

Signature: [static,const] QSsl_SslProtocol SslV3

Description: Enum constant QSsl::SslV3

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

TlsV1SslV3

Signature: [static,const] QSsl_SslProtocol TlsV1SslV3

Description: Enum constant QSsl::TlsV1SslV3

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

TlsV1_0

Signature: [static,const] QSsl_SslProtocol TlsV1_0

Description: Enum constant QSsl::TlsV1_0

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

TlsV1_0OrLater

Signature: [static,const] QSsl_SslProtocol TlsV1_0OrLater

Description: Enum constant QSsl::TlsV1_0OrLater

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

TlsV1_1

Signature: [static,const] QSsl_SslProtocol TlsV1_1

Description: Enum constant QSsl::TlsV1_1

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

TlsV1_1OrLater

Signature: [static,const] QSsl_SslProtocol TlsV1_1OrLater

Description: Enum constant QSsl::TlsV1_1OrLater

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

TlsV1_2

Signature: [static,const] QSsl_SslProtocol TlsV1_2

Description: Enum constant QSsl::TlsV1_2

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

TlsV1_2OrLater

Signature: [static,const] QSsl_SslProtocol TlsV1_2OrLater

Description: Enum constant QSsl::TlsV1_2OrLater

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

TlsV1_3

Signature: [static,const] QSsl_SslProtocol TlsV1_3

Description: Enum constant QSsl::TlsV1_3

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

TlsV1_3OrLater

Signature: [static,const] QSsl_SslProtocol TlsV1_3OrLater

Description: Enum constant QSsl::TlsV1_3OrLater

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

UnknownProtocol

Signature: [static,const] QSsl_SslProtocol UnknownProtocol

Description: Enum constant QSsl::UnknownProtocol

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

_const_cast

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

assign

Signature: void assign (const QSsl other)

Description: Assigns another object to self

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.

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.

dup

Signature: [const] new QSsl ptr dup

Description: Creates a copy of self

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

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.

new

Signature: [static] new QSsl ptr new

Description: Creates a new object of this class

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