Babeltrace 2 C API 2.1.2
Open-source trace manipulation framework
Loading...
Searching...
No Matches
Self message iterator
Graph » Component class development » Message iterator class

Detailed Description

Private view of a message iterator for methods.

The bt_self_message_iterator type is a private view of a message iterator from within a message iterator class method.

Borrow the component which provides a message iterator with bt_self_message_iterator_borrow_component().

Borrow the output port on which a message iterator operates with bt_self_message_iterator_borrow_port().

Set and get user data attached to a message iterator with bt_self_message_iterator_set_data() and bt_self_message_iterator_get_data().

Check whether or not a message iterator is interrupted with bt_self_message_iterator_is_interrupted().

Set whether or not a message iterator can seek forward with bt_self_message_iterator_configuration_set_can_seek_forward().

Component access

bt_self_component * bt_self_message_iterator_borrow_component (bt_self_message_iterator *self_message_iterator)
 Borrows the component which provides the message iterator self_message_iterator.
 

Output port access

bt_self_component_port_output * bt_self_message_iterator_borrow_port (bt_self_message_iterator *self_message_iterator)
 Borrows the output port on which the message iterator self_message_iterator operates.
 

User data

void bt_self_message_iterator_set_data (bt_self_message_iterator *self_message_iterator, void *user_data)
 Sets the user data of the message iterator self_message_iterator to data.
 
void * bt_self_message_iterator_get_data (const bt_self_message_iterator *self_message_iterator)
 Returns the user data of the message iterator self_message_iterator.
 

Interruption query

bt_bool bt_self_message_iterator_is_interrupted (const bt_self_message_iterator *self_message_iterator)
 Returns whether or not the message iterator self_message_iterator is interrupted, that is, whether or not any of its interrupters is set.
 

Configuration

void bt_self_message_iterator_configuration_set_can_seek_forward (bt_self_message_iterator_configuration *configuration, bt_bool can_seek_forward)
 Sets whether or not the message iterator of which the configuration is configuration can seek forward.
 

Effective Message Interchange Protocol (MIP) version access

uint64_t bt_self_message_iterator_get_graph_mip_version (const bt_self_message_iterator *self_message_iterator)
 Returns the effective Message Interchange Protocol (MIP) version of the trace processing graph which contains the message iterator self_message_iterator.
 

Function Documentation

◆ bt_self_message_iterator_borrow_component()

bt_self_component * bt_self_message_iterator_borrow_component ( bt_self_message_iterator *  self_message_iterator)
extern

Borrows the component which provides the message iterator self_message_iterator.

Parameters
[in]self_message_iteratorMessage iterator instance.
Returns
Component which provides self_message_iterator.
Precondition
self_message_iterator is not NULL.

◆ bt_self_message_iterator_borrow_port()

bt_self_component_port_output * bt_self_message_iterator_borrow_port ( bt_self_message_iterator *  self_message_iterator)
extern

Borrows the output port on which the message iterator self_message_iterator operates.

Parameters
[in]self_message_iteratorMessage iterator instance.
Returns
Output port on which self_message_iterator operates.
Precondition
self_message_iterator is not NULL.

◆ bt_self_message_iterator_set_data()

void bt_self_message_iterator_set_data ( bt_self_message_iterator *  self_message_iterator,
void *  user_data 
)
extern

Sets the user data of the message iterator self_message_iterator to data.

Parameters
[in]self_message_iteratorMessage iterator instance.
[in]user_dataNew user data of self_message_iterator.
Precondition
self_message_iterator is not NULL.
See also
bt_self_message_iterator_get_data() — Returns the user data of a message iterator.

◆ bt_self_message_iterator_get_data()

void * bt_self_message_iterator_get_data ( const bt_self_message_iterator *  self_message_iterator)
extern

Returns the user data of the message iterator self_message_iterator.

Parameters
[in]self_message_iteratorMessage iterator instance.
Returns
User data of self_message_iterator.
Precondition
self_message_iterator is not NULL.
See also
bt_self_message_iterator_set_data() — Sets the user data of a message iterator.

◆ bt_self_message_iterator_is_interrupted()

bt_bool bt_self_message_iterator_is_interrupted ( const bt_self_message_iterator *  self_message_iterator)
extern

Returns whether or not the message iterator self_message_iterator is interrupted, that is, whether or not any of its interrupters is set.

Parameters
[in]self_message_iteratorMessage iterator instance.
Returns
BT_TRUE if self_message_iterator is interrupted (any of its interrupters is set).
Precondition
self_message_iterator is not NULL.
See also
bt_graph_borrow_default_interrupter() — Borrows the default interrupter of a trace processing graph.
bt_graph_add_interrupter() — Adds an interrupter to a graph.

◆ bt_self_message_iterator_configuration_set_can_seek_forward()

void bt_self_message_iterator_configuration_set_can_seek_forward ( bt_self_message_iterator_configuration *  configuration,
bt_bool  can_seek_forward 
)
extern

Sets whether or not the message iterator of which the configuration is configuration can seek forward.

A message iterator can seek forward if all the messages of its message sequence have some clock snapshot.

Attention
You may only call this function during the execution of the initialization method of a message iterator.
Parameters
[in]configurationConfiguration of the message iterator of which to set whether or not it can seek forward.
[in]can_seek_forwardBT_TRUE to make the message iterator of which the configuration is configuration forward-seekable.
Precondition
configuration is not NULL.
See also
bt_message_iterator_can_seek_forward() — Returns whether or not a message iterator can seek forward.

◆ bt_self_message_iterator_get_graph_mip_version()

uint64_t bt_self_message_iterator_get_graph_mip_version ( const bt_self_message_iterator *  self_message_iterator)
extern

Returns the effective Message Interchange Protocol (MIP) version of the trace processing graph which contains the message iterator self_message_iterator.

Parameters
[in]self_message_iteratorMessage iterator instance.
Returns
Effective MIP version of the trace processing graph which contains self_message_iterator.
Since
Babeltrace 2.1
Precondition
self_message_iterator is not NULL.