Common C types

Detailed Description

C types common to many parts of the API.

Typedefs
typedef int	bt_bool
	Babeltrace 2 boolean type. More...
typedef uint64_t	bt_listener_id
	Numeric ID which identifies a user listener function. More...
typedef const uint8_t *	bt_uuid
	A UUID, that is, an array of 16 constant bytes.
typedef enum bt_property_availability	bt_property_availability
	Availability of an object's property. More...
typedef const bt_message **	bt_message_array_const
	Array of constant messages. More...

Enumerations
enum	bt_property_availability {   BT_PROPERTY_AVAILABILITY_AVAILABLE,   BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE }
	Availability of an object's property. More...

Macros
#define	BT_TRUE
	True value for bt_bool.
#define	BT_FALSE
	False value for bt_bool.

Typedef Documentation

bt_bool

typedef int bt_bool

Babeltrace 2 boolean type.

The API uses bt_bool instead of the C99 bool type for application binary interface reasons.

Use BT_TRUE and BT_FALSE to set and compare bt_bool variables.

bt_listener_id

typedef uint64_t bt_listener_id

Numeric ID which identifies a user listener function.

Some functions, such as bt_trace_add_destruction_listener(), return a listener ID when you add a user listener function to some object. You can then use this listener ID to remove the listener from the object.

bt_property_availability

typedef enum bt_property_availability bt_property_availability

Availability of an object's property.

Some getter functions of the API, such as bt_event_class_get_log_level(), return, by output parameter, an optional object property which is not a pointer. In that case, the function either:

• Returns BT_PROPERTY_AVAILABILITY_AVAILABLE and sets an output parameter to the property's value.
• Returns BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE.

bt_message_array_const

typedef const bt_message** bt_message_array_const

Array of constant messages.

Such an array is filled by the "next" method of a message iterator and consumed with bt_message_iterator_next() by another message iterator or by a sink component.

Enumeration Type Documentation

bt_property_availability

enum bt_property_availability

Availability of an object's property.

Some getter functions of the API, such as bt_event_class_get_log_level(), return, by output parameter, an optional object property which is not a pointer. In that case, the function either:

• Returns BT_PROPERTY_AVAILABILITY_AVAILABLE and sets an output parameter to the property's value.
• Returns BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE.

Enumerator
BT_PROPERTY_AVAILABILITY_AVAILABLE	Property is available.
BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE	Property is not available.