Add missing permission notice in each source file
[babeltrace.git] / include / babeltrace / ctf / callbacks.h
index c0986f9eef58a71c27fe881cd06fbe8f7f547beb..c178767ced7d00ea7ed412522eed09c7803ed441 100644 (file)
  *
  * 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.
  */
 
 #include <babeltrace/format.h>
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 /* Forward declarations */
 struct bt_ctf_iter;
 struct bt_dependencies;
@@ -43,12 +55,12 @@ struct bt_dependencies *babeltrace_dependencies_create(const char *first, ...);
 
 /*
  * struct bt_dependencies must be destroyed explicitly if not passed as
- * parameter to a bt_iter_add_callback().
+ * parameter to a bt_ctf_iter_add_callback().
  */
 void babeltrace_dependencies_destroy(struct bt_dependencies *dep);
 
 /*
- * bt_iter_add_callback: Add a callback to iterator.
+ * bt_ctf_iter_add_callback: Add a callback to iterator.
  *
  * @iter: trace collection iterator (input)
  * @event: event to target. 0 for all events.
@@ -58,13 +70,13 @@ void babeltrace_dependencies_destroy(struct bt_dependencies *dep);
  *            
  * @callback: function pointer to call
  * @depends: struct bt_dependency detailing the required computation results.
- *           Ends with 0.
+ *           Ends with 0. NULL is accepted as empty dependency.
  * @weak_depends: struct bt_dependency detailing the optional computation
  *                results that can be optionally consumed by this
- *                callback.
+ *                callback. NULL is accepted as empty dependency.
  * @provides: struct bt_dependency detailing the computation results
  *            provided by this callback.
- *            Ends with 0.
+ *            Ends with 0. NULL is accepted as empty dependency.
  *
  * "depends", "weak_depends" and "provides" memory is handled by the
  * babeltrace library after this call succeeds or fails. These objects
@@ -72,14 +84,14 @@ void babeltrace_dependencies_destroy(struct bt_dependencies *dep);
  * destroyed, but they belong to the babeltrace library.
  *
  * (note to implementor: we need to keep a gptrarray of struct
- * bt_dependencies to "garbage collect" in struct bt_iter, and
+ * bt_dependencies to "garbage collect" in struct bt_ctf_iter, and
  * dependencies need to have a refcount to handle the case where they
  * would be passed to more than one iterator. Upon iterator detroy, we
  * iterate on all the gc ptrarray and decrement the refcounts, freeing
  * if we reach 0.)
  * (note to implementor: we calculate the dependency graph when
- * bt_iter_read_event() is executed after a
- * bt_iter_add_callback(). Beware that it is valid to create/add
+ * bt_ctf_iter_read_event() is executed after a
+ * bt_ctf_iter_add_callback(). Beware that it is valid to create/add
  * callbacks/read/add more callbacks/read some more.)
  */
 int bt_ctf_iter_add_callback(struct bt_ctf_iter *iter,
@@ -97,4 +109,8 @@ enum {
        BT_FLAGS_FREE_PRIVATE_DATA      = (1 << 0),
 };
 
+#ifdef __cplusplus
+}
+#endif
+
 #endif /*_BABELTRACE_CTF_CALLBACKS_H */
This page took 0.023771 seconds and 4 git commands to generate.