Blame docs/reference/gck/html/GckObjectCache.html

Packit b00eeb
Packit b00eeb
<html>
Packit b00eeb
<head>
Packit b00eeb
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit b00eeb
<title>GckObjectCache: Gck Library Reference Manual</title>
Packit b00eeb
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit b00eeb
<link rel="home" href="index.html" title="Gck Library Reference Manual">
Packit b00eeb
<link rel="up" href="reference.html" title="PKCS#11 GObject Bindings">
Packit b00eeb
<link rel="prev" href="GckAttributes.html" title="GckAttributes">
Packit b00eeb
<link rel="next" href="GckEnumerator.html" title="GckEnumerator">
Packit b00eeb
<meta name="generator" content="GTK-Doc V1.27.1 (XML mode)">
Packit b00eeb
<link rel="stylesheet" href="style.css" type="text/css">
Packit b00eeb
</head>
Packit b00eeb
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit b00eeb
Packit b00eeb
Packit b00eeb
Top  | 
Packit b00eeb
                  Description  | 
Packit b00eeb
                  Object Hierarchy  | 
Packit b00eeb
                  Prerequisites  | 
Packit b00eeb
                  Properties
Packit b00eeb
Packit b00eeb
Home
Packit b00eeb
Up
Packit b00eeb
Prev
Packit b00eeb
Next
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

GckObjectCache

Packit b00eeb

GckObjectCache — An interface which holds attributes for a PKCS#11 object

Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Functions

Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
GckAttributes *
Packit b00eeb
Packit b00eeb
Packit b00eeb
gck_object_cache_get_attributes ()
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
void
Packit b00eeb
Packit b00eeb
Packit b00eeb
gck_object_cache_set_attributes ()
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
void
Packit b00eeb
Packit b00eeb
Packit b00eeb
gck_object_cache_fill ()
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
GckAttributes *
Packit b00eeb
Packit b00eeb
Packit b00eeb
gck_object_cache_lookup ()
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
void
Packit b00eeb
Packit b00eeb
Packit b00eeb
gck_object_cache_lookup_async ()
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
GckAttributes *
Packit b00eeb
Packit b00eeb
Packit b00eeb
gck_object_cache_lookup_finish ()
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
gboolean
Packit b00eeb
Packit b00eeb
Packit b00eeb
gck_object_cache_update ()
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
void
Packit b00eeb
Packit b00eeb
Packit b00eeb
gck_object_cache_update_async ()
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
gboolean
Packit b00eeb
Packit b00eeb
Packit b00eeb
gck_object_cache_update_finish ()
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Properties

Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
GckAttributes *
Packit b00eeb
attributes
Packit b00eeb
Read / Write
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Types and Values

Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
 
Packit b00eeb
GckObjectCache
Packit b00eeb
Packit b00eeb
Packit b00eeb
struct
Packit b00eeb
GckObjectCacheIface
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Object Hierarchy

Packit b00eeb
    GInterface
Packit b00eeb
    ╰── GckObjectCache
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Prerequisites

Packit b00eeb

Packit b00eeb
GckObjectCache requires
Packit b00eeb
 GckObject.

Packit b00eeb
Packit b00eeb
Packit b00eeb

Description

Packit b00eeb

GckObjectCache is an interface implemented by derived classes of

Packit b00eeb
GckObject to indicate which attributes they'd like an enumerator to retrieve.
Packit b00eeb
These attributes are then cached on the object and can be retrieved through
Packit b00eeb
the “attributes” property.

Packit b00eeb
Packit b00eeb
Packit b00eeb

Functions

Packit b00eeb
Packit b00eeb

gck_object_cache_get_attributes ()

Packit b00eeb
GckAttributes *
Packit b00eeb
gck_object_cache_get_attributes (GckObjectCache *object);
Packit b00eeb
Packit b00eeb

Packit b00eeb
Packit b00eeb

gck_object_cache_set_attributes ()

Packit b00eeb
void
Packit b00eeb
gck_object_cache_set_attributes (GckObjectCache *object,
Packit b00eeb
                                 GckAttributes *attrs);
Packit b00eeb

Sets the attributes cached on this object.

Packit b00eeb

If the attrs

Packit b00eeb
 GckAttributes is floating, it is consumed.

Packit b00eeb
Packit b00eeb

Parameters

Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

object

Packit b00eeb

an object with an attribute cache

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

attrs

Packit b00eeb

the attributes to set.

Packit b00eeb
[allow-none]
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Packit b00eeb
Packit b00eeb

gck_object_cache_fill ()

Packit b00eeb
void
Packit b00eeb
gck_object_cache_fill (GckObjectCache *object,
Packit b00eeb
                       GckAttributes *attrs);
Packit b00eeb

Adds the attributes to the set cached on this object. If an attribute is

Packit b00eeb
already present in the cache it will be overridden by this value.

Packit b00eeb

This will be done in a thread-safe manner.

Packit b00eeb

If the attrs

Packit b00eeb
 GckAttributes is floating, it is consumed.

Packit b00eeb
Packit b00eeb

Parameters

Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

object

Packit b00eeb

an object with the cache

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

attrs

Packit b00eeb

the attributes to cache

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Packit b00eeb
Packit b00eeb

gck_object_cache_lookup ()

Packit b00eeb
GckAttributes *
Packit b00eeb
gck_object_cache_lookup (GckObject *object,
Packit b00eeb
                         const gulong *attr_types,
Packit b00eeb
                         gint n_attr_types,
Packit b00eeb
                         GCancellable *cancellable,
Packit b00eeb
                         GError **error);
Packit b00eeb

Lookup attributes in the cache, or retrieve them from the object if necessary.

Packit b00eeb

If object

Packit b00eeb
 is a GckObjectCache then this will lookup the attributes there
Packit b00eeb
first if available, otherwise will read them from the object and update
Packit b00eeb
the cache.

Packit b00eeb

If object

Packit b00eeb
 is not a GckObjectCache, then the attributes will simply be
Packit b00eeb
read from the object.

Packit b00eeb

This may block, use the asynchronous version when this is not desirable

Packit b00eeb
Packit b00eeb

Parameters

Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

object

Packit b00eeb

the object

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

attr_types

Packit b00eeb

the types of attributes to update.

Packit b00eeb
[array length=n_attr_types]
Packit b00eeb
Packit b00eeb
Packit b00eeb

n_attr_types

Packit b00eeb

the number of attribute types

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

cancellable

Packit b00eeb

optional cancellation object

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

error

Packit b00eeb

location to place an error

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Returns

Packit b00eeb

the attributes retrieved or NULL on failure.

Packit b00eeb

[transfer full]

Packit b00eeb
Packit b00eeb
Packit b00eeb

Packit b00eeb
Packit b00eeb

gck_object_cache_lookup_async ()

Packit b00eeb
void
Packit b00eeb
gck_object_cache_lookup_async (GckObject *object,
Packit b00eeb
                               const gulong *attr_types,
Packit b00eeb
                               gint n_attr_types,
Packit b00eeb
                               GCancellable *cancellable,
Packit b00eeb
                               GAsyncReadyCallback callback,
Packit b00eeb
                               gpointer user_data);
Packit b00eeb

Lookup attributes in the cache, or retrieve them from the object if necessary.

Packit b00eeb

If object

Packit b00eeb
 is a GckObjectCache then this will lookup the attributes there
Packit b00eeb
first if available, otherwise will read them from the object and update
Packit b00eeb
the cache.

Packit b00eeb

If object

Packit b00eeb
 is not a GckObjectCache, then the attributes will simply be
Packit b00eeb
read from the object.

Packit b00eeb

This will return immediately and complete asynchronously

Packit b00eeb
Packit b00eeb

Parameters

Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

object

Packit b00eeb

the object

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

attr_types

Packit b00eeb

the types of attributes to update.

Packit b00eeb
[array length=n_attr_types]
Packit b00eeb
Packit b00eeb
Packit b00eeb

n_attr_types

Packit b00eeb

the number of attribute types

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

cancellable

Packit b00eeb

optional cancellation object

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

callback

Packit b00eeb

called when the operation completes

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

user_data

Packit b00eeb

data to pass to the callback

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Packit b00eeb
Packit b00eeb

gck_object_cache_lookup_finish ()

Packit b00eeb
GckAttributes *
Packit b00eeb
gck_object_cache_lookup_finish (GckObject *object,
Packit b00eeb
                                GAsyncResult *result,
Packit b00eeb
                                GError **error);
Packit b00eeb

Complete an operation to lookup attributes in the cache or retrieve them

Packit b00eeb
from the object if necessary.

Packit b00eeb
Packit b00eeb

Parameters

Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

object

Packit b00eeb

the object

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

result

Packit b00eeb

the asynchrounous result passed to the callback

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

error

Packit b00eeb

location to place an error

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Returns

Packit b00eeb

the attributes retrieved or NULL on failure.

Packit b00eeb

[transfer full]

Packit b00eeb
Packit b00eeb
Packit b00eeb

Packit b00eeb
Packit b00eeb

gck_object_cache_update ()

Packit b00eeb
gboolean
Packit b00eeb
gck_object_cache_update (GckObjectCache *object,
Packit b00eeb
                         const gulong *attr_types,
Packit b00eeb
                         gint n_attr_types,
Packit b00eeb
                         GCancellable *cancellable,
Packit b00eeb
                         GError **error);
Packit b00eeb

Update the object cache with given attributes. If an attribute already

Packit b00eeb
exists in the cache, it will be updated, and if it doesn't it will be added.

Packit b00eeb

This may block, use the asynchronous version when this is not desirable

Packit b00eeb
Packit b00eeb

Parameters

Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

object

Packit b00eeb

the object with the cache

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

attr_types

Packit b00eeb

the types of attributes to update.

Packit b00eeb
[array length=n_attr_types]
Packit b00eeb
Packit b00eeb
Packit b00eeb

n_attr_types

Packit b00eeb

the number of attribute types

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

cancellable

Packit b00eeb

optional cancellation object

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

error

Packit b00eeb

location to place an error

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Returns

Packit b00eeb

whether the cache update was successful

Packit b00eeb
Packit b00eeb
Packit b00eeb

Packit b00eeb
Packit b00eeb

gck_object_cache_update_async ()

Packit b00eeb
void
Packit b00eeb
gck_object_cache_update_async (GckObjectCache *object,
Packit b00eeb
                               const gulong *attr_types,
Packit b00eeb
                               gint n_attr_types,
Packit b00eeb
                               GCancellable *cancellable,
Packit b00eeb
                               GAsyncReadyCallback callback,
Packit b00eeb
                               gpointer user_data);
Packit b00eeb

Update the object cache with given attributes. If an attribute already

Packit b00eeb
exists in the cache, it will be updated, and if it doesn't it will be added.

Packit b00eeb

This call will return immediately and complete asynchronously.

Packit b00eeb
Packit b00eeb

Parameters

Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

object

Packit b00eeb

the object with the cache

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

attr_types

Packit b00eeb

the types of attributes to update.

Packit b00eeb
[array length=n_attr_types]
Packit b00eeb
Packit b00eeb
Packit b00eeb

n_attr_types

Packit b00eeb

the number of attribute types

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

cancellable

Packit b00eeb

optional cancellation object

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

callback

Packit b00eeb

called when the operation completes

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

user_data

Packit b00eeb

data to be passed to the callback

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Packit b00eeb
Packit b00eeb

gck_object_cache_update_finish ()

Packit b00eeb
gboolean
Packit b00eeb
gck_object_cache_update_finish (GckObjectCache *object,
Packit b00eeb
                                GAsyncResult *result,
Packit b00eeb
                                GError **error);
Packit b00eeb

Complete an asynchronous operation to update the object cache with given

Packit b00eeb
attributes.

Packit b00eeb
Packit b00eeb

Parameters

Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

object

Packit b00eeb

the object with the cache

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

result

Packit b00eeb

the asynchronous result passed to the callback

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

error

Packit b00eeb

location to place an error

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Returns

Packit b00eeb

whether the cache update was successful

Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Types and Values

Packit b00eeb
Packit b00eeb

GckObjectCache

Packit b00eeb
typedef struct _GckObjectCache GckObjectCache;
Packit b00eeb

An interface implemented on an GckObject which contains a cache of attributes.

Packit b00eeb
Packit b00eeb

Packit b00eeb
Packit b00eeb

struct GckObjectCacheIface

Packit b00eeb
struct GckObjectCacheIface {
Packit b00eeb
	GTypeInterface interface;
Packit b00eeb
Packit b00eeb
	const gulong *  default_types;
Packit b00eeb
	gint            n_default_types;
Packit b00eeb
Packit b00eeb
	void         (* fill)                              (GckObjectCache *object,
Packit b00eeb
	                                                    GckAttributes *attrs);
Packit b00eeb
};
Packit b00eeb
Packit b00eeb

Interface for GckObjectCache. If the default_types

Packit b00eeb
 field is set by
Packit b00eeb
a implementing class, then the a GckEnumerator which has been setup using
Packit b00eeb
gck_enumerator_set_object_type()

Packit b00eeb

The implementation for populate

Packit b00eeb
 should add the attributes to the
Packit b00eeb
cache. It must be thread safe.

Packit b00eeb
Packit b00eeb

Members

Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

GTypeInterface interface;

Packit b00eeb

parent interface

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

const gulong *default_types;

Packit b00eeb

attribute types that an

Packit b00eeb
enumerator should retrieve. 

Packit b00eeb
[array length=n_default_types]
Packit b00eeb
Packit b00eeb
Packit b00eeb

gint n_default_types;

Packit b00eeb

number of attribute types to be retrieved

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb

fill ()

Packit b00eeb

virtual method to add attributes to the cache

Packit b00eeb
 
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Property Details

Packit b00eeb
Packit b00eeb

The “attributes” property

Packit b00eeb
  “attributes”               GckAttributes *
Packit b00eeb

The attributes cached on this object.

Packit b00eeb

Flags: Read / Write

Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb
Packit b00eeb

Generated by GTK-Doc V1.27.1
Packit b00eeb
</body>
Packit b00eeb
</html>