extern struct bt_ctf_stream_class *bt_ctf_event_class_get_stream_class(
struct bt_ctf_event_class *event_class);
+/*
+ * bt_ctf_event_class_get_payload_type: get an event class' payload.
+ *
+ * Get an event class' payload type.
+ *
+ * @param event_class Event class.
+ *
+ * Returns the event class' payload, NULL on error.
+ */
+extern struct bt_ctf_field_type *bt_ctf_event_class_get_payload_type(
+ struct bt_ctf_event_class *event_class);
+
+/*
+ * bt_ctf_event_class_set_payload_type: set an event class' payload.
+ *
+ * Set an event class' payload type.
+ *
+ * @param event_class Event class.
+ * @param payload The payload's type.
+ *
+ * Returns 0 on success, a negative value on error.
+ */
+extern int bt_ctf_event_class_set_payload_type(
+ struct bt_ctf_event_class *event_class,
+ struct bt_ctf_field_type *payload);
+
/*
* bt_ctf_event_class_add_field: add a field to an event class.
*
* @param name Name of the new field.
*
* Returns 0 on success, a negative value on error.
+ *
+ * Note: Returns an error if the payload is not a structure.
*/
extern int bt_ctf_event_class_add_field(struct bt_ctf_event_class *event_class,
struct bt_ctf_field_type *type,
* @param event_class Event class.
*
* Returns the event class' field count, a negative value on error.
+ *
+ * Note: Returns an error if the payload is not a structure.
*/
extern int bt_ctf_event_class_get_field_count(
struct bt_ctf_event_class *event_class);
* @param index Index of field.
*
* Returns 0 on success, a negative error on value.
+ *
+ * Note: Returns an error if the payload is not a structure.
*/
extern int bt_ctf_event_class_get_field(struct bt_ctf_event_class *event_class,
const char **field_name, struct bt_ctf_field_type **field_type,
* @param name Name of the field.
*
* Returns a field type on success, NULL on error.
+ *
+ * Note: Returns an error if the payload is not a structure.
*/
extern struct bt_ctf_field_type *bt_ctf_event_class_get_field_by_name(
struct bt_ctf_event_class *event_class, const char *name);
+/*
+ * bt_ctf_event_class_get_context_type: Get an event class's context type
+ *
+ * @param event_class Event class.
+ *
+ * Returns a field type (a structure) on success, NULL on error.
+ */
+extern struct bt_ctf_field_type *bt_ctf_event_class_get_context_type(
+ struct bt_ctf_event_class *event_class);
+
+/*
+ * bt_ctf_event_class_set_context_type: Set an event class's context type
+ *
+ * @param event_class Event class.
+ * @param context Event context field type (must be a structure).
+ *
+ * Returns 0 on success, a negative value on error.
+ */
+extern int bt_ctf_event_class_set_context_type(
+ struct bt_ctf_event_class *event_class,
+ struct bt_ctf_field_type *context);
+
/*
* bt_ctf_event_class_get and bt_ctf_event_class_put: increment and decrement
* the event class' reference count.
* sets its reference count to 1. Each instance shares the ownership of the
* event class using its reference count.
*
+ * An event class must be associated with a stream class before events
+ * may be instanciated.
+ *
* @param event_class Event class.
*
* Returns an allocated field type on success, NULL on error.
* returned value.
*
* @param event Event instance.
- * @param name Event field name.
+ * @param name Event field name, see notes.
*
* Returns a field instance on success, NULL on error.
+ *
+ * Note: Passing a name will cause the function to perform a look-up by
+ * name assuming the event's payload is a structure. This will return
+ * the raw payload instance if name is NULL.
*/
extern struct bt_ctf_field *bt_ctf_event_get_payload(struct bt_ctf_event *event,
const char *name);
* bt_ctf_field_put() must be called on the returned value.
*
* @param event Event instance.
- * @param name Event field name.
+ * @param name Event field name, see notes.
* @param value Instance of a field whose type corresponds to the event's field.
*
* Returns 0 on success, a negative value on error.
+ *
+ * Note: The function will return an error if a name is provided and the payload
+ * type is not a structure. If name is NULL, the payload field will be set
+ * directly and must match the event class' payload's type.
*/
extern int bt_ctf_event_set_payload(struct bt_ctf_event *event,
const char *name,
* @param index Index of field.
*
* Returns the event's field, NULL on error.
+ *
+ * Note: Will return an error if the payload's type is not a structure.
*/
extern struct bt_ctf_field *bt_ctf_event_get_payload_by_index(
struct bt_ctf_event *event, int index);
+/*
+ * bt_ctf_event_get_header: get an event's header.
+ *
+ * @param event Event instance.
+ *
+ * Returns a field instance on success, NULL on error.
+ */
+extern struct bt_ctf_field *bt_ctf_event_get_header(
+ struct bt_ctf_event *event);
+
+/*
+ * bt_ctf_event_set_header: set an event's header.
+ *
+ * The event header's type must match the stream class' event
+ * header type.
+ *
+ * @param event Event instance.
+ * @param header Event header field instance.
+ *
+ * Returns a field instance on success, NULL on error.
+ */
+extern int bt_ctf_event_set_header(
+ struct bt_ctf_event *event,
+ struct bt_ctf_field *header);
+
+/*
+ * bt_ctf_event_get_event_context: Get an event's context
+ *
+ * @param event_class Event class.
+ *
+ * Returns a field on success (a structure), NULL on error.
+ *
+ * Note: This function is named this way instead of the expected
+ * "bt_ctf_event_get_context" in order to work around a name clash with
+ * an unrelated function bearing this name in context.h.
+ */
+extern struct bt_ctf_field *bt_ctf_event_get_event_context(
+ struct bt_ctf_event *event);
+
+/*
+ * bt_ctf_event_set_event_context: Set an event's context
+ *
+ * @param event Event.
+ * @param context Event context field (must match the event class'
+ * context type).
+ *
+ * Returns 0 on success, a negative value on error.
+ */
+extern int bt_ctf_event_set_event_context(struct bt_ctf_event *event,
+ struct bt_ctf_field *context);
+
/*
* bt_ctf_event_get and bt_ctf_event_put: increment and decrement
* the event's reference count.
projects / babeltrace.git / blobdiff