Data Entry

Base piece of data. More...

Data Structures
struct	Data_entry
	Struct defining a piece of data that can exist on the blackboard. More...

Functions
struct Data_entry *	Data_entry_init (uint64_t key, void *payload, size_t size)
	Creates a new Data_entry. More...
struct Data_entry *	Data_entry_clone (struct Data_entry *de)
	Clones a Data_entry. More...
void	Data_entry_release (struct Data_entry *de)
	Clears a Data_entry. More...
static void	Data_entry_reset_ref_count (struct Data_entry *de)
	Resets the ref_count of a Data_entry. More...
static uint64_t	Data_entry_get_ref_count (struct Data_entry *de)
	Getter on the ref_count of a Data_entry. More...
static void	Data_entry_inc_ref_count (struct Data_entry *de, uint64_t val)
	Increments the ref_count of a Data_entry by a given value. More...
static uint64_t	Data_entry_dec_ref_count (struct Data_entry *de)
	Decrements the ref_count of a Data_entry. More...
static uint64_t	Data_entry_get_key (struct Data_entry *de)
	Getter on the Data_entry key. More...
static size_t	Data_entry_get_payload_size (struct Data_entry *de)
	Getter on the Data_entry payload size. More...
static void *	Data_entry_get_payload (struct Data_entry *de)
	Getter on the actual data of a Data_entry. More...

Detailed Description

Base piece of data.

The Data_Entry is the base piece of data that can be "written" and "read" on the black board

Function Documentation

struct Data_entry* Data_entry_clone

(

struct Data_entry *

de

)

Clones a Data_entry.

Parameters

de	the Data_entry to clone

Returns

the cloned Data_entry

Definition at line 48 of file Data_Entry.c.

static uint64_t Data_entry_dec_ref_count ( struct Data_entry *  de )

inlinestatic

Decrements the ref_count of a Data_entry.

Parameters

de	the Data_entry

Returns

the new ref_count

Definition at line 127 of file Data_Entry.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static uint64_t Data_entry_get_key ( struct Data_entry *  de )

inlinestatic

Getter on the Data_entry key.

Parameters

de	the Data_entry

Returns

the key of the Data_entry

Definition at line 144 of file Data_Entry.h.

static void* Data_entry_get_payload ( struct Data_entry *  de )

inlinestatic

Getter on the actual data of a Data_entry.

Parameters

de	the Data_entry

Returns

the actual data

Definition at line 166 of file Data_Entry.h.

static size_t Data_entry_get_payload_size ( struct Data_entry *  de )

inlinestatic

Getter on the Data_entry payload size.

Parameters

de	the Data_entry

Returns

the size of actual data

Definition at line 155 of file Data_Entry.h.

static uint64_t Data_entry_get_ref_count ( struct Data_entry *  de )

inlinestatic

Getter on the ref_count of a Data_entry.

Parameters

de	the Data_entry

Returns

the ref_count of the Data_entry

Definition at line 94 of file Data_Entry.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static void Data_entry_inc_ref_count ( struct Data_entry *  de, uint64_t  val  )

inlinestatic

Increments the ref_count of a Data_entry by a given value.

Parameters

de	the Data_entry
val	the value to add to ref_count

Definition at line 112 of file Data_Entry.h.

Here is the call graph for this function:

Here is the caller graph for this function:

struct Data_entry* Data_entry_init	(	uint64_t	key,
		void *	payload,
		size_t	size
	)

Creates a new Data_entry.

Parameters

key	the data key
payload	the actual data
size	the size of data

Returns

the newly created Data_entry

Definition at line 25 of file Data_Entry.c.

Here is the caller graph for this function:

void Data_entry_release

(

struct Data_entry *

de

)

Clears a Data_entry.

Parameters

de	the Data_entry to clear

Definition at line 64 of file Data_Entry.c.

Here is the caller graph for this function:

static void Data_entry_reset_ref_count ( struct Data_entry *  de )

inlinestatic

Resets the ref_count of a Data_entry.

Parameters

de	the Data_entry

Definition at line 79 of file Data_Entry.h.

Here is the call graph for this function: