2 * Copyright (C) 2014 David Goulet <dgoulet@efficios.com>
4 * SPDX-License-Identifier: LGPL-2.1-only
11 #include <lttng/domain.h>
12 #include <lttng/lttng-export.h>
19 @addtogroup api_session
24 * Handle used as a context for commands.
26 * The structures should be initialized to zero before use.
28 #define LTTNG_HANDLE_PADDING1 16
32 Recording session handle.
34 Such a structure is a pair of a \ref api_session "recording session"
35 name and a \ref api-channel-domain "tracing domain" summary.
37 Some functions which accept a recording session handle parameter ignore
38 the recording session name or the tracing domain summary.
40 Create a recording session handle with lttng_create_handle().
42 Destroy a recording session handle with lttng_destroy_handle().
45 /// \ref api_session "Recording session" name.
46 char session_name
[LTTNG_NAME_MAX
];
48 /// \ref api-channel-domain "Tracing domain" summary.
49 struct lttng_domain domain
;
51 char padding
[LTTNG_HANDLE_PADDING1
];
56 Creates and returns a recording session handle from the
57 \ref api_session "recording session" name
58 \lt_p{session_name} and the optional
59 \ref api-channel-domain "tracing domain" summary \lt_p{domain}.
61 @param[in] session_name
63 Recording session name part of the recording session handle to
70 Tracing domain summary part of the recording session handle to
78 New recording session handle.
80 Destroy the returned handle with lttng_destroy_handle().
83 @sa lttng_destroy_handle() --
84 Destroys a recording session handle.
86 LTTNG_EXPORT
extern struct lttng_handle
*lttng_create_handle(const char *session_name
,
87 struct lttng_domain
*domain
);
91 Destroys the recording session handle \lt_p{handle}.
95 This function doesn't destroy the recording session named
96 \lt_p{handle->session_name}, but only the handle itself.
98 Use lttng_destroy_session_ext() to destroy a recording session.
103 Recording session handle to destroy.
108 LTTNG_EXPORT
extern void lttng_destroy_handle(struct lttng_handle
*handle
);
116 #endif /* LTTNG_HANDLE_H */
This page took 0.032392 seconds and 5 git commands to generate.