-#ifndef BABELTRACE2_GRAPH_MESSAGE_ITERATOR_CLASS_H
-#define BABELTRACE2_GRAPH_MESSAGE_ITERATOR_CLASS_H
-
/*
- * Copyright (c) 2019 EfficiOS Inc.
- *
- * 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.
+ * SPDX-License-Identifier: MIT
*
- * 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_ITERATOR_CLASS_H
+#define BABELTRACE2_GRAPH_MESSAGE_ITERATOR_CLASS_H
+
#ifndef __BT_IN_BABELTRACE_H
# error "Please include <babeltrace2/babeltrace.h> instead."
#endif
extern "C" {
#endif
-
/*!
@defgroup api-msg-iter-cls Message iterator class
@ingroup api-comp-cls-dev
</dt>
<dd>
Called to check whether or not your \bt_msg_iter can currently
- seek a message occuring at or after a specific time given in
+ seek a message occurring at or after a specific time given in
nanoseconds from its
\ref api-tir-clock-cls-origin "clock class origin".
If you don't implement this method, then, if you implement the
\ref api-msg-iter-cls-meth-seek-ns "seek ns from origin" method, the
library assumes that your message iterator can always seek any
- message occuring at or after any time.
+ message occurring at or after any time.
The message iterator of a \bt_flt_comp will typically consider
the time seeking capability of its own upstream message
this method's implementation.
If you need to block the thread to compute whether or not your
- message iterator can seek a message occuring at or after a given
+ message iterator can seek a message occurring at or after a given
time, you can instead report to try again later to the caller by
returning
#BT_MESSAGE_ITERATOR_CLASS_CAN_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_AGAIN.
bt_message_iterator_seek_ns_from_origin() uses this configuration
option and the beginning seeking capability of a message iterator
(bt_message_iterator_can_seek_beginning())
- to make it seek a message occuring at or after a specific time even
+ to make it seek a message occurring at or after a specific time even
when the message iterator does not implement the
\ref api-msg-iter-cls-meth-seek-ns "seek ns from origin" method.
</dt>
<dd>
Called within bt_message_iterator_seek_ns_from_origin() to make
- your message iterator seek a message occuring at or after a specific
+ your message iterator seek a message occurring at or after a specific
time given in nanoseconds from its
\ref api-tir-clock-cls-origin "clock class origin".
later.
If you need to block the thread to make your message iterator seek a
- message occuring at or after a given time, you can instead report to
+ message occurring at or after a given time, you can instead report to
try again later to the caller by returning
#BT_MESSAGE_ITERATOR_CLASS_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_AGAIN.
@param[out] can_seek_ns_from_origin
<strong>On success</strong>, set \bt_p{*can_seek_ns_from_origin} to
#BT_TRUE if \bt_p{self_message_iterator} can currently seek a
- message occuring at or after \bt_p{ns_from_origin} nanoseconds from
+ message occurring at or after \bt_p{ns_from_origin} nanoseconds from
its \ref api-tir-clock-cls-origin "clock class origin".
@retval #BT_MESSAGE_ITERATOR_CLASS_CAN_SEEK_NS_FROM_ORIGIN_METHOD_STATUS_OK