include/babeltrace2/trace-ir/packet.h

   1 #ifndef BABELTRACE2_TRACE_IR_PACKET_H
   2 #define BABELTRACE2_TRACE_IR_PACKET_H
   3
   4 /*
   5  * Copyright 2016-2018 Philippe Proulx <pproulx@efficios.com>
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  *
  25  * The Common Trace Format (CTF) Specification is available at
  26  * http://www.efficios.com/ctf
  27  */
  28
  29 #ifndef __BT_IN_BABELTRACE_H
  30 # error "Please include <babeltrace2/babeltrace.h> instead."
  31 #endif
  32
  33 #include <stdint.h>
  34
  35 /* For bt_packet, bt_packet_context_field, bt_stream */
  36 #include <babeltrace2/types.h>
  37
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 extern bt_packet *bt_packet_create(const bt_stream *stream);
  43
  44 extern bt_stream *bt_packet_borrow_stream(bt_packet *packet);
  45
  46 extern
  47 bt_field *bt_packet_borrow_context_field(bt_packet *packet);
  48
  49 typedef enum bt_packet_move_context_field_status {
  50         BT_PACKET_MOVE_CONTEXT_FIELD_STATUS_OK  = __BT_FUNC_STATUS_OK,
  51 } bt_packet_move_context_field_status;
  52
  53 extern
  54 bt_packet_move_context_field_status bt_packet_move_context_field(
  55                 bt_packet *packet, bt_packet_context_field *context);
  56
  57 #ifdef __cplusplus
  58 }
  59 #endif
  60
  61 #endif /* BABELTRACE2_TRACE_IR_PACKET_H */