Babeltrace 2 C API  2.1.0
Open-source trace manipulation framework
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 uint8_t const * bt_uuid
 A UUID, that is, an array of 16 constant bytes.
 
typedef enum bt_property_availability bt_property_availability
 Availability of an object property. More...
 
typedef bt_message const ** 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 property. More...
 

Macros

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

Typedef Documentation

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.

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.

Availability of an object property.

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

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

Availability of an object property.

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

Enumerator
BT_PROPERTY_AVAILABILITY_AVAILABLE 

Property is available.

BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE 

Property isn't available.