ArbiterUserContext Struct Reference

Represents opaque data that can be passed to Arbiter data types and functionality, then later retrieved. More...

Collaboration diagram for ArbiterUserContext:

Public Attributes
void *	data
	The underlying data pointer. More...
void(*	destructor )(void *data)
	A cleanup function to call when the ArbiterUserContext is done being used. More...

Detailed Description

Represents opaque data that can be passed to Arbiter data types and functionality, then later retrieved.

This type is used instead of raw pointers to make memory management safer.

Definition at line 73 of file Value.h.

Member Data Documentation

data

void* ArbiterUserContext::data

The underlying data pointer.

This pointer should be considered to be owned by Arbiter as soon as the ArbiterUserContext is passed into any API. It will eventually be cleaned up by the library through invocation of the provided destructor.

Definition at line 82 of file Value.h.

destructor

void(* ArbiterUserContext::destructor) (void *data)

A cleanup function to call when the ArbiterUserContext is done being used.

This may be NULL.

Definition at line 89 of file Value.h.

---

The documentation for this struct was generated from the following file:

• include/arbiter/Value.h