Optionalproperties: Partial<Gck.Session.ConstructorProps>Internal$signalsCompile-time signal type information.
This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.
Static$gtypeConstruct Onlyapp_Raw PKCS#11 application data used to open the PKCS#11 session.
Construct OnlyappRaw PKCS#11 application data used to open the PKCS#11 session.
Construct OnlyhandleInteraction object used to ask the user for pins when opening sessions. Used if the session_options of the enumerator have Gck.SessionOptions.LOGIN_USER
Read-OnlymoduleConstruct Onlyopening_Construct OnlyopeningConstruct OnlyoptionsThe options this session was opened with.
Construct OnlyslotSignalconnectSignalconnect_Create a new PKCS#11 object. This call may block for an indefinite period.
The attributes to create the object with.
Optional cancellation object, or null.
the newly created object or null if an error occurred
Create a new PKCS#11 object. This call will return immediately and complete asynchronously.
If attrs is a floating reference, it is consumed.
The attributes to create the object with.
Optional cancellation object or null.
Create a new PKCS#11 object. This call will return immediately and complete asynchronously.
If attrs is a floating reference, it is consumed.
The attributes to create the object with.
Optional cancellation object or null.
Called when the operation completes.
Create a new PKCS#11 object. This call will return immediately and complete asynchronously.
If attrs is a floating reference, it is consumed.
The attributes to create the object with.
Optional cancellation object or null.
Optionalcallback: AsyncReadyCallback<Gck.Session> | nullCalled when the operation completes.
Get the result of creating a new PKCS#11 object.
The result passed to the callback.
the newly created object or null if an error occurred
Decrypt data in a mechanism specific manner. This call may block for an indefinite period.
The key to decrypt with.
The mechanism type to use for decryption.
data to decrypt
Optional cancellation object, or null
the data that was decrypted, or null if an error occured
Decrypt data in a mechanism specific manner. This call will return immediately and complete asynchronously.
The key to decrypt with.
The mechanism type and parameters to use for decryption.
data to decrypt
A GCancellable which can be used to cancel the operation.
Decrypt data in a mechanism specific manner. This call will return immediately and complete asynchronously.
The key to decrypt with.
The mechanism type and parameters to use for decryption.
data to decrypt
A GCancellable which can be used to cancel the operation.
Called when the operation completes.
Decrypt data in a mechanism specific manner. This call will return immediately and complete asynchronously.
The key to decrypt with.
The mechanism type and parameters to use for decryption.
data to decrypt
A GCancellable which can be used to cancel the operation.
Optionalcallback: AsyncReadyCallback<Gck.Session> | nullCalled when the operation completes.
Get the result of an decryption operation.
The result object passed to the callback.
the data that was decrypted, or null if an error occurred
Decrypt data in a mechanism specific manner. This call may block for an indefinite period.
The key to decrypt with.
The mechanism type and parameters to use for decryption.
data to decrypt
A GCancellable which can be used to cancel the operation.
the data that was decrypted, or null if an error occured
Derive a key from another key. This call may block for an indefinite period.
If the attrs Gck.Attributes is floating, it is consumed.
The key to derive from.
The mechanism to use for derivation.
Additional attributes for the derived key.
Optional cancellation object, or null.
the new derived key or null if the operation failed
Derive a key from another key. This call will return immediately and complete asynchronously.
The key to derive from.
The mechanism to use for derivation.
Additional attributes for the derived key.
Optional cancellation object or null.
Derive a key from another key. This call will return immediately and complete asynchronously.
The key to derive from.
The mechanism to use for derivation.
Additional attributes for the derived key.
Optional cancellation object or null.
Called when the operation completes.
Derive a key from another key. This call will return immediately and complete asynchronously.
The key to derive from.
The mechanism to use for derivation.
Additional attributes for the derived key.
Optional cancellation object or null.
Optionalcallback: AsyncReadyCallback<Gck.Session> | nullCalled when the operation completes.
Get the result of a derive key operation.
The async result passed to the callback.
the new derived key or null if the operation failed
Derive a key from another key. This call may block for an indefinite period.
The key to derive from.
The mechanism to use for derivation.
Additional attributes for the derived key.
Optional cancellation object, or null.
the new derived key or null if the operation failed
SignalemitEncrypt data in a mechanism specific manner. This call may block for an indefinite period.
The key to encrypt with.
The mechanism type to use for encryption.
the data to encrypt
Optional cancellation object, or null
the data that was encrypted, or null if an error occured.
Encrypt data in a mechanism specific manner. This call will return immediately and complete asynchronously.
The key to encrypt with.
The mechanism type and parameters to use for encryption.
the data to encrypt
A GCancellable which can be used to cancel the operation.
Encrypt data in a mechanism specific manner. This call will return immediately and complete asynchronously.
The key to encrypt with.
The mechanism type and parameters to use for encryption.
the data to encrypt
A GCancellable which can be used to cancel the operation.
Called when the operation completes.
Encrypt data in a mechanism specific manner. This call will return immediately and complete asynchronously.
The key to encrypt with.
The mechanism type and parameters to use for encryption.
the data to encrypt
A GCancellable which can be used to cancel the operation.
Optionalcallback: AsyncReadyCallback<Gck.Session> | nullCalled when the operation completes.
Get the result of an encryption operation.
The result object passed to the callback.
the data that was encrypted, or null if an error occurred.
Encrypt data in a mechanism specific manner. This call may block for an indefinite period.
The key to encrypt with.
The mechanism type and parameters to use for encryption.
the data to encrypt
A GCancellable which can be used to cancel the operation.
the data that was encrypted, or null if an error occured
Setup an enumerator for listing matching objects available via this session.
This call will not block but will return an enumerator immediately.
attributes that the objects must match, or empty for all objects
a new enumerator
Find the objects matching the passed attributes. This call may block for an indefinite period.
the attributes to match against objects
optional cancellation object or null
a list of the matching objects, which may be empty
Find the objects matching the passed attributes. This call will return immediately and complete asynchronously.
If match is a floating reference, it is consumed.
the attributes to match against the objects
optional cancellation object or null
Find the objects matching the passed attributes. This call will return immediately and complete asynchronously.
If match is a floating reference, it is consumed.
the attributes to match against the objects
optional cancellation object or null
called when the operation completes
Find the objects matching the passed attributes. This call will return immediately and complete asynchronously.
If match is a floating reference, it is consumed.
the attributes to match against the objects
optional cancellation object or null
Optionalcallback: AsyncReadyCallback<Gck.Session> | nullcalled when the operation completes
Get the result of a find handles operation.
the asynchronous result
an array of handles that matched, which may be empty, or null on failure
Find the objects matching the passed attributes. This call may block for an indefinite period.
If match is a floating reference, it is consumed.
the attributes to match
Optional cancellation object or null.
a list of the matching objects, which may be empty
Find the objects matching the passed attributes. This call will return immediately and complete asynchronously.
If the match Gck.Attributes is floating, it is consumed.
The attributes to match.
Optional cancellation object or null.
Find the objects matching the passed attributes. This call will return immediately and complete asynchronously.
If the match Gck.Attributes is floating, it is consumed.
The attributes to match.
Optional cancellation object or null.
Called when the operation completes.
Find the objects matching the passed attributes. This call will return immediately and complete asynchronously.
If the match Gck.Attributes is floating, it is consumed.
The attributes to match.
Optional cancellation object or null.
Optionalcallback: AsyncReadyCallback<Gck.Session> | nullCalled when the operation completes.
Get the result of a find operation.
The attributes to match.
a list of the matching objects, which may be empty
Generate a new key pair of public and private keys. This call may block for an indefinite period.
If public_attrs and/or private_attrs is a floating reference, it is
consumed.
The mechanism type to use for key generation.
Additional attributes for the generated public key.
Additional attributes for the generated private key.
Optional cancellation object, or null.
true if the operation succeeded.
Generate a new key pair of public and private keys. This call will return immediately and complete asynchronously.
If public_attrs and/or private_attrs is a floating reference, it is
consumed.
The mechanism to use for key generation.
Additional attributes for the generated public key.
Additional attributes for the generated private key.
Optional cancellation object or null.
Generate a new key pair of public and private keys. This call will return immediately and complete asynchronously.
If public_attrs and/or private_attrs is a floating reference, it is
consumed.
The mechanism to use for key generation.
Additional attributes for the generated public key.
Additional attributes for the generated private key.
Optional cancellation object or null.
Called when the operation completes.
Generate a new key pair of public and private keys. This call will return immediately and complete asynchronously.
If public_attrs and/or private_attrs is a floating reference, it is
consumed.
The mechanism to use for key generation.
Additional attributes for the generated public key.
Additional attributes for the generated private key.
Optional cancellation object or null.
Optionalcallback: AsyncReadyCallback<Gck.Session> | nullCalled when the operation completes.
Generate a new key pair of public and private keys. This call may block for an indefinite period.
The mechanism to use for key generation.
Additional attributes for the generated public key.
Additional attributes for the generated private key.
Optional cancellation object, or null.
true if the operation succeeded.
Get the raw PKCS#11 session handle from a session object.
The raw session handle.
Get information about the session.
the session info. Use the gck_session_info_free() to release when done
Get the interaction object set on this session, which is used to prompt for pins and the like.
the interaction object, or null
Get the session state. The state is the various PKCS#11 CKS_XXX flags.
the session state
Initializes the object implementing the interface.
This method is intended for language bindings. If writing in C,
g_initable_new() should typically be used instead.
The object must be initialized before any real use after initial
construction, either with this function or g_async_initable_init_async().
Implementations may also support cancellation. If cancellable is not null,
then initialization can be cancelled by triggering the cancellable object
from another thread. If the operation was cancelled, the error
Gio.IOErrorEnum.CANCELLED will be returned. If cancellable is not null and
the object doesn't support cancellable initialization the error
Gio.IOErrorEnum.NOT_SUPPORTED will be returned.
If the object is not initialized, or initialization returns with an
error, then all operations on the object except g_object_ref() and
g_object_unref() are considered to be invalid, and have undefined
behaviour. See the [description][iface@Gio.Initable#description] for more details.
Callers should not assume that a class which implements Gio.Initable can be
initialized multiple times, unless the class explicitly documents itself as
supporting this. Generally, a class’ implementation of init() can assume
(and assert) that it will only be called once. Previously, this documentation
recommended all Gio.Initable implementations should be idempotent; that
recommendation was relaxed in GLib 2.54.
If a class explicitly supports being initialized multiple times, it is recommended that the method is idempotent: multiple calls with the same arguments should return the same results. Only the first call initializes the object; further calls return the result of the first call.
One reason why a class might need to support idempotent initialization is if
it is designed to be used via the singleton pattern, with a
GObject.ObjectClass.constructor that sometimes returns an existing instance.
In this pattern, a caller would expect to be able to call g_initable_init()
on the result of g_object_new(), regardless of whether it is in fact a new
instance.
optional Gio.Cancellable object, null to ignore.
true if successful. If an error has occurred, this function will return false and set error appropriately if present.
Starts asynchronous initialization of the object implementing the
interface. This must be done before any real use of the object after
initial construction. If the object also implements Gio.Initable you can
optionally call g_initable_init() instead.
This method is intended for language bindings. If writing in C,
g_async_initable_new_async() should typically be used instead.
When the initialization is finished, callback will be called. You can
then call g_async_initable_init_finish() to get the result of the
initialization.
Implementations may also support cancellation. If cancellable is not
null, then initialization can be cancelled by triggering the cancellable
object from another thread. If the operation was cancelled, the error
Gio.IOErrorEnum.CANCELLED will be returned. If cancellable is not null, and
the object doesn't support cancellable initialization, the error
Gio.IOErrorEnum.NOT_SUPPORTED will be returned.
As with Gio.Initable, if the object is not initialized, or initialization
returns with an error, then all operations on the object except
g_object_ref() and g_object_unref() are considered to be invalid, and
have undefined behaviour. They will often fail with g_critical() or
g_warning(), but this must not be relied on.
Callers should not assume that a class which implements Gio.AsyncInitable can
be initialized multiple times; for more information, see g_initable_init().
If a class explicitly supports being initialized multiple times,
implementation requires yielding all subsequent calls to init_async() on the
results of the first call.
For classes that also support the Gio.Initable interface, the default
implementation of this method will run the g_initable_init() function
in a thread, so if you want to support asynchronous initialization via
threads, just implement the Gio.AsyncInitable interface without overriding
any interface methods.
the I/O priority of the operation
optional Gio.Cancellable object, null to ignore.
Starts asynchronous initialization of the object implementing the
interface. This must be done before any real use of the object after
initial construction. If the object also implements Gio.Initable you can
optionally call g_initable_init() instead.
This method is intended for language bindings. If writing in C,
g_async_initable_new_async() should typically be used instead.
When the initialization is finished, callback will be called. You can
then call g_async_initable_init_finish() to get the result of the
initialization.
Implementations may also support cancellation. If cancellable is not
null, then initialization can be cancelled by triggering the cancellable
object from another thread. If the operation was cancelled, the error
Gio.IOErrorEnum.CANCELLED will be returned. If cancellable is not null, and
the object doesn't support cancellable initialization, the error
Gio.IOErrorEnum.NOT_SUPPORTED will be returned.
As with Gio.Initable, if the object is not initialized, or initialization
returns with an error, then all operations on the object except
g_object_ref() and g_object_unref() are considered to be invalid, and
have undefined behaviour. They will often fail with g_critical() or
g_warning(), but this must not be relied on.
Callers should not assume that a class which implements Gio.AsyncInitable can
be initialized multiple times; for more information, see g_initable_init().
If a class explicitly supports being initialized multiple times,
implementation requires yielding all subsequent calls to init_async() on the
results of the first call.
For classes that also support the Gio.Initable interface, the default
implementation of this method will run the g_initable_init() function
in a thread, so if you want to support asynchronous initialization via
threads, just implement the Gio.AsyncInitable interface without overriding
any interface methods.
the I/O priority of the operation
optional Gio.Cancellable object, null to ignore.
a Gio.AsyncReadyCallback to call when the request is satisfied
Starts asynchronous initialization of the object implementing the
interface. This must be done before any real use of the object after
initial construction. If the object also implements Gio.Initable you can
optionally call g_initable_init() instead.
This method is intended for language bindings. If writing in C,
g_async_initable_new_async() should typically be used instead.
When the initialization is finished, callback will be called. You can
then call g_async_initable_init_finish() to get the result of the
initialization.
Implementations may also support cancellation. If cancellable is not
null, then initialization can be cancelled by triggering the cancellable
object from another thread. If the operation was cancelled, the error
Gio.IOErrorEnum.CANCELLED will be returned. If cancellable is not null, and
the object doesn't support cancellable initialization, the error
Gio.IOErrorEnum.NOT_SUPPORTED will be returned.
As with Gio.Initable, if the object is not initialized, or initialization
returns with an error, then all operations on the object except
g_object_ref() and g_object_unref() are considered to be invalid, and
have undefined behaviour. They will often fail with g_critical() or
g_warning(), but this must not be relied on.
Callers should not assume that a class which implements Gio.AsyncInitable can
be initialized multiple times; for more information, see g_initable_init().
If a class explicitly supports being initialized multiple times,
implementation requires yielding all subsequent calls to init_async() on the
results of the first call.
For classes that also support the Gio.Initable interface, the default
implementation of this method will run the g_initable_init() function
in a thread, so if you want to support asynchronous initialization via
threads, just implement the Gio.AsyncInitable interface without overriding
any interface methods.
the I/O priority of the operation
optional Gio.Cancellable object, null to ignore.
Optionalcallback: AsyncReadyCallback<Gck.Session> | nulla Gio.AsyncReadyCallback to call when the request is satisfied
Finishes asynchronous initialization and returns the result.
See g_async_initable_init_async().
true if successful. If an error has occurred, this function will return false and set error appropriately if present.
Initialize the user's pin on this slot that this session is opened on. According to the PKCS#11 standards, the session must be logged in with the CKU_SO user type.
This call may block for an indefinite period.
the user's PIN, or null for protected authentication path
Optional cancellation object, or null.
Whether successful or not.
Initialize the user's pin on this slot that this session is opened on.
According to the PKCS#11 standards, the session must be logged in with
the CKU_SO user type.
This call will return immediately and completes asynchronously.
the user's PIN, or null for protected authentication path
Optional cancellation object, or null.
Initialize the user's pin on this slot that this session is opened on.
According to the PKCS#11 standards, the session must be logged in with
the CKU_SO user type.
This call will return immediately and completes asynchronously.
the user's PIN, or null for protected authentication path
Optional cancellation object, or null.
Called when the operation completes.
Initialize the user's pin on this slot that this session is opened on.
According to the PKCS#11 standards, the session must be logged in with
the CKU_SO user type.
This call will return immediately and completes asynchronously.
the user's PIN, or null for protected authentication path
Optional cancellation object, or null.
Optionalcallback: AsyncReadyCallback<Gck.Session> | nullCalled when the operation completes.
Get the result of initializing a user's PIN.
The result passed to the callback.
Whether the operation was successful or not.
Login the user on the session. This call may block for an indefinite period.
The type of login user.
the user's PIN, or null for protected authentication path
Optional cancellation object, or null.
Whether successful or not.
Login the user on the session. This call will return immediately and completes asynchronously.
The type of login user.
the user's PIN, or null for protected authentication path
Optional cancellation object, or null.
Login the user on the session. This call will return immediately and completes asynchronously.
The type of login user.
the user's PIN, or null for protected authentication path
Optional cancellation object, or null.
Called when the operation completes.
Login the user on the session. This call will return immediately and completes asynchronously.
The type of login user.
the user's PIN, or null for protected authentication path
Optional cancellation object, or null.
Optionalcallback: AsyncReadyCallback<Gck.Session> | nullCalled when the operation completes.
Get the result of a login operation.
The result passed to the callback.
Whether the operation was successful or not.
Login the user on the session requesting the password interactively when necessary. This call may block for an indefinite period.
the type of login user
interaction to request PIN when necessary
optional cancellation object, or null
Whether successful or not.
Login the user on the session prompting for passwords interactively when necessary. This call will return immediately and completes asynchronously.
the type of login user
interaction to request PIN when necessary
optional cancellation object, or null
Login the user on the session prompting for passwords interactively when necessary. This call will return immediately and completes asynchronously.
the type of login user
interaction to request PIN when necessary
optional cancellation object, or null
called when the operation completes
Login the user on the session prompting for passwords interactively when necessary. This call will return immediately and completes asynchronously.
the type of login user
interaction to request PIN when necessary
optional cancellation object, or null
Optionalcallback: AsyncReadyCallback<Gck.Session> | nullcalled when the operation completes
Get the result of a login operation.
the result passed to the callback
Whether the operation was successful or not.
Log out of the session. This call may block for an indefinite period.
Optional cancellation object, or null.
Whether the logout was successful or not.
Log out of the session. This call returns immediately and completes asynchronously.
Optional cancellation object, or null.
Log out of the session. This call returns immediately and completes asynchronously.
Optional cancellation object, or null.
Called when the operation completes.
Log out of the session. This call returns immediately and completes asynchronously.
Optional cancellation object, or null.
Optionalcallback: AsyncReadyCallback<Gck.Session> | nullCalled when the operation completes.
Get the result of logging out of a session.
The result passed to the callback.
Whether the logout was successful or not.
Finishes the async construction for the various g_async_initable_new
calls, returning the created object or null on error.
the Gio.AsyncResult from the callback
a newly created GObject.Object, or null on error. Free with g_object_unref().
Set the interaction object on this session, which is used to prompt for pins and the like.
the interaction or null
Change the user's pin on this slot that this session is opened on.
This call may block for an indefinite period.
the user's old PIN, or null for protected authentication path.
the user's new PIN, or null for protected authentication path
Optional cancellation object, or null.
Whether successful or not.
Change the user's pin on this slot that this session is opened on.
This call will return immediately and completes asynchronously.
the user's old PIN, or null for protected authentication path
the length of the old PIN
the user's new PIN, or null for protected authentication path
Optional cancellation object, or null.
Change the user's pin on this slot that this session is opened on.
This call will return immediately and completes asynchronously.
the user's old PIN, or null for protected authentication path
the length of the old PIN
the user's new PIN, or null for protected authentication path
Optional cancellation object, or null.
Called when the operation completes.
Change the user's pin on this slot that this session is opened on.
This call will return immediately and completes asynchronously.
the user's old PIN, or null for protected authentication path
the length of the old PIN
the user's new PIN, or null for protected authentication path
Optional cancellation object, or null.
Optionalcallback: AsyncReadyCallback<Gck.Session> | nullCalled when the operation completes.
Get the result of changing a user's PIN.
The result passed to the callback.
Whether the operation was successful or not.
Sign data in a mechanism specific manner. This call may block for an indefinite period.
The key to sign with.
The mechanism type to use for signing.
data to sign
Optional cancellation object, or null
the data that was signed, or null if an error occured
Sign data in a mechanism specific manner. This call will return immediately and complete asynchronously.
The key to sign with.
The mechanism type and parameters to use for signing.
data to sign
A GCancellable which can be used to cancel the operation.
Sign data in a mechanism specific manner. This call will return immediately and complete asynchronously.
The key to sign with.
The mechanism type and parameters to use for signing.
data to sign
A GCancellable which can be used to cancel the operation.
Called when the operation completes.
Sign data in a mechanism specific manner. This call will return immediately and complete asynchronously.
The key to sign with.
The mechanism type and parameters to use for signing.
data to sign
A GCancellable which can be used to cancel the operation.
Optionalcallback: AsyncReadyCallback<Gck.Session> | nullCalled when the operation completes.
Get the result of an signing operation.
The result object passed to the callback.
the data that was signed, or null if an error occurred
Sign data in a mechanism specific manner. This call may block for an indefinite period.
The key to sign with.
The mechanism type and parameters to use for signing.
data to sign
location to store the length of the result data
A GCancellable which can be used to cancel the operation.
The data that was signed, or null if an error occured.
Unwrap a key from a byte stream. This call may block for an indefinite period.
The key to use for unwrapping.
The mechanism to use for unwrapping.
the wrapped data as a byte stream
Additional attributes for the unwrapped key.
Optional cancellation object, or null.
the new unwrapped key or null if the operation failed
Unwrap a key from a byte stream. This call will return immediately and complete asynchronously.
The key to use for unwrapping.
The mechanism to use for unwrapping.
the wrapped data as a byte stream
Additional attributes for the unwrapped key.
Optional cancellation object or null.
Unwrap a key from a byte stream. This call will return immediately and complete asynchronously.
The key to use for unwrapping.
The mechanism to use for unwrapping.
the wrapped data as a byte stream
Additional attributes for the unwrapped key.
Optional cancellation object or null.
Called when the operation completes.
Unwrap a key from a byte stream. This call will return immediately and complete asynchronously.
The key to use for unwrapping.
The mechanism to use for unwrapping.
the wrapped data as a byte stream
Additional attributes for the unwrapped key.
Optional cancellation object or null.
Optionalcallback: AsyncReadyCallback<Gck.Session> | nullCalled when the operation completes.
Get the result of a unwrap key operation.
The async result passed to the callback.
the new unwrapped key or null if the operation failed.
Unwrap a key from a byte stream. This call may block for an indefinite period.
The key to use for unwrapping.
The mechanism to use for unwrapping.
the wrapped data as a byte stream
Additional attributes for the unwrapped key.
Optional cancellation object, or null.
the new unwrapped key or null if the operation failed
Verify data in a mechanism specific manner. This call may block for an indefinite period.
The key to verify with.
The mechanism type to use for verifying.
data to verify
the signature
Optional cancellation object, or null
true if the data verified correctly, otherwise a failure or error occurred.
Verify data in a mechanism specific manner. This call returns immediately and completes asynchronously.
The key to verify with.
The mechanism type and parameters to use for signing.
data to verify
the signature
A GCancellable which can be used to cancel the operation.
Verify data in a mechanism specific manner. This call returns immediately and completes asynchronously.
The key to verify with.
The mechanism type and parameters to use for signing.
data to verify
the signature
A GCancellable which can be used to cancel the operation.
Called when the operation completes.
Verify data in a mechanism specific manner. This call returns immediately and completes asynchronously.
The key to verify with.
The mechanism type and parameters to use for signing.
data to verify
the signature
A GCancellable which can be used to cancel the operation.
Optionalcallback: AsyncReadyCallback<Gck.Session> | nullCalled when the operation completes.
Get the result of an verify operation.
The result object passed to the callback.
true if the data verified correctly, otherwise a failure or error occurred.
Verify data in a mechanism specific manner. This call may block for an indefinite period.
The key to verify with.
The mechanism type and parameters to use for signing.
data to verify
the signature
A GCancellable which can be used to cancel the operation.
true if the data verified correctly, otherwise a failure or error occurred.
Virtualvfunc_Initializes the object implementing the interface.
This method is intended for language bindings. If writing in C,
g_initable_new() should typically be used instead.
The object must be initialized before any real use after initial
construction, either with this function or g_async_initable_init_async().
Implementations may also support cancellation. If cancellable is not null,
then initialization can be cancelled by triggering the cancellable object
from another thread. If the operation was cancelled, the error
Gio.IOErrorEnum.CANCELLED will be returned. If cancellable is not null and
the object doesn't support cancellable initialization the error
Gio.IOErrorEnum.NOT_SUPPORTED will be returned.
If the object is not initialized, or initialization returns with an
error, then all operations on the object except g_object_ref() and
g_object_unref() are considered to be invalid, and have undefined
behaviour. See the [description][iface@Gio.Initable#description] for more details.
Callers should not assume that a class which implements Gio.Initable can be
initialized multiple times, unless the class explicitly documents itself as
supporting this. Generally, a class’ implementation of init() can assume
(and assert) that it will only be called once. Previously, this documentation
recommended all Gio.Initable implementations should be idempotent; that
recommendation was relaxed in GLib 2.54.
If a class explicitly supports being initialized multiple times, it is recommended that the method is idempotent: multiple calls with the same arguments should return the same results. Only the first call initializes the object; further calls return the result of the first call.
One reason why a class might need to support idempotent initialization is if
it is designed to be used via the singleton pattern, with a
GObject.ObjectClass.constructor that sometimes returns an existing instance.
In this pattern, a caller would expect to be able to call g_initable_init()
on the result of g_object_new(), regardless of whether it is in fact a new
instance.
optional Gio.Cancellable object, null to ignore.
Virtualvfunc_Starts asynchronous initialization of the object implementing the
interface. This must be done before any real use of the object after
initial construction. If the object also implements Gio.Initable you can
optionally call g_initable_init() instead.
This method is intended for language bindings. If writing in C,
g_async_initable_new_async() should typically be used instead.
When the initialization is finished, callback will be called. You can
then call g_async_initable_init_finish() to get the result of the
initialization.
Implementations may also support cancellation. If cancellable is not
null, then initialization can be cancelled by triggering the cancellable
object from another thread. If the operation was cancelled, the error
Gio.IOErrorEnum.CANCELLED will be returned. If cancellable is not null, and
the object doesn't support cancellable initialization, the error
Gio.IOErrorEnum.NOT_SUPPORTED will be returned.
As with Gio.Initable, if the object is not initialized, or initialization
returns with an error, then all operations on the object except
g_object_ref() and g_object_unref() are considered to be invalid, and
have undefined behaviour. They will often fail with g_critical() or
g_warning(), but this must not be relied on.
Callers should not assume that a class which implements Gio.AsyncInitable can
be initialized multiple times; for more information, see g_initable_init().
If a class explicitly supports being initialized multiple times,
implementation requires yielding all subsequent calls to init_async() on the
results of the first call.
For classes that also support the Gio.Initable interface, the default
implementation of this method will run the g_initable_init() function
in a thread, so if you want to support asynchronous initialization via
threads, just implement the Gio.AsyncInitable interface without overriding
any interface methods.
the I/O priority of the operation
optional Gio.Cancellable object, null to ignore.
a Gio.AsyncReadyCallback to call when the request is satisfied
Virtualvfunc_Finishes asynchronous initialization and returns the result.
See g_async_initable_init_async().
Wrap a key into a byte stream. This call may block for an indefinite period.
The key to use for wrapping.
The mechanism type to use for wrapping.
The key to wrap.
A Gio.Cancellable or null
the wrapped data or null if the operation failed
Wrap a key into a byte stream. This call will return immediately and complete asynchronously.
Wrap a key into a byte stream. This call will return immediately and complete asynchronously.
The key to use for wrapping.
The mechanism to use for wrapping.
The key to wrap.
Optional cancellation object or null.
Called when the operation completes.
Wrap a key into a byte stream. This call will return immediately and complete asynchronously.
The key to use for wrapping.
The mechanism to use for wrapping.
The key to wrap.
Optional cancellation object or null.
Optionalcallback: AsyncReadyCallback<Gck.Session> | nullCalled when the operation completes.
Get the result of a wrap key operation.
The async result passed to the callback.
the wrapped data or null if the operation failed
Staticfrom_Initialize a session object from a raw PKCS#11 session handle. Usually one would use the Slot.open_session function to create a session.
The slot which the session belongs to.
the raw PKCS#11 handle of the session
Session options. Those which are used during opening a session have no effect.
StaticopenOpen a session on the slot. This call may block for an indefinite period.
the slot to open session on
session options
optional interaction for logins or object authentication
optional cancellation object
Staticopen_Open a session on the slot. This call will return immediately and complete asynchronously.
the slot to open session on
session options
optional interaction for logins or object authentication
optional cancellation object
called when the operation completes
Staticopen_Get the result of an open session operation.
the result passed to the callback
Creates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
GObject.Binding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A GObject.Object can have multiple bindings.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of
g_object_bind_property_full(), using GClosures instead of
function pointers.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
a GObject.Closure wrapping the transformation function from the source to the target, or null to use the default
a GObject.Closure wrapping the transformation function from the target to the source, or null to use the default
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Blocks a handler of an instance so it will not be called during any signal emissions
Handler ID of the handler to be blocked
Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
Handler ID of the handler to be disconnected
This function is intended for GObject.Object implementations to re-enforce
a [floating][floating-ref] object reference. Doing this is seldom
required: all GInitiallyUnowneds are created with a floating reference
which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
GObject.Object::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
the data if found, or null if no such data exists.
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
The name of the property to get
Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
This function gets back user data pointers stored via
g_object_set_qdata().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Checks whether object has a [floating][floating-ref] reference.
true if object has a floating reference
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than
g_object_notify().
One way to avoid using g_object_notify() from within the
class that registered the properties, and using g_object_notify_by_pspec()
instead, is to store the GParamSpec used with
g_object_class_install_property() inside a static array, e.g.:
typedef enum
{
PROP_FOO = 1,
PROP_LAST
} MyObjectProperty;
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
0, 100,
50,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the GObject.ParamSpec of a property installed on the class of object.
Increases the reference count of object.
Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type
of object will be propagated to the return type (using the GCC typeof()
extension), so any casting the caller needs to do on the return type must be
explicit.
the same object
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
object
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
Object containing the properties to set
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a GLib.Quark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the GLib.Quark storage growing unbounded.
name of the key
data to associate with that key
Sets a property on an object.
The name of the property to set
The value to set the property to
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
the data if found, or null if no such data exists.
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of
g_object_steal_qdata() would have left the destroy function set,
and thus the partial string list would have been freed upon
g_object_set_qdata_full().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
Name of the signal to stop emission of
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Unblocks a handler so it will be called again during any signal emissions
Handler ID of the handler to be unblocked
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the GObject.Object may be reused in future (for example, if it is
an instance variable of another object), it is recommended to clear the
pointer to null rather than retain a dangling pointer to a potentially
invalid GObject.Object instance. Use g_clear_object() for this.
Virtualvfunc_the constructed function is called by g_object_new() as the
final step of the object creation process. At the point of the call, all
construction properties have been set on the object. The purpose of this
call is to allow for object initialisation steps that can only be performed
after construction properties have been set. constructed implementors
should chain up to the constructed call of their parent class to allow it
to complete its initialisation.
Virtualvfunc_Virtualvfunc_the dispose function is supposed to drop all references to other
objects, but keep the instance otherwise intact, so that client method
invocations still work. It may be run multiple times (due to reference
loops). Before returning, dispose should chain up to the dispose method
of the parent class.
Virtualvfunc_instance finalization function, should finish the finalization of
the instance begun in dispose and chain up to the finalize method of the
parent class.
Virtualvfunc_Virtualvfunc_Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
Virtualvfunc_the generic setter for all properties of this type. Should be
overridden for every type with properties. If implementations of
set_property don't emit property change notification explicitly, this will
be done implicitly by the type system. However, if the notify signal is
emitted explicitly, the type system will not emit it a second time.
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
GObject.Closure to watch
Static_Staticcompat_Staticfind_Staticinstall_Staticinstall_the id for the new property
the GObject.ParamSpec for the new property
Staticinterface_Find the GObject.ParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Staticinterface_Add a property to an interface; this is only useful for interfaces
that are added to GObject-derived types. Adding a property to an
interface forces all objects classes with that interface to have a
compatible property. The compatible property could be a newly
created GObject.ParamSpec, but normally
g_object_class_override_property() will be used so that the object
class only needs to provide an implementation and inherits the
property description, default value, bounds, and so forth from the
interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
GObject.TypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the GObject.ParamSpec for the new property
Staticinterface_Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Staticlist_StaticnewvStaticoverride_the new property ID
the name of a property registered in a parent class or in an interface of this class.
Represents an open PKCS11 session.
Before performing any PKCS11 operations, a session must be opened. This is analogous to an open database handle, or a file handle.