session.h

Go to the documentation of this file.

/*
    Copyright (C) 2001 Paul Davis
    Copyright (C) 2004 Jack O'Quin
    Copyright (C) 2010 Torben Hohn
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation; either version 2.1 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.
 
    You should have received a copy of the GNU Lesser General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
 
#ifndef __jack_session_h__
#define __jack_session_h__
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <jack/types.h>
#include <jack/weakmacros.h>
 
enum JackSessionEventType {
    JackSessionSave = 1,
 
    JackSessionSaveAndQuit = 2,
 
    JackSessionSaveTemplate = 3
};
 
typedef enum JackSessionEventType jack_session_event_type_t;
 
enum JackSessionFlags {
    JackSessionSaveError = 0x01,
 
    JackSessionNeedTerminal = 0x02
};
 
typedef enum JackSessionFlags jack_session_flags_t;
 
struct _jack_session_event {
    jack_session_event_type_t type;
 
    const char *session_dir;
 
    const char *client_uuid;
 
    char *command_line;
 
    jack_session_flags_t flags;
 
    uint32_t future;
};
 
typedef struct _jack_session_event jack_session_event_t;
 
typedef void (*JackSessionCallback)(jack_session_event_t *event,
                                    void                 *arg);
 
int jack_set_session_callback (jack_client_t       *client,
                               JackSessionCallback  session_callback,
                               void                *arg) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
 
int jack_session_reply (jack_client_t        *client,
                        jack_session_event_t *event) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
 
 
void jack_session_event_free (jack_session_event_t *event) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
 
 
char *jack_client_get_uuid (jack_client_t *client) JACK_WEAK_EXPORT;
 
typedef struct  {
        const char           *uuid;
        const char           *client_name;
        const char           *command;
        jack_session_flags_t  flags;
} jack_session_command_t;
 
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;
 
void jack_session_commands_free (jack_session_command_t *cmds) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
 
int
jack_reserve_client_name (jack_client_t *client,
                          const char    *name,
                          const char    *uuid) JACK_WEAK_EXPORT;
 
int
jack_client_has_session_callback (jack_client_t *client, const char *client_name) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
 
#ifdef __cplusplus
}
#endif
#endif