Optionalproperties: Partial<Gck.Object.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 OnlyhandleThe raw PKCS11 handle for this object.
Construct OnlymoduleConstruct OnlysessionLookup attributes in the cache, or retrieve them from the object if necessary.
If object is a Gck.ObjectCache then this will lookup the attributes there
first if available, otherwise will read them from the object and update
the cache.
If object is not a Gck.ObjectCache, then the attributes will simply be
read from the object.
This may block, use the asynchronous version when this is not desirable
the types of attributes to update
Optionalcancellable: Gio.Cancellableoptional cancellation object
the attributes retrieved or null on failure
Lookup attributes in the cache, or retrieve them from the object if necessary.
If object is a Gck.ObjectCache then this will lookup the attributes there
first if available, otherwise will read them from the object and update
the cache.
If object is not a Gck.ObjectCache, then the attributes will simply be
read from the object.
This will return immediately and complete asynchronously
the types of attributes to update
Optionalcancellable: Gio.Cancellableoptional cancellation object
Lookup attributes in the cache, or retrieve them from the object if necessary.
If object is a Gck.ObjectCache then this will lookup the attributes there
first if available, otherwise will read them from the object and update
the cache.
If object is not a Gck.ObjectCache, then the attributes will simply be
read from the object.
This will return immediately and complete asynchronously
the types of attributes to update
optional cancellation object
called when the operation completes
Lookup attributes in the cache, or retrieve them from the object if necessary.
If object is a Gck.ObjectCache then this will lookup the attributes there
first if available, otherwise will read them from the object and update
the cache.
If object is not a Gck.ObjectCache, then the attributes will simply be
read from the object.
This will return immediately and complete asynchronously
the types of attributes to update
Optionalcancellable: Gio.Cancellableoptional cancellation object
Optionalcallback: AsyncReadyCallback<Gck.Object>called when the operation completes
Complete an operation to lookup attributes in the cache or retrieve them from the object if necessary.
the asynchrounous result passed to the callback
the attributes retrieved or null on failure
SignalconnectSignalconnect_Destroy a PKCS#11 object, deleting it from storage or the session. This call may block for an indefinite period.
Optionalcancellable: Gio.CancellableOptional cancellable object, or null to ignore.
Whether the call was successful or not.
Destroy a PKCS#11 object, deleting it from storage or the session. This call will return immediately and complete asynchronously.
Optionalcancellable: Gio.CancellableOptional cancellable object, or null to ignore.
Destroy a PKCS#11 object, deleting it from storage or the session. This call will return immediately and complete asynchronously.
Optional cancellable object, or null to ignore.
Callback which is called when operation completes.
Destroy a PKCS#11 object, deleting it from storage or the session. This call will return immediately and complete asynchronously.
Optionalcancellable: Gio.CancellableOptional cancellable object, or null to ignore.
Optionalcallback: AsyncReadyCallback<Gck.Object>Callback which is called when operation completes.
Get the status of the operation to destroy a PKCS#11 object, begun with
gck_object_destroy_async().
The result of the destory operation passed to the callback.
Whether the object was destroyed successfully or not.
SignalemitChecks equality of two objects. Two GckObject objects can point to the same underlying PKCS#11 object.
a pointer to the second Gck.Object
true if object1 and object2 are equal. false if either is not a GckObject.
Get the specified attributes from the object. The attributes will be cleared
of their current values, and new attributes will be stored. The attributes
should not be accessed in any way except for referencing and unreferencing
them until gck_object_get_finish() is called.
This call returns immediately and completes asynchronously.
the types of the attributes to get
Optionalcancellable: Gio.Cancellableoptional cancellation object, or null
Get the specified attributes from the object. The attributes will be cleared
of their current values, and new attributes will be stored. The attributes
should not be accessed in any way except for referencing and unreferencing
them until gck_object_get_finish() is called.
This call returns immediately and completes asynchronously.
the types of the attributes to get
optional cancellation object, or null
A callback which is called when the operation completes.
Get the specified attributes from the object. The attributes will be cleared
of their current values, and new attributes will be stored. The attributes
should not be accessed in any way except for referencing and unreferencing
them until gck_object_get_finish() is called.
This call returns immediately and completes asynchronously.
the types of the attributes to get
Optionalcancellable: Gio.Cancellableoptional cancellation object, or null
Optionalcallback: AsyncReadyCallback<Gck.Object>A callback which is called when the operation completes.
Get the data for the specified attribute from the object. For convenience the returned data has a null terminator.
This call may block for an indefinite period.
The attribute to get data for.
Optionalcancellable: Gio.CancellableA Gio.Cancellable or null
the resulting PKCS#11 attribute data, or null if an error occurred
Get the data for the specified attribute from the object.
This call will return immediately and complete asynchronously.
The attribute to get data for.
An allocator with which to allocate memory for the data, or null for default.
Optionalcancellable: Gio.CancellableOptional cancellation object, or null.
Get the data for the specified attribute from the object.
This call will return immediately and complete asynchronously.
The attribute to get data for.
An allocator with which to allocate memory for the data, or null for default.
Optional cancellation object, or null.
Called when the operation completes.
Get the data for the specified attribute from the object.
This call will return immediately and complete asynchronously.
The attribute to get data for.
An allocator with which to allocate memory for the data, or null for default.
Optionalcancellable: Gio.CancellableOptional cancellation object, or null.
Optionalcallback: AsyncReadyCallback<Gck.Object>Called when the operation completes.
Get the result of an operation to get attribute data from an object. For convenience the returned data has an extra null terminator, not included in the returned length.
The result passed to the callback.
The PKCS#11 attribute data or null if an error occurred.
Get the result of a get operation and return specified attributes from the object.
No extra references are added to the returned attributes pointer.
The result passed to the callback.
The filled in attributes structure if successful or null if not successful.
Get the specified attributes from the object. This call may block for an indefinite period.
No extra references are added to the returned attributes pointer. During this call you may not access the attributes in any way.
the types of the attributes to get
Optionalcancellable: Gio.Cancellableoptional cancellation object, or null
a pointer to the filled in attributes if successful, or null if not
Get the raw PKCS#11 handle of a GckObject.
the raw CK_OBJECT_HANDLE object handle
Get the PKCS#11 session assigned to make calls on when operating on this object.
This will only return a session if it was set explitly on this object. By default an object will open and close sessions appropriate for its calls.
the assigned session, which must be unreffed after use
Get an attribute template from the object. The attr_type must be for an attribute which returns a template.
This call may block for an indefinite period.
The template attribute type.
Optionalcancellable: Gio.CancellableOptional cancellation object, or null.
the resulting PKCS#11 attribute template, or null if an error occurred
Get an attribute template from the object. The attr_type must be for
an attribute which returns a template.
This call will return immediately and complete asynchronously.
The template attribute type.
Optionalcancellable: Gio.CancellableOptional cancellation object, or null.
Get an attribute template from the object. The attr_type must be for
an attribute which returns a template.
This call will return immediately and complete asynchronously.
The template attribute type.
Optional cancellation object, or null.
Called when the operation completes.
Get an attribute template from the object. The attr_type must be for
an attribute which returns a template.
This call will return immediately and complete asynchronously.
The template attribute type.
Optionalcancellable: Gio.CancellableOptional cancellation object, or null.
Optionalcallback: AsyncReadyCallback<Gck.Object>Called when the operation completes.
Get the result of an operation to get attribute template from an object.
The result passed to the callback.
the resulting PKCS#11 attribute template, or null if an error occurred
Create a hash value for the GckObject.
This function is intended for easily hashing a GckObject to add to a GHashTable or similar data structure.
An integer that can be used as a hash value, or 0 if invalid.
Set PKCS#11 attributes on an object. This call may block for an indefinite period.
The attributes to set on the object.
Optionalcancellable: Gio.CancellableOptional cancellable object, or null to ignore.
Whether the call was successful or not.
Set PKCS#11 attributes on an object. This call will return immediately and completes asynchronously.
The attributes to set on the object.
Optionalcancellable: Gio.CancellableOptional cancellable object, or null to ignore.
Set PKCS#11 attributes on an object. This call will return immediately and completes asynchronously.
The attributes to set on the object.
Optional cancellable object, or null to ignore.
Callback which is called when operation completes.
Set PKCS#11 attributes on an object. This call will return immediately and completes asynchronously.
The attributes to set on the object.
Optionalcancellable: Gio.CancellableOptional cancellable object, or null to ignore.
Optionalcallback: AsyncReadyCallback<Gck.Object>Callback which is called when operation completes.
Get the status of the operation to set attributes on a PKCS#11 object,
begun with gck_object_set_async().
The result of the destory operation passed to the callback.
Whether the attributes were successfully set on the object or not.
Set an attribute template on the object. The attr_type must be for an attribute which contains a template.
If the attrs Gck.Attributes is floating, it is consumed.
This call may block for an indefinite period.
The attribute template type.
The attribute template.
Optionalcancellable: Gio.CancellableOptional cancellation object, or null.
true if the operation succeeded.
Set an attribute template on the object. The attr_type must be for an attribute which contains a template.
If the attrs Gck.Attributes is floating, it is consumed.
This call will return immediately and complete asynchronously.
The attribute template type.
The attribute template.
Optionalcancellable: Gio.CancellableOptional cancellation object, or null.
Set an attribute template on the object. The attr_type must be for an attribute which contains a template.
If the attrs Gck.Attributes is floating, it is consumed.
This call will return immediately and complete asynchronously.
The attribute template type.
The attribute template.
Optional cancellation object, or null.
Called when the operation completes.
Set an attribute template on the object. The attr_type must be for an attribute which contains a template.
If the attrs Gck.Attributes is floating, it is consumed.
This call will return immediately and complete asynchronously.
The attribute template type.
The attribute template.
Optionalcancellable: Gio.CancellableOptional cancellation object, or null.
Optionalcallback: AsyncReadyCallback<Gck.Object>Called when the operation completes.
Get the result of an operation to set attribute template on an object.
The result passed to the callback.
true if the operation succeeded.
Staticfrom_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.
Complete version of g_object_bind_property().
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.
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 transform_from function is only used in case
of bidirectional bindings, otherwise it will be ignored
The binding will automatically be removed when either the source or the
target instances are finalized. This will release the reference that is
being held on the GObject.Binding instance; if you want to hold on to the
GObject.Binding instance, you will need to hold a reference to it.
To remove the binding, call g_binding_unbind().
A GObject.Object can have multiple bindings.
The same user_data parameter will be used for both transform_to
and transform_from transformation functions; the notify function will
be called once, when the binding is removed. If you need different data
for each transformation function, please use
g_object_bind_property_with_closures() instead.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
Optionaltransform_to: BindingTransformFuncthe transformation function from the source to the target, or null to use the default
Optionaltransform_from: BindingTransformFuncthe transformation function from the target to the source, or null to use the default
Optionalnotify: DestroyNotifya function to call when disposing the binding, to free resources used by the transformation functions, or null if not required
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 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.
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
Optionaldata: anydata 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_Optionaldata: anyStaticfind_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.
Holds a handle to a PKCS11 object such as a key or certificate. Token objects are stored on the token persistently. Others are transient and are called session objects.