include/babeltrace2/graph/message-const.h

   1 #ifndef BABELTRACE2_GRAPH_MESSAGE_CONST_H
   2 #define BABELTRACE2_GRAPH_MESSAGE_CONST_H
   3
   4 /*
   5  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   6  * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a copy
   9  * of this software and associated documentation files (the "Software"), to deal
  10  * in the Software without restriction, including without limitation the rights
  11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12  * copies of the Software, and to permit persons to whom the Software is
  13  * furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  24  * SOFTWARE.
  25  */
  26
  27 #ifndef __BT_IN_BABELTRACE_H
  28 # error "Please include <babeltrace2/babeltrace.h> instead."
  29 #endif
  30
  31 /* For bt_message */
  32 #include <babeltrace2/types.h>
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 /**
  39  * Message types. Unhandled message types should be ignored.
  40  */
  41 typedef enum bt_message_type {
  42         BT_MESSAGE_TYPE_EVENT = 0,
  43         BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY = 1,
  44         BT_MESSAGE_TYPE_STREAM_BEGINNING = 2,
  45         BT_MESSAGE_TYPE_STREAM_END = 3,
  46         BT_MESSAGE_TYPE_PACKET_BEGINNING = 4,
  47         BT_MESSAGE_TYPE_PACKET_END = 5,
  48         BT_MESSAGE_TYPE_DISCARDED_EVENTS = 6,
  49         BT_MESSAGE_TYPE_DISCARDED_PACKETS = 7,
  50 } bt_message_type;
  51
  52 /**
  53  * Get a message's type.
  54  *
  55  * @param message       Message instance
  56  * @returns             One of #bt_message_type
  57  */
  58 extern bt_message_type bt_message_get_type(const bt_message *message);
  59
  60 extern void bt_message_get_ref(const bt_message *message);
  61
  62 extern void bt_message_put_ref(const bt_message *message);
  63
  64 #define BT_MESSAGE_PUT_REF_AND_RESET(_var)              \
  65         do {                                            \
  66                 bt_message_put_ref(_var);               \
  67                 (_var) = NULL;                          \
  68         } while (0)
  69
  70 #define BT_MESSAGE_MOVE_REF(_var_dst, _var_src) \
  71         do {                                            \
  72                 bt_message_put_ref(_var_dst);   \
  73                 (_var_dst) = (_var_src);                \
  74                 (_var_src) = NULL;                      \
  75         } while (0)
  76
  77 #ifdef __cplusplus
  78 }
  79 #endif
  80
  81 #endif /* BABELTRACE2_GRAPH_MESSAGE_CONST_H */