Object related classes: Plasma GLib Reference Manual

Object related classes

Functions

GPlasmaObjectID *	gplasma_object_id_new ()
const guint8 *	gplasma_object_id_to_binary ()
gchar *	gplasma_object_id_to_hex ()
gboolean	gplasma_created_object_seal ()
gboolean	gplasma_created_object_abort ()
gboolean	gplasma_referred_object_release ()

Properties

GPlasmaClient *	client	Read / Write / Construct Only
GArrowBuffer *	data	Read / Write / Construct Only
gint	gpu-device	Read / Write / Construct Only
GPlasmaObjectID *	id	Read / Write / Construct Only
GArrowBuffer *	metadata	Read / Write / Construct Only
gpointer	raw-data	Write / Construct Only
gpointer	raw-metadata	Write / Construct Only

Types and Values

#define	GPLASMA_TYPE_OBJECT_ID
struct	GPlasmaObjectIDClass
#define	GPLASMA_TYPE_OBJECT
struct	GPlasmaObjectClass
#define	GPLASMA_TYPE_CREATED_OBJECT
struct	GPlasmaCreatedObjectClass
#define	GPLASMA_TYPE_REFERRED_OBJECT
struct	GPlasmaReferredObjectClass
	GPlasmaCreatedObject
	GPlasmaObject
	GPlasmaObjectID
	GPlasmaReferredObject

Object Hierarchy

    GObject
    ├── GPlasmaObject
    │   ├── GPlasmaCreatedObject
    │   ├── GPlasmaReferredObject
    │   ╰── GPlasmaCreatedObject
    ╰── GPlasmaObjectID

Includes

#include <plasma-glib/plasma-glib.h>

Description

GPlasmaObjectID is a class for an object ID.

GPlasmaObject is a base class for an object stored in plasma store.

GPlasmaCreatedObject is a class for a created object. You can change data of the object until the object is sealed or aborted.

GPlasmaReferredObject is a class for a created object. You can only refer the data and metadata of the object. You can't change the data of the object.

Functions

gplasma_object_id_new ()

GPlasmaObjectID *
gplasma_object_id_new (const guint8 *id,
                       gsize size,
                       GError **error);

Parameters

id	The raw ID bytes.	[array length=size]
size	The number of bytes of the ID. It must be 1..20.
error	Return location for a GError or `NULL`.	[nullable]

Returns

A newly created GPlasmaObjectID on success, NULL on error.

[nullable]

Since: 0.12.0

gplasma_object_id_to_binary ()

const guint8 *
gplasma_object_id_to_binary (GPlasmaObjectID *id,
                             gsize *size);

Parameters

id	A GPlasmaObjectID.
size	The number of bytes of the byte string of the object ID. It's always 20. 20 is `plasma::kUniqueIDSize`.	[nullable][out]

Returns

The byte string of the object ID.

[array length=size]

Since: 0.12.0

gplasma_object_id_to_hex ()

gchar *
gplasma_object_id_to_hex (GPlasmaObjectID *id);

Parameters

A GPlasmaObjectID.

Returns

The hex representation of the object ID.

It should be freed with g_free() when no longer needed.

[transfer full]

Since: 0.12.0

gplasma_created_object_seal ()

gboolean
gplasma_created_object_seal (GPlasmaCreatedObject *object,
                             GError **error);

Seals the object in the object store. You can't use the sealed object anymore.

Parameters

object	A GPlasmaCreatedObject.
error	Return location for a GError or `NULL`.	[nullable]

Returns

TRUE on success, FALSE on error.

Since: 0.12.0

gplasma_created_object_abort ()

gboolean
gplasma_created_object_abort (GPlasmaCreatedObject *object,
                              GError **error);

Aborts the object in the object store. You can't use the aborted object anymore.

Parameters

object	A GPlasmaCreatedObject.
error	Return location for a GError or `NULL`.	[nullable]

Returns

TRUE on success, FALSE on error.

Since: 0.12.0

gplasma_referred_object_release ()

gboolean
gplasma_referred_object_release (GPlasmaReferredObject *object,
                                 GError **error);

Releases the object explicitly. The object is no longer valid.

Parameters

object	A GPlasmaReferredObject.
error	Return location for a GError or `NULL`.	[nullable]

Returns

TRUE on success, FALSE on error.

Since: 0.12.0

Types and Values

GPLASMA_TYPE_OBJECT_ID

#define GPLASMA_TYPE_OBJECT_ID (gplasma_object_id_get_type())

struct GPlasmaObjectIDClass

struct GPlasmaObjectIDClass {
  GObjectClass parent_class;
};

GPLASMA_TYPE_OBJECT

#define GPLASMA_TYPE_OBJECT (gplasma_object_get_type())

struct GPlasmaObjectClass

struct GPlasmaObjectClass {
  GObjectClass parent_class;
};

GPLASMA_TYPE_CREATED_OBJECT

#define GPLASMA_TYPE_CREATED_OBJECT (gplasma_created_object_get_type())

struct GPlasmaCreatedObjectClass

struct GPlasmaCreatedObjectClass {
  GPlasmaObjectClass parent_class;
};

GPLASMA_TYPE_REFERRED_OBJECT

#define GPLASMA_TYPE_REFERRED_OBJECT (gplasma_referred_object_get_type())

struct GPlasmaReferredObjectClass

struct GPlasmaReferredObjectClass {
  GPlasmaObjectClass parent_class;
};

GPlasmaCreatedObject

typedef struct _GPlasmaCreatedObject GPlasmaCreatedObject;

GPlasmaObject

typedef struct _GPlasmaObject GPlasmaObject;

GPlasmaObjectID

typedef struct _GPlasmaObjectID GPlasmaObjectID;

GPlasmaReferredObject

typedef struct _GPlasmaReferredObject GPlasmaReferredObject;

Property Details

The `“client”` property

  “client”                   GPlasmaClient *

The client.

Owner: GPlasmaObject

Flags: Read / Write / Construct Only

The `“data”` property

  “data”                     GArrowBuffer *

The data of this object.

Owner: GPlasmaObject

Flags: Read / Write / Construct Only

The `“gpu-device”` property

  “gpu-device”               gint

The GPU device number. -1 means GPU isn't used.

Owner: GPlasmaObject

Flags: Read / Write / Construct Only

Allowed values: >= -1

Default value: -1

The `“id”` property

  “id”                       GPlasmaObjectID *

The ID of this object.

Owner: GPlasmaObject

Flags: Read / Write / Construct Only

The `“metadata”` property

  “metadata”                 GArrowBuffer *

The metadata of this object.

Owner: GPlasmaObject

Flags: Read / Write / Construct Only

The `“raw-data”` property

  “raw-data”                 gpointer

The raw data of this object.

Owner: GPlasmaObject

Flags: Write / Construct Only

The `“raw-metadata”` property

  “raw-metadata”             gpointer

The raw metadata of this object.

Owner: GPlasmaObject

Flags: Write / Construct Only