Collection

Data Structures
struct	JCollection

Functions
G_GNUC_INTERNAL JCollection *	j_collection_new (gchar const *name)
JCollection *	j_collection_ref (JCollection *collection)
void	j_collection_unref (JCollection *collection)
gchar const *	j_collection_get_name (JCollection *collection)
JCollection *	j_collection_create (gchar const *name, JBatch *batch)
void	j_collection_get (JCollection **collection, gchar const *name, JBatch *batch)
void	j_collection_delete (JCollection *collection, JBatch *batch)

Detailed Description

Data structures and functions for managing collections.

Function Documentation

j_collection_create()

JCollection * j_collection_create	(	gchar const *	name,
		JBatch *	batch
	)

Creates a collection.

Parameters

name	A name for the new collection.
batch	A batch.

j_collection_delete()

void j_collection_delete	(	JCollection *	collection,
		JBatch *	batch
	)

Deletes a collection.

Parameters

collection	A collection.
batch	A batch.

j_collection_get()

void j_collection_get	(	JCollection **	collection,
		gchar const *	name,
		JBatch *	batch
	)

Gets a collection.

Parameters

collection	A pointer to a collection.
name	A name.
batch	A batch.

j_collection_get_name()

gchar const * j_collection_get_name

(

JCollection *

collection

)

Returns a collection's name.

Parameters

collection

A collection.

Returns

A collection name.

j_collection_new()

JCollection * j_collection_new

(

gchar const *

name

)

Creates a new collection.

JCollection* c;
 
c = j_collection_new("JULEA");

Parameters

name	A collection name.

Returns

A new collection. Should be freed with j_collection_unref().

j_collection_ref()

JCollection * j_collection_ref

(

JCollection *

collection

)

Increases a collection's reference count.

JCollection* c;
 
j_collection_ref(c);

Parameters

collection

A collection.

Returns

collection.

j_collection_unref()

void j_collection_unref

(

JCollection *

collection

)

Decreases a collection's reference count. When the reference count reaches zero, frees the memory allocated for the collection.

Parameters

collection

A collection.