hydrogen 1.2.6
Data Structures | Macros | Typedefs | Enumerations | Functions
Nsm.h File Reference

Go to the source code of this file.

Data Structures

struct  _nsm_client_t
 

Macros

#define _NSM()
 
#define NSM_API_VERSION_MAJOR   1
 
#define NSM_API_VERSION_MINOR   0
 
#define NSM_EXPORT   __attribute__((unused)) static
 
#define OSC_REPLY(value)
 
#define OSC_REPLY_ERR(errcode, value)
 
#define OSC_REPLY_P(path, value)
 

Typedefs

typedef void nsm_active_callback(int b, void *userdata)
 
typedef int nsm_broadcast_callback(const char *, lo_message m, void *userdata)
 
typedef void * nsm_client_t
 
typedef int nsm_open_callback(const char *name, const char *display_name, const char *client_id, char **out_msg, void *userdata)
 
typedef int nsm_save_callback(char **out_msg, void *userdata)
 
typedef void nsm_session_is_loaded_callback(void *userdata)
 

Enumerations

enum  {
  ERR_OK = 0 , ERR_GENERAL = -1 , ERR_INCOMPATIBLE_API = -2 , ERR_BLACKLISTED = -3 ,
  ERR_LAUNCH_FAILED = -4 , ERR_NO_SUCH_FILE = -5 , ERR_NO_SESSION_OPEN = -6 , ERR_UNSAVED_CHANGES = -7 ,
  ERR_NOT_NOW = -8
}
 

Functions

NSM_EXPORT int _nsm_osc_announce_reply (const char *path, const char *types, lo_arg **argv, int argc, lo_message msg, void *user_data)
 
NSM_EXPORT int _nsm_osc_broadcast (const char *path, const char *types, lo_arg **argv, int argc, lo_message msg, void *user_data)
 
NSM_EXPORT int _nsm_osc_error (const char *path, const char *types, lo_arg **argv, int argc, lo_message msg, void *user_data)
 
NSM_EXPORT int _nsm_osc_open (const char *path, const char *types, lo_arg **argv, int argc, lo_message msg, void *user_data)
 
NSM_EXPORT int _nsm_osc_save (const char *path, const char *types, lo_arg **argv, int argc, lo_message msg, void *user_data)
 
NSM_EXPORT int _nsm_osc_session_is_loaded (const char *path, const char *types, lo_arg **argv, int argc, lo_message msg, void *user_data)
 
NSM_EXPORT void nsm_check_nowait (nsm_client_t *nsm)
 
NSM_EXPORT void nsm_check_wait (nsm_client_t *nsm, int timeout)
 
NSM_EXPORT void nsm_free (nsm_client_t *nsm)
 
NSM_EXPORT const char * nsm_get_session_manager_name (nsm_client_t *nsm)
 
NSM_EXPORT int nsm_init (nsm_client_t *nsm, const char *nsm_url)
 
NSM_EXPORT int nsm_init_thread (nsm_client_t *nsm, const char *nsm_url)
 
NSM_EXPORT int nsm_is_active (nsm_client_t *nsm)
 
NSM_EXPORT nsm_client_t * nsm_new (void)
 
NSM_EXPORT void nsm_send_announce (nsm_client_t *nsm, const char *app_name, const char *capabilities, const char *process_name)
 
NSM_EXPORT void nsm_send_broadcast (nsm_client_t *nsm, lo_message msg)
 
NSM_EXPORT void nsm_send_is_clean (nsm_client_t *nsm)
 
NSM_EXPORT void nsm_send_is_dirty (nsm_client_t *nsm)
 
NSM_EXPORT void nsm_send_message (nsm_client_t *nsm, int priority, const char *msg)
 
NSM_EXPORT void nsm_send_progress (nsm_client_t *nsm, float p)
 
NSM_EXPORT void nsm_set_active_callback (nsm_client_t *nsm, nsm_active_callback *active_callback, void *userdata)
 
NSM_EXPORT void nsm_set_broadcast_callback (nsm_client_t *nsm, nsm_broadcast_callback *broadcast_callback, void *userdata)
 
NSM_EXPORT void nsm_set_open_callback (nsm_client_t *nsm, nsm_open_callback *open_callback, void *userdata)
 
NSM_EXPORT void nsm_set_save_callback (nsm_client_t *nsm, nsm_save_callback *save_callback, void *userdata)
 
NSM_EXPORT void nsm_set_session_is_loaded_callback (nsm_client_t *nsm, nsm_session_is_loaded_callback *session_is_loaded_callback, void *userdata)
 
NSM_EXPORT void nsm_thread_start (nsm_client_t *nsm)
 
NSM_EXPORT void nsm_thread_stop (nsm_client_t *nsm)
 

Macro Definition Documentation

◆ _NSM

#define _NSM ( )
Value:
((struct _nsm_client_t*)nsm)
_nsm_client_t
Definition Nsm.h:99

Definition at line 93 of file Nsm.h.

◆ NSM_API_VERSION_MAJOR

#define NSM_API_VERSION_MAJOR   1

Definition at line 76 of file Nsm.h.

◆ NSM_API_VERSION_MINOR

#define NSM_API_VERSION_MINOR   0

Definition at line 77 of file Nsm.h.

◆ NSM_EXPORT

#define NSM_EXPORT   __attribute__((unused)) static

Definition at line 95 of file Nsm.h.

◆ OSC_REPLY

#define OSC_REPLY ( value)
Value:
lo_send_from( ((struct _nsm_client_t*)user_data)->nsm_addr, ((struct _nsm_client_t*)user_data)->_server, LO_TT_IMMEDIATE, "/reply", "ss", path, value )

Definition at line 348 of file Nsm.h.

◆ OSC_REPLY_ERR

#define OSC_REPLY_ERR ( errcode,
value )
Value:
lo_send_from( ((struct _nsm_client_t*)user_data)->nsm_addr, ((struct _nsm_client_t*)user_data)->_server, LO_TT_IMMEDIATE, "/error", "sis", path, errcode, value )

Definition at line 351 of file Nsm.h.

◆ OSC_REPLY_P

#define OSC_REPLY_P ( path,
value )
Value:
lo_send_from( ((struct _nsm_client_t*)user_data)->nsm_addr, ((struct _nsm_client_t*)user_data)->_server, LO_TT_IMMEDIATE, "/reply", "ss", path, value )

Definition at line 349 of file Nsm.h.

Typedef Documentation

◆ nsm_active_callback

typedef void nsm_active_callback(int b, void *userdata)

Definition at line 89 of file Nsm.h.

◆ nsm_broadcast_callback

typedef int nsm_broadcast_callback(const char *, lo_message m, void *userdata)

Definition at line 91 of file Nsm.h.

◆ nsm_client_t

typedef void* nsm_client_t

Definition at line 86 of file Nsm.h.

◆ nsm_open_callback

typedef int nsm_open_callback(const char *name, const char *display_name, const char *client_id, char **out_msg, void *userdata)

Definition at line 87 of file Nsm.h.

◆ nsm_save_callback

typedef int nsm_save_callback(char **out_msg, void *userdata)

Definition at line 88 of file Nsm.h.

◆ nsm_session_is_loaded_callback

typedef void nsm_session_is_loaded_callback(void *userdata)

Definition at line 90 of file Nsm.h.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
ERR_OK 
ERR_GENERAL 
ERR_INCOMPATIBLE_API 
ERR_BLACKLISTED 
ERR_LAUNCH_FAILED 
ERR_NO_SUCH_FILE 
ERR_NO_SESSION_OPEN 
ERR_UNSAVED_CHANGES 
ERR_NOT_NOW 

Definition at line 126 of file Nsm.h.

Function Documentation

◆ _nsm_osc_announce_reply()

NSM_EXPORT int _nsm_osc_announce_reply ( const char * path,
const char * types,
lo_arg ** argv,
int argc,
lo_message msg,
void * user_data )

Definition at line 412 of file Nsm.h.

◆ _nsm_osc_broadcast()

NSM_EXPORT int _nsm_osc_broadcast ( const char * path,
const char * types,
lo_arg ** argv,
int argc,
lo_message msg,
void * user_data )

Definition at line 475 of file Nsm.h.

◆ _nsm_osc_error()

NSM_EXPORT int _nsm_osc_error ( const char * path,
const char * types,
lo_arg ** argv,
int argc,
lo_message msg,
void * user_data )

Definition at line 435 of file Nsm.h.

◆ _nsm_osc_open()

NSM_EXPORT int _nsm_osc_open ( const char * path,
const char * types,
lo_arg ** argv,
int argc,
lo_message msg,
void * user_data )

Definition at line 354 of file Nsm.h.

◆ _nsm_osc_save()

NSM_EXPORT int _nsm_osc_save ( const char * path,
const char * types,
lo_arg ** argv,
int argc,
lo_message msg,
void * user_data )

Definition at line 382 of file Nsm.h.

◆ _nsm_osc_session_is_loaded()

NSM_EXPORT int _nsm_osc_session_is_loaded ( const char * path,
const char * types,
lo_arg ** argv,
int argc,
lo_message msg,
void * user_data )

Definition at line 457 of file Nsm.h.

◆ nsm_check_nowait()

NSM_EXPORT void nsm_check_nowait ( nsm_client_t * nsm)

Definition at line 257 of file Nsm.h.

◆ nsm_check_wait()

NSM_EXPORT void nsm_check_wait ( nsm_client_t * nsm,
int timeout )

Definition at line 249 of file Nsm.h.

◆ nsm_free()

NSM_EXPORT void nsm_free ( nsm_client_t * nsm)

Definition at line 281 of file Nsm.h.

◆ nsm_get_session_manager_name()

NSM_EXPORT const char * nsm_get_session_manager_name ( nsm_client_t * nsm)

Definition at line 148 of file Nsm.h.

◆ nsm_init()

NSM_EXPORT int nsm_init ( nsm_client_t * nsm,
const char * nsm_url )

Definition at line 493 of file Nsm.h.

◆ nsm_init_thread()

NSM_EXPORT int nsm_init_thread ( nsm_client_t * nsm,
const char * nsm_url )

Definition at line 519 of file Nsm.h.

◆ nsm_is_active()

NSM_EXPORT int nsm_is_active ( nsm_client_t * nsm)

Definition at line 141 of file Nsm.h.

◆ nsm_new()

NSM_EXPORT nsm_client_t * nsm_new ( void )

Definition at line 155 of file Nsm.h.

◆ nsm_send_announce()

NSM_EXPORT void nsm_send_announce ( nsm_client_t * nsm,
const char * app_name,
const char * capabilities,
const char * process_name )

Definition at line 215 of file Nsm.h.

◆ nsm_send_broadcast()

NSM_EXPORT void nsm_send_broadcast ( nsm_client_t * nsm,
lo_message msg )

Definition at line 239 of file Nsm.h.

◆ nsm_send_is_clean()

NSM_EXPORT void nsm_send_is_clean ( nsm_client_t * nsm)

Definition at line 192 of file Nsm.h.

◆ nsm_send_is_dirty()

NSM_EXPORT void nsm_send_is_dirty ( nsm_client_t * nsm)

Definition at line 184 of file Nsm.h.

◆ nsm_send_message()

NSM_EXPORT void nsm_send_message ( nsm_client_t * nsm,
int priority,
const char * msg )

Definition at line 208 of file Nsm.h.

◆ nsm_send_progress()

NSM_EXPORT void nsm_send_progress ( nsm_client_t * nsm,
float p )

Definition at line 200 of file Nsm.h.

◆ nsm_set_active_callback()

NSM_EXPORT void nsm_set_active_callback ( nsm_client_t * nsm,
nsm_active_callback * active_callback,
void * userdata )

Definition at line 316 of file Nsm.h.

◆ nsm_set_broadcast_callback()

NSM_EXPORT void nsm_set_broadcast_callback ( nsm_client_t * nsm,
nsm_broadcast_callback * broadcast_callback,
void * userdata )

Definition at line 333 of file Nsm.h.

◆ nsm_set_open_callback()

NSM_EXPORT void nsm_set_open_callback ( nsm_client_t * nsm,
nsm_open_callback * open_callback,
void * userdata )

Definition at line 300 of file Nsm.h.

◆ nsm_set_save_callback()

NSM_EXPORT void nsm_set_save_callback ( nsm_client_t * nsm,
nsm_save_callback * save_callback,
void * userdata )

Definition at line 308 of file Nsm.h.

◆ nsm_set_session_is_loaded_callback()

NSM_EXPORT void nsm_set_session_is_loaded_callback ( nsm_client_t * nsm,
nsm_session_is_loaded_callback * session_is_loaded_callback,
void * userdata )

Definition at line 324 of file Nsm.h.

◆ nsm_thread_start()

NSM_EXPORT void nsm_thread_start ( nsm_client_t * nsm)

Definition at line 265 of file Nsm.h.

◆ nsm_thread_stop()

NSM_EXPORT void nsm_thread_stop ( nsm_client_t * nsm)

Definition at line 273 of file Nsm.h.