Detailed Description

Class of events.

An event class is the class of events, which event messages contain:

In the illustration above, notice that:

A stream is a conceptual sequence of messages, some of which are event messages.
An event message contains an event.
An event is an instance of an event class.
The payload field of an event is an instance of the payload field class which an event class contains.

An event class is a trace IR metadata object.

An event class is a shared object: get a new reference with bt_event_class_get_ref() and put an existing reference with bt_event_class_put_ref().

Some library functions freeze event classes on success. The documentation of those functions indicate this postcondition.

The type of an event class is bt_event_class.

A stream class contains event classes. All the event classes of a given stream class have unique numeric IDs. Borrow the stream class which contains an event class with bt_event_class_borrow_stream_class() or bt_event_class_borrow_stream_class_const().

To create a default event class:

If bt_stream_class_assigns_automatic_event_class_id() returns BT_TRUE (the default) for the stream class to use

Use bt_event_class_create().

If bt_stream_class_assigns_automatic_event_class_id() returns BT_FALSE for the stream class to use

Use bt_event_class_create_with_id().

Properties

An event class has the following properties:

Numeric ID

Numeric ID, unique amongst the numeric IDs of the event classes of the parent stream class.

Depending on whether or not the stream class of the event class automatically assigns event class IDs (see bt_stream_class_assigns_automatic_event_class_id()), set the numeric ID of the event class on creation with bt_event_class_create() or bt_event_class_create_with_id().

You cannot change the numeric ID once the event class is created.

Get the numeric ID of an event class with bt_event_class_get_id().

Optional: Namespace (only available when the parent trace class was created from a component which belongs to a trace processing graph with the effective Message Interchange Protocol version 1; available since Babeltrace 2.1)

Namespace of the event class.

Use bt_event_class_set_namespace() and bt_event_class_get_namespace().

Optional: Name

Name of the event class.

Use bt_event_class_set_name() and bt_event_class_get_name().

Optional: UID (only available when the parent trace class was created from a component which belongs to a trace processing graph with the effective Message Interchange Protocol version 1; available since Babeltrace 2.1)

Unique identifier (UID) of the event class.

Use bt_event_class_set_uid() and bt_event_class_get_uid().

Optional: Log level

Log level of the event class.

The log level of the event class corresponds to the log level of the original instrumentation point of the tracer.

Use bt_event_class_set_log_level() and bt_event_class_get_log_level().

Optional: Eclipse Modeling Framework (EMF) URI

EMF URI of the event class.

Use bt_event_class_set_emf_uri() and bt_event_class_get_emf_uri().

Optional: Payload field class

Payload field class of the event class.

The payload of an event class instance (event) contains the main data of the event.

Use bt_event_class_set_payload_field_class() bt_event_class_borrow_payload_field_class(), and bt_event_class_borrow_payload_field_class_const().

Optional: Specific context field class

Specific context field class of the event class.

The specific context of an event class instance (event) contains any contextual data of which the layout is specific to the class of the event and which doesn't belong to the payload.

Use bt_event_class_set_specific_context_field_class() bt_event_class_borrow_specific_context_field_class(), and bt_event_class_borrow_specific_context_field_class_const().

Optional: User attributes

User attributes of the event class.

User attributes are custom attributes attached to an event class.

Use bt_event_class_set_user_attributes(), bt_event_class_borrow_user_attributes(), and bt_event_class_borrow_user_attributes_const().

Properties
enum	bt_event_class_set_namespace_status { BT_EVENT_CLASS_SET_NAMESPACE_STATUS_OK , BT_EVENT_CLASS_SET_NAMESPACE_STATUS_MEMORY_ERROR }
	Status codes for bt_event_class_set_namespace(). More...

enum	bt_event_class_set_name_status { BT_EVENT_CLASS_SET_NAME_STATUS_OK , BT_EVENT_CLASS_SET_NAME_STATUS_MEMORY_ERROR }
	Status codes for bt_event_class_set_name(). More...

enum	bt_event_class_set_uid_status { BT_EVENT_CLASS_SET_UID_STATUS_OK , BT_EVENT_CLASS_SET_UID_STATUS_MEMORY_ERROR }
	Status codes for bt_event_class_set_uid(). More...

enum	bt_event_class_log_level { BT_EVENT_CLASS_LOG_LEVEL_EMERGENCY , BT_EVENT_CLASS_LOG_LEVEL_ALERT , BT_EVENT_CLASS_LOG_LEVEL_CRITICAL , BT_EVENT_CLASS_LOG_LEVEL_ERROR , BT_EVENT_CLASS_LOG_LEVEL_WARNING , BT_EVENT_CLASS_LOG_LEVEL_NOTICE , BT_EVENT_CLASS_LOG_LEVEL_INFO , BT_EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM , BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM , BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS , BT_EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE , BT_EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT , BT_EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION , BT_EVENT_CLASS_LOG_LEVEL_DEBUG_LINE , BT_EVENT_CLASS_LOG_LEVEL_DEBUG }
	Event class log level enumerators. More...

enum	bt_event_class_set_emf_uri_status { BT_EVENT_CLASS_SET_EMF_URI_STATUS_OK , BT_EVENT_CLASS_SET_EMF_URI_STATUS_MEMORY_ERROR }
	Status codes for bt_event_class_set_emf_uri(). More...

enum	bt_event_class_set_field_class_status { BT_EVENT_CLASS_SET_FIELD_CLASS_STATUS_OK , BT_EVENT_CLASS_SET_FIELD_CLASS_STATUS_MEMORY_ERROR }
	Status codes for bt_event_class_set_payload_field_class() and bt_event_class_set_specific_context_field_class(). More...

typedef enum bt_event_class_set_namespace_status	bt_event_class_set_namespace_status
	Status codes for bt_event_class_set_namespace().

typedef enum bt_event_class_set_name_status	bt_event_class_set_name_status
	Status codes for bt_event_class_set_name().

typedef enum bt_event_class_set_uid_status	bt_event_class_set_uid_status
	Status codes for bt_event_class_set_uid().

typedef enum bt_event_class_log_level	bt_event_class_log_level
	Event class log level enumerators.

typedef enum bt_event_class_set_emf_uri_status	bt_event_class_set_emf_uri_status
	Status codes for bt_event_class_set_emf_uri().

typedef enum bt_event_class_set_field_class_status	bt_event_class_set_field_class_status
	Status codes for bt_event_class_set_payload_field_class() and bt_event_class_set_specific_context_field_class().

uint64_t	bt_event_class_get_id (const bt_event_class *event_class)
	Returns the numeric ID of the event class event_class.

bt_event_class_set_namespace_status	bt_event_class_set_namespace (bt_event_class event_class, const char ns)
	Sets the namespace of the event class event_class to a copy of ns.

const char *	bt_event_class_get_namespace (const bt_event_class *event_class)
	Returns the namespace of the event class event_class.

bt_event_class_set_name_status	bt_event_class_set_name (bt_event_class event_class, const char name)
	Sets the name of the event class event_class to a copy of name.

bt_event_class_set_uid_status	bt_event_class_set_uid (bt_event_class event_class, const char uid)
	Sets the unique identifier (UID) of the stream class event_class to a copy of uid.

const char *	bt_event_class_get_uid (const bt_event_class *event_class)
	Returns the UID of the event class event_class.

const char *	bt_event_class_get_name (const bt_event_class *event_class)
	Returns the name of the event class event_class.

void	bt_event_class_set_log_level (bt_event_class *event_class, bt_event_class_log_level log_level)
	Sets the log level of the event class event_class to log_level.

bt_property_availability	bt_event_class_get_log_level (const bt_event_class event_class, bt_event_class_log_level log_level)
	Returns the log level of the event class event_class.

bt_event_class_set_emf_uri_status	bt_event_class_set_emf_uri (bt_event_class event_class, const char emf_uri)
	Sets the Eclipse Modeling Framework (EMF) URI of the event class event_class to a copy of emf_uri.

const char *	bt_event_class_get_emf_uri (const bt_event_class *event_class)
	Returns the Eclipse Modeling Framework (EMF) URI of the event class event_class.

bt_event_class_set_field_class_status	bt_event_class_set_payload_field_class (bt_event_class event_class, bt_field_class field_class)
	Sets the payload field class of the event class event_class to field_class.

bt_field_class *	bt_event_class_borrow_payload_field_class (bt_event_class *event_class)
	Borrows the payload field class from the event class event_class.

const bt_field_class *	bt_event_class_borrow_payload_field_class_const (const bt_event_class *event_class)
	Borrows the payload field class from the event class event_class (`const` version).

bt_event_class_set_field_class_status	bt_event_class_set_specific_context_field_class (bt_event_class event_class, bt_field_class field_class)
	Sets the specific context field class of the event class event_class to field_class.

bt_field_class *	bt_event_class_borrow_specific_context_field_class (bt_event_class *event_class)
	Borrows the specific context field class from the event class event_class.

const bt_field_class *	bt_event_class_borrow_specific_context_field_class_const (const bt_event_class *event_class)
	Borrows the specific context field class from the event class event_class (`const` version).

void	bt_event_class_set_user_attributes (bt_event_class event_class, const bt_value user_attributes)
	Sets the user attributes of the event class event_class to user_attributes.

bt_value *	bt_event_class_borrow_user_attributes (bt_event_class *event_class)
	Borrows the user attributes of the event class event_class.

const bt_value *	bt_event_class_borrow_user_attributes_const (const bt_event_class *event_class)
	Borrows the user attributes of the event class event_class (`const` version).

Type
typedef struct bt_event_class	bt_event_class
	Event class.

Creation
bt_event_class *	bt_event_class_create (bt_stream_class *stream_class)
	Creates a default event class and adds it to the stream class stream_class.

bt_event_class *	bt_event_class_create_with_id (bt_stream_class *stream_class, uint64_t id)
	Creates a default event class with the numeric ID id and adds it to the stream class stream_class.

Stream class access
bt_stream_class *	bt_event_class_borrow_stream_class (bt_event_class *event_class)
	Borrows the stream class which contains the event class event_class.

const bt_stream_class *	bt_event_class_borrow_stream_class_const (const bt_event_class *event_class)
	Borrows the stream class which contains the event class event_class (`const` version).

Reference count
void	bt_event_class_get_ref (const bt_event_class *event_class)
	Increments the reference count of the event class event_class.

void	bt_event_class_put_ref (const bt_event_class *event_class)
	Decrements the reference count of the event class event_class.

#define	BT_EVENT_CLASS_PUT_REF_AND_RESET(_event_class)
	Decrements the reference count of the event class _event_class, and then sets _event_class to `NULL`.

#define	BT_EVENT_CLASS_MOVE_REF(_dst, _src)
	Decrements the reference count of the event class _dst, sets _dst to _src, and then sets _src to `NULL`.

Typedef Documentation

◆ bt_event_class_set_namespace_status

typedef enum bt_event_class_set_namespace_status bt_event_class_set_namespace_status

Status codes for bt_event_class_set_namespace().

Since: Babeltrace 2.1

◆ bt_event_class_set_uid_status

typedef enum bt_event_class_set_uid_status bt_event_class_set_uid_status

Status codes for bt_event_class_set_uid().

Since: Babeltrace 2.1

Enumeration Type Documentation

◆ bt_event_class_set_namespace_status

enum bt_event_class_set_namespace_status

Status codes for bt_event_class_set_namespace().

Since: Babeltrace 2.1

Enumerator
BT_EVENT_CLASS_SET_NAMESPACE_STATUS_OK	Success.
BT_EVENT_CLASS_SET_NAMESPACE_STATUS_MEMORY_ERROR	Out of memory.

◆ bt_event_class_set_name_status

enum bt_event_class_set_name_status

Status codes for bt_event_class_set_name().

Enumerator
BT_EVENT_CLASS_SET_NAME_STATUS_OK	Success.
BT_EVENT_CLASS_SET_NAME_STATUS_MEMORY_ERROR	Out of memory.

◆ bt_event_class_set_uid_status

enum bt_event_class_set_uid_status

Status codes for bt_event_class_set_uid().

Since: Babeltrace 2.1

Enumerator
BT_EVENT_CLASS_SET_UID_STATUS_OK	Success.
BT_EVENT_CLASS_SET_UID_STATUS_MEMORY_ERROR	Out of memory.

◆ bt_event_class_log_level

enum bt_event_class_log_level

Event class log level enumerators.

Enumerator
BT_EVENT_CLASS_LOG_LEVEL_EMERGENCY	System is unusable.
BT_EVENT_CLASS_LOG_LEVEL_ALERT	Action must be taken immediately.
BT_EVENT_CLASS_LOG_LEVEL_CRITICAL	Critical conditions.
BT_EVENT_CLASS_LOG_LEVEL_ERROR	Error conditions.
BT_EVENT_CLASS_LOG_LEVEL_WARNING	Warning conditions.
BT_EVENT_CLASS_LOG_LEVEL_NOTICE	Normal, but significant, condition.
BT_EVENT_CLASS_LOG_LEVEL_INFO	Informational message.
BT_EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM	Debugging information with system-level scope (set of programs).
BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM	Debugging information with program-level scope (set of processes).
BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS	Debugging information with process-level scope (set of modules).
BT_EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE	Debugging information with module (executable/library) scope (set of units).
BT_EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT	Debugging information with compilation unit scope (set of functions).
BT_EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION	Debugging information with function-level scope.
BT_EVENT_CLASS_LOG_LEVEL_DEBUG_LINE	Debugging information with function-level scope.
BT_EVENT_CLASS_LOG_LEVEL_DEBUG	Debugging-level message.

◆ bt_event_class_set_emf_uri_status

enum bt_event_class_set_emf_uri_status

Status codes for bt_event_class_set_emf_uri().

Enumerator
BT_EVENT_CLASS_SET_EMF_URI_STATUS_OK	Success.
BT_EVENT_CLASS_SET_EMF_URI_STATUS_MEMORY_ERROR	Out of memory.

◆ bt_event_class_set_field_class_status

enum bt_event_class_set_field_class_status

Status codes for bt_event_class_set_payload_field_class() and bt_event_class_set_specific_context_field_class().

Enumerator
BT_EVENT_CLASS_SET_FIELD_CLASS_STATUS_OK	Success.
BT_EVENT_CLASS_SET_FIELD_CLASS_STATUS_MEMORY_ERROR	Out of memory.

Macro Definition Documentation

◆ BT_EVENT_CLASS_PUT_REF_AND_RESET

#define BT_EVENT_CLASS_PUT_REF_AND_RESET ( _event_class )

Decrements the reference count of the event class _event_class, and then sets _event_class to NULL.

Parameters

_event_class

Event class of which to decrement the reference count.

Can contain NULL.

Precondition: _event_class is an assignable expression.

◆ BT_EVENT_CLASS_MOVE_REF

#define BT_EVENT_CLASS_MOVE_REF	(		_dst,
			_src )

Decrements the reference count of the event class _dst, sets _dst to _src, and then sets _src to NULL.

This macro effectively moves an event class reference from the expression _src to the expression _dst, putting the existing _dst reference.

Parameters

_dst

Destination expression.

Can contain NULL.

_src

Source expression.

Can contain NULL.

Precondition: _dst is an assignable expression.; _src is an assignable expression.

Function Documentation

◆ bt_event_class_create()

bt_event_class * bt_event_class_create ( bt_stream_class * stream_class )

extern

Creates a default event class and adds it to the stream class stream_class.

Attention

Only use this function if

bt_stream_class_assigns_automatic_event_class_id(stream_class)

bt_stream_class_assigns_automatic_event_class_id

bt_bool bt_stream_class_assigns_automatic_event_class_id(const bt_stream_class *stream_class)

Returns whether or not the stream class stream_class automatically assigns a numeric ID to an event c...

returns BT_TRUE.

Otherwise, use bt_event_class_create_with_id().

On success, the returned event class has the following property values:

Property	Value
Numeric ID	Automatically assigned by stream_class
Message Interchange Protocol version 1: namespace (available since Babeltrace 2.1)	None
Name	None
MIP 1: UID (available since Babeltrace 2.1)	None
Log level	None
EMF URI	None
Payload field class	None
Specific context field class	None
User attributes	Empty map value

Parameters

[in] stream_class Stream class to add the created event class to.

Returns: New event class reference, or NULL on memory error.

Precondition: stream_class is not NULL.; bt_stream_class_assigns_automatic_event_class_id(stream_class) returns BT_TRUE.

Postcondition: On success, stream_class is frozen.

See also: bt_event_class_create_with_id() — Creates an event class with a specific numeric ID and adds it to a stream class.

◆ bt_event_class_create_with_id()

bt_event_class * bt_event_class_create_with_id	(	bt_stream_class *	stream_class,
		uint64_t	id )

extern

Creates a default event class with the numeric ID id and adds it to the stream class stream_class.

Attention

Only use this function if

bt_stream_class_assigns_automatic_event_class_id(stream_class)

returns BT_FALSE.

Otherwise, use bt_event_class_create().

On success, the returned event class has the following property values:

Property	Value
Numeric ID	id
Message Interchange Protocol version 1: namespace (available since Babeltrace 2.1)	None
Name	None
MIP 1: UID (available since Babeltrace 2.1)	None
Log level	None
EMF URI	None
Payload field class	None
Specific context field class	None
User attributes	Empty map value

Parameters

[in]	stream_class	Stream class to add the created event class to.
[in]	id	Numeric ID of the event class to create and add to stream_class.

Returns: New event class reference, or NULL on memory error.

Precondition: stream_class is not NULL.; bt_stream_class_assigns_automatic_event_class_id(stream_class) returns BT_FALSE.; stream_class doesn't contain an event class with the numeric ID id.

Postcondition: On success, stream_class is frozen.

See also: bt_event_class_create() — Creates an event class with an automatic numeric ID and adds it to a stream class.

◆ bt_event_class_borrow_stream_class()

bt_stream_class * bt_event_class_borrow_stream_class ( bt_event_class * event_class )

extern

Borrows the stream class which contains the event class event_class.

Parameters

[in] event_class Event class from which to borrow the stream class which contains it.

Returns: Stream class which contains event_class.

Precondition: event_class is not NULL.

See also: bt_event_class_borrow_stream_class_const() — const version of this function.

◆ bt_event_class_borrow_stream_class_const()

const bt_stream_class * bt_event_class_borrow_stream_class_const ( const bt_event_class * event_class )

extern

Borrows the stream class which contains the event class event_class (const version).

See bt_event_class_borrow_stream_class().

◆ bt_event_class_get_id()

uint64_t bt_event_class_get_id ( const bt_event_class * event_class )

extern

Returns the numeric ID of the event class event_class.

See the numeric ID property.

Parameters

[in] event_class Event class of which to get the numeric ID.

Returns: Numeric ID of event_class.

Precondition: event_class is not NULL.

See also: bt_event_class_create_with_id() — Creates an event class with a specific numeric ID and adds it to a stream class.

◆ bt_event_class_set_namespace()

bt_event_class_set_namespace_status bt_event_class_set_namespace	(	bt_event_class *	event_class,
		const char *	ns )

extern

Sets the namespace of the event class event_class to a copy of ns.

See the namespace property.

Parameters

[in]	event_class	Event class of which to set the namespace to ns.
[in]	ns	New namespace of event_class (copied).

Return values

BT_EVENT_CLASS_SET_NAMESPACE_STATUS_OK	Success.
BT_EVENT_CLASS_SET_NAMESPACE_STATUS_MEMORY_ERROR	Out of memory.

Since: Babeltrace 2.1

Precondition: event_class is not NULL.; event_class is not frozen.; The parent trace class of event_class was created from a component which belongs to a trace processing graph with the effective Message Interchange Protocol version 1.; ns is not NULL.

See also: bt_event_class_get_namespace() — Returns the namespace of an event class.

◆ bt_event_class_get_namespace()

const char * bt_event_class_get_namespace ( const bt_event_class * event_class )

extern

Returns the namespace of the event class event_class.

See the namespace property.

If event_class has no namespace, then this function returns NULL.

Parameters

[in] event_class Event class of which to get the namespace.

Returns

Namespace of event_class, or NULL if none.

The returned pointer remains valid as long as event_class isn't modified.

Since: Babeltrace 2.1

Precondition: event_class is not NULL.; The parent trace class of event_class was created from a component which belongs to a trace processing graph with the effective Message Interchange Protocol version 1.

See also: bt_event_class_set_namespace() — Sets the namespace of a event class.

◆ bt_event_class_set_name()

bt_event_class_set_name_status bt_event_class_set_name	(	bt_event_class *	event_class,
		const char *	name )

extern

Sets the name of the event class event_class to a copy of name.

See the name property.

Parameters

[in]	event_class	Event class of which to set the name to name.
[in]	name	New name of event_class (copied).

Return values

BT_EVENT_CLASS_SET_NAME_STATUS_OK	Success.
BT_EVENT_CLASS_SET_NAME_STATUS_MEMORY_ERROR	Out of memory.

Precondition: event_class is not NULL.; event_class is not frozen.; name is not NULL.

See also: bt_event_class_get_name() — Returns the name of an event class.

◆ bt_event_class_set_uid()

bt_event_class_set_uid_status bt_event_class_set_uid	(	bt_event_class *	event_class,
		const char *	uid )

extern

Sets the unique identifier (UID) of the stream class event_class to a copy of uid.

See the UID property.

Parameters

[in]	event_class	Event class of which to set the UID to uid.
[in]	uid	New UID of event_class (copied).

Return values

BT_EVENT_CLASS_SET_UID_STATUS_OK	Success.
BT_EVENT_CLASS_SET_UID_STATUS_MEMORY_ERROR	Out of memory.

Since: Babeltrace 2.1

Precondition: event_class is not NULL.; event_class is not frozen.; The parent trace class of event_class was created from a component which belongs to a trace processing graph with the effective Message Interchange Protocol version 1.; uid is not NULL.

See also: bt_event_class_get_uid() — Returns the UID of an event class.

◆ bt_event_class_get_uid()

const char * bt_event_class_get_uid ( const bt_event_class * event_class )

extern

Returns the UID of the event class event_class.

See the UID property.

If event_class has no UID, then this function returns NULL.

Parameters

[in] event_class Event class of which to get the UID.

Returns

UID of event_class, or NULL if none.

The returned pointer remains valid as long as event_class isn't modified.

Since: Babeltrace 2.1

Precondition: event_class is not NULL.; The parent trace class of event_class was created from a component which belongs to a trace processing graph with the effective Message Interchange Protocol version 1.

See also: bt_event_class_set_uid() — Sets the UID of an event class.

◆ bt_event_class_get_name()

const char * bt_event_class_get_name ( const bt_event_class * event_class )

extern

Returns the name of the event class event_class.

See the name property.

If event_class has no name, then this function returns NULL.

Parameters

[in] event_class Event class of which to get the name.

Returns

Name of event_class, or NULL if none.

The returned pointer remains valid as long as event_class isn't modified.

Precondition: event_class is not NULL.

See also: bt_event_class_set_name() — Sets the name of an event class.

◆ bt_event_class_set_log_level()

void bt_event_class_set_log_level	(	bt_event_class *	event_class,
		bt_event_class_log_level	log_level )

extern

Sets the log level of the event class event_class to log_level.

See the log level property.

Parameters

[in]	event_class	Event class of which to set the log level to log_level.
[in]	log_level	New log level of event_class.

Precondition: event_class is not NULL.; event_class is not frozen.

See also: bt_event_class_get_log_level() — Returns the log level of an event class.

◆ bt_event_class_get_log_level()

bt_property_availability bt_event_class_get_log_level	(	const bt_event_class *	event_class,
		bt_event_class_log_level *	log_level )

extern

Returns the log level of the event class event_class.

See the log level property.

Parameters

[in]	event_class	Event class of which to get the log level.
[out]	log_level	If this function returns BT_PROPERTY_AVAILABILITY_AVAILABLE, then *log_level is the log level of event_class.

Return values

BT_PROPERTY_AVAILABILITY_AVAILABLE	The log level of event_class is available.
BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE	The log level of event_class isn't available.

Precondition: event_class is not NULL.; log_level is not NULL.

See also: bt_event_class_set_log_level() — Sets the log level of an event class.

◆ bt_event_class_set_emf_uri()

bt_event_class_set_emf_uri_status bt_event_class_set_emf_uri	(	bt_event_class *	event_class,
		const char *	emf_uri )

extern

Sets the Eclipse Modeling Framework (EMF) URI of the event class event_class to a copy of emf_uri.

See the EMF URI property.

Parameters

[in]	event_class	Event class of which to set the EMF URI to emf_uri.
[in]	emf_uri	New EMF URI of event_class (copied).

Return values

BT_EVENT_CLASS_SET_EMF_URI_STATUS_OK	Success.
BT_EVENT_CLASS_SET_EMF_URI_STATUS_MEMORY_ERROR	Out of memory.

Precondition: event_class is not NULL.; event_class is not frozen.; emf_uri is not NULL.

See also: bt_event_class_get_emf_uri() — Returns the EMF URI of an event class.

◆ bt_event_class_get_emf_uri()

const char * bt_event_class_get_emf_uri ( const bt_event_class * event_class )

extern

Returns the Eclipse Modeling Framework (EMF) URI of the event class event_class.

See the EMF URI property.

If event_class has no EMF URI, then this function returns NULL.

Parameters

[in] event_class Event class of which to get the EMF URI.

Returns

EMF URI of event_class, or NULL if none.

The returned pointer remains valid as long as event_class isn't modified.

Precondition: event_class is not NULL.

See also: bt_event_class_set_emf_uri() — Sets the EMF URI of an event class.

◆ bt_event_class_set_payload_field_class()

bt_event_class_set_field_class_status bt_event_class_set_payload_field_class	(	bt_event_class *	event_class,
		bt_field_class *	field_class )

extern

Sets the payload field class of the event class event_class to field_class.

See the payload field class property.

Parameters

[in]	event_class	Event class of which to set the payload field class to field_class.
[in]	field_class	New payload field class of event_class.

Return values

BT_EVENT_CLASS_SET_FIELD_CLASS_STATUS_OK	Success.
BT_EVENT_CLASS_SET_FIELD_CLASS_STATUS_MEMORY_ERROR	Out of memory.

Precondition: event_class is not NULL.; event_class is not frozen.; field_class is not NULL.; field_class is a structure field class.; field_class, or any of its contained field classes, isn't already part of a stream class or of an event class.; If any of the field classes recursively contained in field_class has a link to another field class, then it must honor the field class link rules.

Postcondition: On success, field_class is frozen.

See also: bt_event_class_borrow_payload_field_class() — Borrows the payload field class of an event class.; bt_event_class_borrow_payload_field_class_const() — Borrows the payload field class of an event class (const version).

◆ bt_event_class_borrow_payload_field_class()

bt_field_class * bt_event_class_borrow_payload_field_class ( bt_event_class * event_class )

extern

Borrows the payload field class from the event class event_class.

See the payload field class property.

If event_class has no payload field class, then this function returns NULL.

Parameters

[in] event_class Event class from which to borrow the payload field class.

Returns: Borrowed reference of the payload field class of event_class, or NULL if none.

Precondition: event_class is not NULL.

See also: bt_event_class_set_payload_field_class() — Sets the payload field class of an event class.; bt_event_class_borrow_payload_field_class_const() — const version of this function.

◆ bt_event_class_borrow_payload_field_class_const()

const bt_field_class * bt_event_class_borrow_payload_field_class_const ( const bt_event_class * event_class )

extern

Borrows the payload field class from the event class event_class (const version).

See bt_event_class_borrow_payload_field_class().

◆ bt_event_class_set_specific_context_field_class()

bt_event_class_set_field_class_status bt_event_class_set_specific_context_field_class	(	bt_event_class *	event_class,
		bt_field_class *	field_class )

extern

Sets the specific context field class of the event class event_class to field_class.

See the specific context field class property.

Parameters

[in]	event_class	Event class of which to set the specific context field class to field_class.
[in]	field_class	New specific context field class of event_class.

Return values

BT_EVENT_CLASS_SET_FIELD_CLASS_STATUS_OK	Success.
BT_EVENT_CLASS_SET_FIELD_CLASS_STATUS_MEMORY_ERROR	Out of memory.

Precondition: event_class is not NULL.; event_class is not frozen.; field_class is not NULL.; field_class is a structure field class.; field_class, or any of its contained field classes, isn't already part of a stream class or of an event class.; If any of the field classes recursively contained in field_class has a link to another field class, then it must honor the field class link rules.

Postcondition: On success, field_class is frozen.

See also: bt_event_class_borrow_specific_context_field_class() — Borrows the specific context field class of an event class.; bt_event_class_borrow_specific_context_field_class_const() — Borrows the specific context field class of an event class (const version).

◆ bt_event_class_borrow_specific_context_field_class()

bt_field_class * bt_event_class_borrow_specific_context_field_class ( bt_event_class * event_class )

extern

Borrows the specific context field class from the event class event_class.

See the specific context field class property.

If event_class has no specific context field class, then this function returns NULL.

Parameters

[in] event_class Event class from which to borrow the specific context field class.

Returns: Borrowed reference of the specific context field class of event_class, or NULL if none.

Precondition: event_class is not NULL.

See also: bt_event_class_set_specific_context_field_class() — Sets the specific context field class of an event class.; bt_event_class_borrow_specific_context_field_class_const() — const version of this function.

◆ bt_event_class_borrow_specific_context_field_class_const()

const bt_field_class * bt_event_class_borrow_specific_context_field_class_const ( const bt_event_class * event_class )

extern

Borrows the specific context field class from the event class event_class (const version).

See bt_event_class_borrow_specific_context_field_class().

◆ bt_event_class_set_user_attributes()

void bt_event_class_set_user_attributes	(	bt_event_class *	event_class,
		const bt_value *	user_attributes )

extern

Sets the user attributes of the event class event_class to user_attributes.

See the user attributes property.

Note: When you create a default event class with bt_event_class_create() or bt_event_class_create_with_id(), the initial user attributes of the event class is an empty map value. Therefore you can borrow it with bt_event_class_borrow_user_attributes() and fill it directly instead of setting a new one with this function.

Parameters

[in]	event_class	Event class of which to set the user attributes to user_attributes.
[in]	user_attributes	New user attributes of event_class.

Precondition: event_class is not NULL.; event_class is not frozen.; user_attributes is not NULL.; user_attributes is a map value (bt_value_is_map() returns BT_TRUE).

See also: bt_event_class_borrow_user_attributes() — Borrows the user attributes of an event class.

◆ bt_event_class_borrow_user_attributes()

bt_value * bt_event_class_borrow_user_attributes ( bt_event_class * event_class )

extern

Borrows the user attributes of the event class event_class.

See the user attributes property.

Note: When you create a default event class with bt_event_class_create() or bt_event_class_create_with_id(), the initial user attributes of the event class is an empty map value.

Parameters

[in] event_class Event class from which to borrow the user attributes.

Returns: User attributes of event_class (a map value).

Precondition: event_class is not NULL.

See also: bt_event_class_set_user_attributes() — Sets the user attributes of an event class.; bt_event_class_borrow_user_attributes_const() — const version of this function.

◆ bt_event_class_borrow_user_attributes_const()

const bt_value * bt_event_class_borrow_user_attributes_const ( const bt_event_class * event_class )

extern

Borrows the user attributes of the event class event_class (const version).

See bt_event_class_borrow_user_attributes().

◆ bt_event_class_get_ref()

void bt_event_class_get_ref ( const bt_event_class * event_class )

extern

Increments the reference count of the event class event_class.

Parameters

[in]

event_class

Event class of which to increment the reference count.

Can be NULL.

See also: bt_event_class_put_ref() — Decrements the reference count of an event class.

◆ bt_event_class_put_ref()

void bt_event_class_put_ref ( const bt_event_class * event_class )

extern

Decrements the reference count of the event class event_class.

Parameters

[in]

event_class

Event class of which to decrement the reference count.

Can be NULL.

See also: bt_event_class_get_ref() — Increments the reference count of an event class.

Detailed Description

Properties

Properties

Type

Creation

Stream class access

Reference count

Typedef Documentation

◆ bt_event_class_set_namespace_status

◆ bt_event_class_set_uid_status

Enumeration Type Documentation

◆ bt_event_class_set_namespace_status

◆ bt_event_class_set_name_status

◆ bt_event_class_set_uid_status

◆ bt_event_class_log_level

◆ bt_event_class_set_emf_uri_status

◆ bt_event_class_set_field_class_status

Macro Definition Documentation

◆ BT_EVENT_CLASS_PUT_REF_AND_RESET

◆ BT_EVENT_CLASS_MOVE_REF

Function Documentation

◆ bt_event_class_create()

◆ bt_event_class_create_with_id()

◆ bt_event_class_borrow_stream_class()

◆ bt_event_class_borrow_stream_class_const()

◆ bt_event_class_get_id()

◆ bt_event_class_set_namespace()

◆ bt_event_class_get_namespace()

◆ bt_event_class_set_name()

◆ bt_event_class_set_uid()

◆ bt_event_class_get_uid()

◆ bt_event_class_get_name()

◆ bt_event_class_set_log_level()

◆ bt_event_class_get_log_level()

◆ bt_event_class_set_emf_uri()

◆ bt_event_class_get_emf_uri()

◆ bt_event_class_set_payload_field_class()

◆ bt_event_class_borrow_payload_field_class()

◆ bt_event_class_borrow_payload_field_class_const()

◆ bt_event_class_set_specific_context_field_class()

◆ bt_event_class_borrow_specific_context_field_class()

◆ bt_event_class_borrow_specific_context_field_class_const()

◆ bt_event_class_set_user_attributes()

◆ bt_event_class_borrow_user_attributes()

◆ bt_event_class_borrow_user_attributes_const()

◆ bt_event_class_get_ref()

◆ bt_event_class_put_ref()