API reference - Class QSslDiffieHellmanParameters

Notation used in Ruby API documentation

Module: QtNetwork

Description: Binding of QSslDiffieHellmanParameters

Sub-classes: Error, QFlags_Error

Public constructors

new QSslDiffieHellmanParametersnewConstructor QSslDiffieHellmanParameters::QSslDiffieHellmanParameters()
new QSslDiffieHellmanParametersnew(const QSslDiffieHellmanParameters other)Constructor QSslDiffieHellmanParameters::QSslDiffieHellmanParameters(const QSslDiffieHellmanParameters &other)

Public methods

[const]bool!=(const QSslDiffieHellmanParameters rhs)Operator bool ::operator!=(const QSslDiffieHellmanParameters &lhs, const QSslDiffieHellmanParameters &rhs)
[const]bool==(const QSslDiffieHellmanParameters rhs)Operator bool ::operator==(const QSslDiffieHellmanParameters &lhs, const QSslDiffieHellmanParameters &rhs)
void_assign(const QSslDiffieHellmanParameters other)Assigns another object 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.
QSslDiffieHellmanParametersassign(const QSslDiffieHellmanParameters other)Method QSslDiffieHellmanParameters &QSslDiffieHellmanParameters::operator=(const QSslDiffieHellmanParameters &other)
[const]new QSslDiffieHellmanParameters ptrdupCreates a copy of self
[const]QSslDiffieHellmanParameters_ErrorerrorMethod QSslDiffieHellmanParameters::Error QSslDiffieHellmanParameters::error()
[const]stringerrorStringMethod QString QSslDiffieHellmanParameters::errorString()
[const]boolisEmpty?Method bool QSslDiffieHellmanParameters::isEmpty()
[const]boolisValid?Method bool QSslDiffieHellmanParameters::isValid()
voidswap(QSslDiffieHellmanParameters other)Method void QSslDiffieHellmanParameters::swap(QSslDiffieHellmanParameters &other)

Public static methods and constants

[static,const]QSslDiffieHellmanParameters_ErrorInvalidInputDataErrorEnum constant QSslDiffieHellmanParameters::InvalidInputDataError
[static,const]QSslDiffieHellmanParameters_ErrorNoErrorEnum constant QSslDiffieHellmanParameters::NoError
[static,const]QSslDiffieHellmanParameters_ErrorUnsafeParametersErrorEnum constant QSslDiffieHellmanParameters::UnsafeParametersError
QSslDiffieHellmanParametersdefaultParametersStatic method QSslDiffieHellmanParameters QSslDiffieHellmanParameters::defaultParameters()
QSslDiffieHellmanParametersfromEncoded(bytes encoded,
const QSsl_EncodingFormat format = QSsl::Pem)
Static method QSslDiffieHellmanParameters QSslDiffieHellmanParameters::fromEncoded(const QByteArray &encoded, QSsl::EncodingFormat format)
QSslDiffieHellmanParametersfromEncoded(QIODevice ptr device,
const QSsl_EncodingFormat format = QSsl::Pem)
Static method QSslDiffieHellmanParameters QSslDiffieHellmanParameters::fromEncoded(QIODevice *device, QSsl::EncodingFormat format)

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

!=

Signature: [const] bool != (const QSslDiffieHellmanParameters rhs)

Description: Operator bool ::operator!=(const QSslDiffieHellmanParameters &lhs, const QSslDiffieHellmanParameters &rhs)

This is the mapping of the global operator to the instance method.

==

Signature: [const] bool == (const QSslDiffieHellmanParameters rhs)

Description: Operator bool ::operator==(const QSslDiffieHellmanParameters &lhs, const QSslDiffieHellmanParameters &rhs)

This is the mapping of the global operator to the instance method.

InvalidInputDataError

Signature: [static,const] QSslDiffieHellmanParameters_Error InvalidInputDataError

Description: Enum constant QSslDiffieHellmanParameters::InvalidInputDataError

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

NoError

Signature: [static,const] QSslDiffieHellmanParameters_Error NoError

Description: Enum constant QSslDiffieHellmanParameters::NoError

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

UnsafeParametersError

Signature: [static,const] QSslDiffieHellmanParameters_Error UnsafeParametersError

Description: Enum constant QSslDiffieHellmanParameters::UnsafeParametersError

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

_assign

Signature: void _assign (const QSslDiffieHellmanParameters other)

Description: Assigns another object to self

_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: QSslDiffieHellmanParameters assign (const QSslDiffieHellmanParameters other)

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

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.

defaultParameters

Signature: [static] QSslDiffieHellmanParameters defaultParameters

Description: Static method QSslDiffieHellmanParameters QSslDiffieHellmanParameters::defaultParameters()

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

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 QSslDiffieHellmanParameters ptr dup

Description: Creates a copy of self

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

error

Signature: [const] QSslDiffieHellmanParameters_Error error

Description: Method QSslDiffieHellmanParameters::Error QSslDiffieHellmanParameters::error()

errorString

Signature: [const] string errorString

Description: Method QString QSslDiffieHellmanParameters::errorString()

fromEncoded

(1) Signature: [static] QSslDiffieHellmanParameters fromEncoded (bytes encoded, const QSsl_EncodingFormat format = QSsl::Pem)

Description: Static method QSslDiffieHellmanParameters QSslDiffieHellmanParameters::fromEncoded(const QByteArray &encoded, QSsl::EncodingFormat format)

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

(2) Signature: [static] QSslDiffieHellmanParameters fromEncoded (QIODevice ptr device, const QSsl_EncodingFormat format = QSsl::Pem)

Description: Static method QSslDiffieHellmanParameters QSslDiffieHellmanParameters::fromEncoded(QIODevice *device, QSsl::EncodingFormat format)

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

isEmpty?

Signature: [const] bool isEmpty?

Description: Method bool QSslDiffieHellmanParameters::isEmpty()

isValid?

Signature: [const] bool isValid?

Description: Method bool QSslDiffieHellmanParameters::isValid()

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

(1) Signature: [static] new QSslDiffieHellmanParameters new

Description: Constructor QSslDiffieHellmanParameters::QSslDiffieHellmanParameters()

This method creates an object of class QSslDiffieHellmanParameters.

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

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

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

This method creates an object of class QSslDiffieHellmanParameters.

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

swap

Signature: void swap (QSslDiffieHellmanParameters other)

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