message-iterator.h

#ifndef BABELTRACE2_GRAPH_MESSAGE_ITERATOR_H
#define BABELTRACE2_GRAPH_MESSAGE_ITERATOR_H
 
/*
 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
 
#ifndef __BT_IN_BABELTRACE_H
# error "Please include <babeltrace2/babeltrace.h> instead."
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum bt_message_iterator_create_from_message_iterator_status {
    BT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_OK      = __BT_FUNC_STATUS_OK,
 
    BT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_MEMORY_ERROR    = __BT_FUNC_STATUS_MEMORY_ERROR,
 
    BT_MESSAGE_ITERATOR_CREATE_FROM_MESSAGE_ITERATOR_STATUS_ERROR       = __BT_FUNC_STATUS_ERROR,
} bt_message_iterator_create_from_message_iterator_status;
 
extern bt_message_iterator_create_from_message_iterator_status
bt_message_iterator_create_from_message_iterator(
        bt_self_message_iterator *self_message_iterator,
        bt_self_component_port_input *port,
        bt_message_iterator **message_iterator);
 
typedef enum bt_message_iterator_create_from_sink_component_status {
    BT_MESSAGE_ITERATOR_CREATE_FROM_SINK_COMPONENT_STATUS_OK        = __BT_FUNC_STATUS_OK,
 
    BT_MESSAGE_ITERATOR_CREATE_FROM_SINK_COMPONENT_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
 
    BT_MESSAGE_ITERATOR_CREATE_FROM_SINK_COMPONENT_STATUS_ERROR     = __BT_FUNC_STATUS_ERROR,
} bt_message_iterator_create_from_sink_component_status;
 
extern bt_message_iterator_create_from_sink_component_status
bt_message_iterator_create_from_sink_component(
        bt_self_component_sink *self_component_sink,
        bt_self_component_port_input *port,
        bt_message_iterator **message_iterator);
 
extern bt_component *
bt_message_iterator_borrow_component(
        bt_message_iterator *message_iterator);
 
typedef enum bt_message_iterator_next_status {
    BT_MESSAGE_ITERATOR_NEXT_STATUS_OK      = __BT_FUNC_STATUS_OK,
 
    BT_MESSAGE_ITERATOR_NEXT_STATUS_END     = __BT_FUNC_STATUS_END,
 
    BT_MESSAGE_ITERATOR_NEXT_STATUS_AGAIN       = __BT_FUNC_STATUS_AGAIN,
 
    BT_MESSAGE_ITERATOR_NEXT_STATUS_MEMORY_ERROR    = __BT_FUNC_STATUS_MEMORY_ERROR,
 
    BT_MESSAGE_ITERATOR_NEXT_STATUS_ERROR       = __BT_FUNC_STATUS_ERROR,
} bt_message_iterator_next_status;
 
extern bt_message_iterator_next_status
bt_message_iterator_next(bt_message_iterator *message_iterator,
        bt_message_array_const *messages, uint64_t *count);
 
typedef enum bt_message_iterator_can_seek_beginning_status {
    BT_MESSAGE_ITERATOR_CAN_SEEK_BEGINNING_STATUS_OK        = __BT_FUNC_STATUS_OK,
 
    BT_MESSAGE_ITERATOR_CAN_SEEK_BEGINNING_STATUS_AGAIN     = __BT_FUNC_STATUS_AGAIN,
 
    BT_MESSAGE_ITERATOR_CAN_SEEK_BEGINNING_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
 
    BT_MESSAGE_ITERATOR_CAN_SEEK_BEGINNING_STATUS_ERROR     = __BT_FUNC_STATUS_ERROR,
} bt_message_iterator_can_seek_beginning_status;
 
extern bt_message_iterator_can_seek_beginning_status
bt_message_iterator_can_seek_beginning(
        bt_message_iterator *message_iterator,
        bt_bool *can_seek_beginning);
 
typedef enum bt_message_iterator_seek_beginning_status {
    BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_OK        = __BT_FUNC_STATUS_OK,
 
    BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_AGAIN     = __BT_FUNC_STATUS_AGAIN,
 
    BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
 
    BT_MESSAGE_ITERATOR_SEEK_BEGINNING_STATUS_ERROR     = __BT_FUNC_STATUS_ERROR,
} bt_message_iterator_seek_beginning_status;
 
extern bt_message_iterator_seek_beginning_status
bt_message_iterator_seek_beginning(
        bt_message_iterator *message_iterator);
 
typedef enum bt_message_iterator_can_seek_ns_from_origin_status {
    BT_MESSAGE_ITERATOR_CAN_SEEK_NS_FROM_ORIGIN_STATUS_OK       = __BT_FUNC_STATUS_OK,
 
    BT_MESSAGE_ITERATOR_CAN_SEEK_NS_FROM_ORIGIN_STATUS_AGAIN    = __BT_FUNC_STATUS_AGAIN,
 
    BT_MESSAGE_ITERATOR_CAN_SEEK_NS_FROM_ORIGIN_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
 
    BT_MESSAGE_ITERATOR_CAN_SEEK_NS_FROM_ORIGIN_STATUS_ERROR    = __BT_FUNC_STATUS_ERROR,
} bt_message_iterator_can_seek_ns_from_origin_status;
 
extern bt_message_iterator_can_seek_ns_from_origin_status
bt_message_iterator_can_seek_ns_from_origin(
        bt_message_iterator *message_iterator,
        int64_t ns_from_origin, bt_bool *can_seek_ns_from_origin);
 
typedef enum bt_message_iterator_seek_ns_from_origin_status {
    BT_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_STATUS_OK       = __BT_FUNC_STATUS_OK,
 
    BT_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_STATUS_AGAIN        = __BT_FUNC_STATUS_AGAIN,
 
    BT_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
 
    BT_MESSAGE_ITERATOR_SEEK_NS_FROM_ORIGIN_STATUS_ERROR        = __BT_FUNC_STATUS_ERROR,
} bt_message_iterator_seek_ns_from_origin_status;
 
extern bt_message_iterator_seek_ns_from_origin_status
bt_message_iterator_seek_ns_from_origin(
        bt_message_iterator *message_iterator,
        int64_t ns_from_origin);
 
extern bt_bool
bt_message_iterator_can_seek_forward(
        bt_message_iterator *message_iterator);
 
extern void bt_message_iterator_get_ref(
        const bt_message_iterator *message_iterator);
 
extern void bt_message_iterator_put_ref(
        const bt_message_iterator *message_iterator);
 
#define BT_MESSAGE_ITERATOR_PUT_REF_AND_RESET(_message_iterator)    \
    do {                                \
        bt_message_iterator_put_ref(_message_iterator);     \
        (_message_iterator) = NULL;             \
    } while (0)
 
#define BT_MESSAGE_ITERATOR_MOVE_REF(_dst, _src)    \
    do {                        \
        bt_message_iterator_put_ref(_dst);  \
        (_dst) = (_src);            \
        (_src) = NULL;              \
    } while (0)
 
#ifdef __cplusplus
}
#endif
 
#endif /* BABELTRACE2_GRAPH_MESSAGE_ITERATOR_H */