Jack2: session.h Source File

Jack2 1.9.21

session.h
1/*
2 Copyright (C) 2001 Paul Davis
3 Copyright (C) 2004 Jack O'Quin
4 Copyright (C) 2010 Torben Hohn
5
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
10
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU Lesser General Public License for more details.
15
16 You should have received a copy of the GNU Lesser General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19*/
20
21#ifndef __jack_session_h__
22#define __jack_session_h__
23
24#ifdef __cplusplus
25extern "C" {
26#endif
27
28#include <jack/types.h>
29#include <jack/weakmacros.h>
30
50 enum JackSessionEventType {
61 JackSessionSave = 1,
62
68 JackSessionSaveAndQuit = 2,
69
79 JackSessionSaveTemplate = 3
80};
81
82typedef enum JackSessionEventType jack_session_event_type_t;
83
87 enum JackSessionFlags {
91 JackSessionSaveError = 0x01,
92
96 JackSessionNeedTerminal = 0x02
97};
98
102 typedef enum JackSessionFlags jack_session_flags_t;
103
104 struct _jack_session_event {
108 jack_session_event_type_t type;
109
116 const char *session_dir;
117
124 const char *client_uuid;
125
139 char *command_line;
140
144 jack_session_flags_t flags;
145
149 uint32_t future;
150};
151
152typedef struct _jack_session_event jack_session_event_t;
153
170 typedef void (*JackSessionCallback)(jack_session_event_t *event,
171 void *arg);
172
187 int jack_set_session_callback (jack_client_t *client,
188 JackSessionCallback session_callback,
189 void *arg) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
190
204 int jack_session_reply (jack_client_t *client,
205 jack_session_event_t *event) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
206
207
217 void jack_session_event_free (jack_session_event_t *event) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
218
219
227 char *jack_client_get_uuid (jack_client_t *client) JACK_WEAK_EXPORT;
228
239 typedef struct {
240 const char *uuid;
241 const char *client_name;
242 const char *command;
243 jack_session_flags_t flags;
244} jack_session_command_t;
245
253 jack_session_command_t *jack_session_notify (
254 jack_client_t* client,
255 const char *target,
256 jack_session_event_type_t type,
257 const char *path) JACK_WEAK_EXPORT;
258
266 void jack_session_commands_free (jack_session_command_t *cmds) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
267
277int
278jack_reserve_client_name (jack_client_t *client,
279 const char *name,
280 const char *uuid) JACK_WEAK_EXPORT;
281
292int
293jack_client_has_session_callback (jack_client_t *client, const char *client_name) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
294
299#ifdef __cplusplus
300}
301#endif
302#endif
jack_reserve_client_name
int jack_reserve_client_name(jack_client_t *client, const char *name, const char *uuid) JACK_WEAK_EXPORT
jack_session_notify
jack_session_command_t * jack_session_notify(jack_client_t *client, const char *target, jack_session_event_type_t type, const char *path) JACK_WEAK_EXPORT
jack_session_commands_free
void jack_session_commands_free(jack_session_command_t *cmds) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT
jack_client_has_session_callback
int jack_client_has_session_callback(jack_client_t *client, const char *client_name) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT
jack_set_session_callback
int jack_set_session_callback(jack_client_t *client, JackSessionCallback session_callback, void *arg) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT
jack_session_reply
int jack_session_reply(jack_client_t *client, jack_session_event_t *event) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT
JackSessionCallback
void(* JackSessionCallback)(jack_session_event_t *event, void *arg)
Definition: session.h:170
JackSessionEventType
JackSessionEventType
Definition: session.h:50
JackSessionFlags
JackSessionFlags
Definition: session.h:87
jack_client_get_uuid
char * jack_client_get_uuid(jack_client_t *client) JACK_WEAK_EXPORT
jack_session_event_free
void jack_session_event_free(jack_session_event_t *event) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT
jack_session_flags_t
enum JackSessionFlags jack_session_flags_t
Definition: session.h:102
JackSessionSave
@ JackSessionSave
Definition: session.h:61
JackSessionSaveAndQuit
@ JackSessionSaveAndQuit
Definition: session.h:68
JackSessionSaveTemplate
@ JackSessionSaveTemplate
Definition: session.h:79
JackSessionNeedTerminal
@ JackSessionNeedTerminal
Definition: session.h:96
JackSessionSaveError
@ JackSessionSaveError
Definition: session.h:91
_jack_session_event
Definition: session.h:104
_jack_session_event::type
jack_session_event_type_t type
Definition: session.h:108
_jack_session_event::future
uint32_t future
Definition: session.h:149
_jack_session_event::client_uuid
const char * client_uuid
Definition: session.h:124
_jack_session_event::session_dir
const char * session_dir
Definition: session.h:116
_jack_session_event::flags
jack_session_flags_t flags
Definition: session.h:144
_jack_session_event::command_line
char * command_line
Definition: session.h:139
jack_session_command_t
Definition: session.h:239