event.h 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. #ifndef BABELTRACE_CTF_WRITER_EVENT_H
  2. #define BABELTRACE_CTF_WRITER_EVENT_H
  3. /*
  4. * BabelTrace - CTF Writer: Event
  5. *
  6. * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  7. *
  8. * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  9. *
  10. * Permission is hereby granted, free of charge, to any person obtaining a copy
  11. * of this software and associated documentation files (the "Software"), to deal
  12. * in the Software without restriction, including without limitation the rights
  13. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  14. * copies of the Software, and to permit persons to whom the Software is
  15. * furnished to do so, subject to the following conditions:
  16. *
  17. * The above copyright notice and this permission notice shall be included in
  18. * all copies or substantial portions of the Software.
  19. *
  20. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  23. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  25. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  26. * SOFTWARE.
  27. *
  28. * The Common Trace Format (CTF) Specification is available at
  29. * http://www.efficios.com/ctf
  30. */
  31. #include <babeltrace/ctf-ir/event-class.h>
  32. #include <babeltrace/ctf-ir/event.h>
  33. #ifdef __cplusplus
  34. extern "C" {
  35. #endif
  36. /*
  37. * bt_ctf_event_get and bt_ctf_event_put: increment and decrement
  38. * the event's reference count.
  39. *
  40. * You may also use bt_ctf_get() and bt_ctf_put() with event objects.
  41. *
  42. * These functions ensure that the event won't be destroyed while it
  43. * is in use. The same number of get and put (plus one extra put to
  44. * release the initial reference done at creation) have to be done to
  45. * destroy an event.
  46. *
  47. * When the event's reference count is decremented to 0 by a
  48. * bt_ctf_event_put, the event is freed.
  49. *
  50. * @param event Event instance.
  51. */
  52. extern void bt_ctf_event_get(struct bt_ctf_event *event);
  53. extern void bt_ctf_event_put(struct bt_ctf_event *event);
  54. /*
  55. * bt_ctf_event_class_get and bt_ctf_event_class_put: increment and decrement
  56. * the event class' reference count.
  57. *
  58. * You may also use bt_ctf_get() and bt_ctf_put() with event class objects.
  59. *
  60. * These functions ensure that the event class won't be destroyed while it
  61. * is in use. The same number of get and put (plus one extra put to
  62. * release the initial reference done at creation) have to be done to
  63. * destroy an event class.
  64. *
  65. * When the event class' reference count is decremented to 0 by a
  66. * bt_ctf_event_class_put, the event class is freed.
  67. *
  68. * @param event_class Event class.
  69. */
  70. extern void bt_ctf_event_class_get(struct bt_ctf_event_class *event_class);
  71. extern void bt_ctf_event_class_put(struct bt_ctf_event_class *event_class);
  72. #ifdef __cplusplus
  73. }
  74. #endif
  75. #endif /* BABELTRACE_CTF_WRITER_EVENT_H */