LADI
/
jack-headers
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

session.h: Fix typos and wording, mark as deprecated 

Signed-off-by: falkTX <falktx@falktx.com>
This commit is contained in:
falkTX 2020-07-16 12:57:49 +01:00
parent 04d07f8847
commit d7d828df53
No known key found for this signature in database
GPG Key ID: CDBAA37ABC74FBA0
1 changed files with 44 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
session.h
View File

@ -30,6 +30,10 @@ extern "C" {
/**
* @defgroup SessionClientFunctions Session API for clients.
*
* @deprecated Use of JACK-Session is currently deprecated and unsupported.
* JACK developers recommend the use of NSM instead.
* See https://github.com/linuxaudio/new-session-manager
* @{
*/
@ -37,7 +41,7 @@ extern "C" {
/**
* Session event type.
*
* if a client cant save templates, i might just do a normal save.
* If a client can't save templates, i might just do a normal save.
*
* There is no "quit without saving" event because a client might refuse to
* quit when it has unsaved data, but other clients may have already quit.
@ -57,7 +61,7 @@ enum JackSessionEventType {
JackSessionSave = 1,
/**
* Save the session completly, then quit.
* Save the session completely, then quit.
*
* The rules for saving are exactly the same as for JackSessionSave.
*/
@ -82,7 +86,7 @@ typedef enum JackSessionEventType jack_session_event_type_t;
*/
enum JackSessionFlags {
/**
* An error occured while saving.
* An error occurred while saving.
*/
JackSessionSaveError = 0x01,
@ -156,6 +160,10 @@ typedef struct _jack_session_event jack_session_event_t;
*
* The client must promptly call jack_session_reply for this event.
*
* @deprecated Use of JACK-Session is currently deprecated and unsupported.
* JACK developers recommend the use of NSM instead.
* See https://github.com/linuxaudio/new-session-manager
*
* @param event The event structure.
* @param arg Pointer to a client supplied structure.
*/
@ -170,11 +178,15 @@ typedef void (*JackSessionCallback)(jack_session_event_t *event,
* error. if you have a multiclient application its more sensible to create
* a jack_client with only a session callback set.
*
* @deprecated Use of JACK-Session is currently deprecated and unsupported.
* JACK developers recommend the use of NSM instead.
* See https://github.com/linuxaudio/new-session-manager
*
* @return 0 on success, otherwise a non-zero error code
*/
int jack_set_session_callback (jack_client_t *client,
JackSessionCallback session_callback,
void *arg) JACK_WEAK_EXPORT;
void *arg) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
/**
* Reply to a session event.
@ -183,26 +195,35 @@ int jack_set_session_callback (jack_client_t *client,
* different thread. For example, it is possible to push the event through a
* queue and execute the save code from the GUI thread.
*
* @deprecated Use of JACK-Session is currently deprecated and unsupported.
* JACK developers recommend the use of NSM instead.
* See https://github.com/linuxaudio/new-session-manager
*
* @return 0 on success, otherwise a non-zero error code
*/
int jack_session_reply (jack_client_t *client,
jack_session_event_t *event) JACK_WEAK_EXPORT;
jack_session_event_t *event) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
/**
* free memory used by a jack_session_event_t
* this also frees the memory used by the command_line pointer.
* if its non NULL.
* Free memory used by a jack_session_event_t.
*
* This also frees the memory used by the command_line pointer, if its non NULL.
*
* @deprecated Use of JACK-Session is currently deprecated and unsupported.
* JACK developers recommend the use of NSM instead.
* See https://github.com/linuxaudio/new-session-manager
*/
void jack_session_event_free (jack_session_event_t *event) JACK_WEAK_EXPORT;
void jack_session_event_free (jack_session_event_t *event) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
/**
* get the assigned uuid for client.
* safe to call from callback and all other threads.
* memory needs to be freed.
* Get the assigned uuid for client.
* Safe to call from callback and all other threads.
*
* The caller is responsible for calling jack_free(3) on any non-NULL
* returned value.
*/
char *jack_client_get_uuid (jack_client_t *client) JACK_WEAK_EXPORT;
/**
@ -237,8 +258,12 @@ jack_session_command_t *jack_session_notify (
/**
* Free the memory allocated by a session command.
*
* @deprecated Use of JACK-Session is currently deprecated and unsupported.
* JACK developers recommend the use of NSM instead.
* See https://github.com/linuxaudio/new-session-manager
*/
void jack_session_commands_free (jack_session_command_t *cmds) JACK_WEAK_EXPORT;
void jack_session_commands_free (jack_session_command_t *cmds) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
/**
* Reserve a client name and associate it with a UUID.
@ -257,11 +282,15 @@ jack_reserve_client_name (jack_client_t *client,
/**
* Find out whether a client has set up a session callback.
*
* @deprecated Use of JACK-Session is currently deprecated and unsupported.
* JACK developers recommend the use of NSM instead.
* See https://github.com/linuxaudio/new-session-manager
*
* @return 0 when the client has no session callback, 1 when it has one.
* -1 on error.
*/
int
jack_client_has_session_callback (jack_client_t *client, const char *client_name) JACK_WEAK_EXPORT;
jack_client_has_session_callback (jack_client_t *client, const char *client_name) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
/**
* @}