-#ifndef BABELTRACE2_GRAPH_MESSAGE_H
-#define BABELTRACE2_GRAPH_MESSAGE_H
-
/*
- * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
+ * SPDX-License-Identifier: MIT
*
- * 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.
+ * Copyright (C) 2010-2019 EfficiOS Inc. and Linux Foundation
*/
+#ifndef BABELTRACE2_GRAPH_MESSAGE_H
+#define BABELTRACE2_GRAPH_MESSAGE_H
+
+/* IWYU pragma: private, include <babeltrace2/babeltrace.h> */
+
#ifndef __BT_IN_BABELTRACE_H
# error "Please include <babeltrace2/babeltrace.h> instead."
#endif
- The maximum
\ref api-tir-fc-int-prop-size "field value range" for an \bt_uint_fc
- is [0, 2<sup>64</sup> - 1].
+ is [0, 2<sup>64</sup> − 1].
- The available message types are stream beginning and end, event,
packet beginning and end, discarded events and packets, and message
@bt_pre_not_null{message}
*/
-extern bt_message_type bt_message_get_type(const bt_message *message);
+extern bt_message_type bt_message_get_type(const bt_message *message)
+ __BT_NOEXCEPT;
/*! @} */
extern
bt_message *bt_message_stream_beginning_create(
bt_self_message_iterator *self_message_iterator,
- const bt_stream *stream);
+ const bt_stream *stream) __BT_NOEXCEPT;
/*!
@brief
\c const version of this function.
*/
extern bt_stream *bt_message_stream_beginning_borrow_stream(
- bt_message *message);
+ bt_message *message) __BT_NOEXCEPT;
/*!
@brief
See bt_message_stream_beginning_borrow_stream().
*/
extern const bt_stream *bt_message_stream_beginning_borrow_stream_const(
- const bt_message *message);
+ const bt_message *message) __BT_NOEXCEPT;
/*!
@brief
*/
extern
void bt_message_stream_beginning_set_default_clock_snapshot(
- bt_message *message, uint64_t value);
+ bt_message *message, uint64_t value) __BT_NOEXCEPT;
/*!
@brief
extern bt_message_stream_clock_snapshot_state
bt_message_stream_beginning_borrow_default_clock_snapshot_const(
const bt_message *message,
- const bt_clock_snapshot **clock_snapshot);
+ const bt_clock_snapshot **clock_snapshot) __BT_NOEXCEPT;
/*!
@brief
*/
extern const bt_clock_class *
bt_message_stream_beginning_borrow_stream_class_default_clock_class_const(
- const bt_message *message);
+ const bt_message *message) __BT_NOEXCEPT;
/*! @} */
extern
bt_message *bt_message_stream_end_create(
bt_self_message_iterator *self_message_iterator,
- const bt_stream *stream);
+ const bt_stream *stream) __BT_NOEXCEPT;
/*!
@brief
\c const version of this function.
*/
extern bt_stream *bt_message_stream_end_borrow_stream(
- bt_message *message);
+ bt_message *message) __BT_NOEXCEPT;
/*!
@brief
See bt_message_stream_end_borrow_stream().
*/
extern const bt_stream *bt_message_stream_end_borrow_stream_const(
- const bt_message *message);
+ const bt_message *message) __BT_NOEXCEPT;
/*!
@brief
*/
extern
void bt_message_stream_end_set_default_clock_snapshot(
- bt_message *message, uint64_t value);
+ bt_message *message, uint64_t value) __BT_NOEXCEPT;
/*!
@brief
extern bt_message_stream_clock_snapshot_state
bt_message_stream_end_borrow_default_clock_snapshot_const(
const bt_message *message,
- const bt_clock_snapshot **clock_snapshot);
+ const bt_clock_snapshot **clock_snapshot) __BT_NOEXCEPT;
/*!
@brief
*/
extern const bt_clock_class *
bt_message_stream_end_borrow_stream_class_default_clock_class_const(
- const bt_message *message);
+ const bt_message *message) __BT_NOEXCEPT;
/*! @} */
bt_message *bt_message_event_create(
bt_self_message_iterator *self_message_iterator,
const bt_event_class *event_class,
- const bt_stream *stream);
+ const bt_stream *stream) __BT_NOEXCEPT;
/*!
@brief
bt_message *bt_message_event_create_with_default_clock_snapshot(
bt_self_message_iterator *self_message_iterator,
const bt_event_class *event_class,
- const bt_stream *stream, uint64_t clock_snapshot_value);
+ const bt_stream *stream, uint64_t clock_snapshot_value)
+ __BT_NOEXCEPT;
/*!
@brief
bt_message *bt_message_event_create_with_packet(
bt_self_message_iterator *self_message_iterator,
const bt_event_class *event_class,
- const bt_packet *packet);
+ const bt_packet *packet) __BT_NOEXCEPT;
/*!
@brief
bt_message *bt_message_event_create_with_packet_and_default_clock_snapshot(
bt_self_message_iterator *self_message_iterator,
const bt_event_class *event_class,
- const bt_packet *packet, uint64_t clock_snapshot_value);
+ const bt_packet *packet, uint64_t clock_snapshot_value)
+ __BT_NOEXCEPT;
/*!
@brief
@sa bt_message_event_borrow_event_const() —
\c const version of this function.
*/
-extern bt_event *bt_message_event_borrow_event(
- bt_message *message);
+extern bt_event *bt_message_event_borrow_event(bt_message *message)
+ __BT_NOEXCEPT;
/*!
@brief
See bt_message_event_borrow_event().
*/
extern const bt_event *bt_message_event_borrow_event_const(
- const bt_message *message);
+ const bt_message *message) __BT_NOEXCEPT;
/*!
@brief
\ref api-tir-stream-cls-prop-def-clock-cls "default clock class".
*/
extern const bt_clock_snapshot *
-bt_message_event_borrow_default_clock_snapshot_const(const bt_message *message);
+bt_message_event_borrow_default_clock_snapshot_const(const bt_message *message)
+ __BT_NOEXCEPT;
/*!
@brief
*/
extern const bt_clock_class *
bt_message_event_borrow_stream_class_default_clock_class_const(
- const bt_message *message);
+ const bt_message *message) __BT_NOEXCEPT;
/*! @} */
extern
bt_message *bt_message_packet_beginning_create(
bt_self_message_iterator *self_message_iterator,
- const bt_packet *packet);
+ const bt_packet *packet) __BT_NOEXCEPT;
/*!
@brief
extern
bt_message *bt_message_packet_beginning_create_with_default_clock_snapshot(
bt_self_message_iterator *self_message_iterator,
- const bt_packet *packet, uint64_t clock_snapshot_value);
+ const bt_packet *packet, uint64_t clock_snapshot_value)
+ __BT_NOEXCEPT;
/*!
@brief
\c const version of this function.
*/
extern bt_packet *bt_message_packet_beginning_borrow_packet(
- bt_message *message);
+ bt_message *message) __BT_NOEXCEPT;
/*!
@brief
See bt_message_packet_beginning_borrow_packet().
*/
extern const bt_packet *bt_message_packet_beginning_borrow_packet_const(
- const bt_message *message);
+ const bt_message *message) __BT_NOEXCEPT;
/*!
@brief
*/
extern const bt_clock_snapshot *
bt_message_packet_beginning_borrow_default_clock_snapshot_const(
- const bt_message *message);
+ const bt_message *message) __BT_NOEXCEPT;
/*!
@brief
*/
extern const bt_clock_class *
bt_message_packet_beginning_borrow_stream_class_default_clock_class_const(
- const bt_message *message);
+ const bt_message *message) __BT_NOEXCEPT;
/*! @} */
extern
bt_message *bt_message_packet_end_create(
bt_self_message_iterator *self_message_iterator,
- const bt_packet *packet);
+ const bt_packet *packet) __BT_NOEXCEPT;
/*!
@brief
extern
bt_message *bt_message_packet_end_create_with_default_clock_snapshot(
bt_self_message_iterator *self_message_iterator,
- const bt_packet *packet, uint64_t clock_snapshot_value);
+ const bt_packet *packet, uint64_t clock_snapshot_value)
+ __BT_NOEXCEPT;
/*!
@brief
\c const version of this function.
*/
extern bt_packet *bt_message_packet_end_borrow_packet(
- bt_message *message);
+ bt_message *message) __BT_NOEXCEPT;
/*!
@brief
See bt_message_packet_end_borrow_packet().
*/
extern const bt_packet *bt_message_packet_end_borrow_packet_const(
- const bt_message *message);
+ const bt_message *message) __BT_NOEXCEPT;
/*!
@brief
*/
extern const bt_clock_snapshot *
bt_message_packet_end_borrow_default_clock_snapshot_const(
- const bt_message *message);
+ const bt_message *message) __BT_NOEXCEPT;
/*!
@brief
*/
extern const bt_clock_class *
bt_message_packet_end_borrow_stream_class_default_clock_class_const(
- const bt_message *message);
+ const bt_message *message) __BT_NOEXCEPT;
/*! @} */
*/
extern bt_message *bt_message_discarded_events_create(
bt_self_message_iterator *self_message_iterator,
- const bt_stream *stream);
+ const bt_stream *stream) __BT_NOEXCEPT;
/*!
@brief
@pre
<code>bt_stream_class_discarded_events_have_default_clock_snapshots(bt_stream_borrow_class_const(stream))</code>
returns #BT_TRUE.
+ \bt_p{beginning_clock_snapshot_value} ⩽ \bt_p{end_clock_snapshot_value}
@bt_post_success_frozen{stream}
*/
bt_self_message_iterator *self_message_iterator,
const bt_stream *stream,
uint64_t beginning_clock_snapshot_value,
- uint64_t end_clock_snapshot_value);
+ uint64_t end_clock_snapshot_value)
+ __BT_NOEXCEPT;
/*!
@brief
\c const version of this function.
*/
extern bt_stream *bt_message_discarded_events_borrow_stream(
- bt_message *message);
+ bt_message *message) __BT_NOEXCEPT;
/*!
@brief
See bt_message_discarded_events_borrow_stream().
*/
extern const bt_stream *
-bt_message_discarded_events_borrow_stream_const(const bt_message *message);
+bt_message_discarded_events_borrow_stream_const(const bt_message *message)
+ __BT_NOEXCEPT;
/*!
@brief
*/
extern const bt_clock_snapshot *
bt_message_discarded_events_borrow_beginning_default_clock_snapshot_const(
- const bt_message *message);
+ const bt_message *message) __BT_NOEXCEPT;
/*!
@brief
*/
extern const bt_clock_snapshot *
bt_message_discarded_events_borrow_end_default_clock_snapshot_const(
- const bt_message *message);
+ const bt_message *message) __BT_NOEXCEPT;
/*!
@brief
*/
extern const bt_clock_class *
bt_message_discarded_events_borrow_stream_class_default_clock_class_const(
- const bt_message *message);
+ const bt_message *message) __BT_NOEXCEPT;
/*!
@brief
@bt_pre_not_null{message}
@bt_pre_hot{message}
@bt_pre_is_disc_ev_msg{message}
+@pre
+ \bt_p{count} > 0
@sa bt_message_discarded_events_get_count() —
Returns the number of discarded events of a discarded events
message.
*/
extern void bt_message_discarded_events_set_count(bt_message *message,
- uint64_t count);
+ uint64_t count) __BT_NOEXCEPT;
/*!
@brief
Sets the number of discarded events of a discarded events message.
*/
extern bt_property_availability bt_message_discarded_events_get_count(
- const bt_message *message, uint64_t *count);
+ const bt_message *message, uint64_t *count) __BT_NOEXCEPT;
/*! @} */
*/
extern bt_message *bt_message_discarded_packets_create(
bt_self_message_iterator *self_message_iterator,
- const bt_stream *stream);
+ const bt_stream *stream) __BT_NOEXCEPT;
/*!
@brief
@pre
<code>bt_stream_class_discarded_packets_have_default_clock_snapshots(bt_stream_borrow_class_const(stream))</code>
returns #BT_TRUE.
+ \bt_p{beginning_clock_snapshot_value} ⩽ \bt_p{end_clock_snapshot_value}
@bt_post_success_frozen{stream}
*/
extern bt_message *bt_message_discarded_packets_create_with_default_clock_snapshots(
bt_self_message_iterator *self_message_iterator,
const bt_stream *stream, uint64_t beginning_clock_snapshot_value,
- uint64_t end_clock_snapshot_value);
+ uint64_t end_clock_snapshot_value) __BT_NOEXCEPT;
/*!
@brief
\c const version of this function.
*/
extern bt_stream *bt_message_discarded_packets_borrow_stream(
- bt_message *message);
+ bt_message *message) __BT_NOEXCEPT;
/*!
@brief
See bt_message_discarded_packets_borrow_stream().
*/
extern const bt_stream *
-bt_message_discarded_packets_borrow_stream_const(const bt_message *message);
+bt_message_discarded_packets_borrow_stream_const(const bt_message *message)
+ __BT_NOEXCEPT;
/*!
@brief
*/
extern const bt_clock_snapshot *
bt_message_discarded_packets_borrow_beginning_default_clock_snapshot_const(
- const bt_message *message);
+ const bt_message *message) __BT_NOEXCEPT;
/*!
@brief
*/
extern const bt_clock_snapshot *
bt_message_discarded_packets_borrow_end_default_clock_snapshot_const(
- const bt_message *message);
+ const bt_message *message) __BT_NOEXCEPT;
/*!
@brief
*/
extern const bt_clock_class *
bt_message_discarded_packets_borrow_stream_class_default_clock_class_const(
- const bt_message *message);
+ const bt_message *message) __BT_NOEXCEPT;
/*!
@brief
@bt_pre_not_null{message}
@bt_pre_hot{message}
@bt_pre_is_disc_pkt_msg{message}
+@pre
+ \bt_p{count} > 0
@sa bt_message_discarded_packets_get_count() —
Returns the number of discarded packets of a discarded packets
message.
*/
extern void bt_message_discarded_packets_set_count(bt_message *message,
- uint64_t count);
+ uint64_t count) __BT_NOEXCEPT;
/*!
@brief
Sets the number of discarded packets of a discarded packets message.
*/
extern bt_property_availability bt_message_discarded_packets_get_count(
- const bt_message *message, uint64_t *count);
+ const bt_message *message, uint64_t *count) __BT_NOEXCEPT;
/*! @} */
bt_message *bt_message_message_iterator_inactivity_create(
bt_self_message_iterator *self_message_iterator,
const bt_clock_class *clock_class,
- uint64_t clock_snapshot_value);
+ uint64_t clock_snapshot_value) __BT_NOEXCEPT;
/*!
@brief
*/
extern const bt_clock_snapshot *
bt_message_message_iterator_inactivity_borrow_clock_snapshot_const(
- const bt_message *message);
+ const bt_message *message) __BT_NOEXCEPT;
/*! @} */
@sa bt_message_put_ref() —
Decrements the reference count of a message.
*/
-extern void bt_message_get_ref(const bt_message *message);
+extern void bt_message_get_ref(const bt_message *message) __BT_NOEXCEPT;
/*!
@brief
@sa bt_message_get_ref() —
Increments the reference count of a message.
*/
-extern void bt_message_put_ref(const bt_message *message);
+extern void bt_message_put_ref(const bt_message *message) __BT_NOEXCEPT;
/*!
@brief
/*! @} */
-
/*!
@name Message Interchange Protocol version
@{
extern bt_get_greatest_operative_mip_version_status
bt_get_greatest_operative_mip_version(
const bt_component_descriptor_set *component_descriptors,
- bt_logging_level logging_level, uint64_t *mip_version);
+ bt_logging_level logging_level, uint64_t *mip_version)
+ __BT_NOEXCEPT;
/*!
@brief
@returns
Maximal available MIP version (\bt_max_mip_version).
*/
-extern uint64_t bt_get_maximal_mip_version(void);
+extern uint64_t bt_get_maximal_mip_version(void) __BT_NOEXCEPT;
/*! @} */
projects / babeltrace.git / blobdiff