Ardour  9.0-pre0-1952-gc5e0b21049
Public Types | Public Member Functions | Protected Member Functions | Static Private Member Functions | Private Attributes | List of all members
NSM::Client Class Referenceabstract

#include <nsmclient.h>

Inheritance diagram for NSM::Client:
[legend]

Public Types

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
}
 

Public Member Functions

 Client ()
 
virtual ~Client ()
 
bool is_active (void)
 
const char * session_manager_name (void)
 
const char * client_id (void)
 
const char * client_path (void)
 
void is_dirty (void)
 
void is_clean (void)
 
void progress (float f)
 
void message (int priority, const char *msg)
 
void announce (const char *appliction_name, const char *capabilities, const char *process_name)
 
void broadcast (lo_message msg)
 
int init (const char *nsm_url)
 
int init_thread (const char *nsm_url)
 
void check (int timeout=0)
 
void start (void)
 
void stop (void)
 

Protected Member Functions

virtual int command_open (const char *name, const char *display_name, const char *client_id, char **out_msg)=0
 
virtual int command_save (char **out_msg)=0
 
virtual void command_active (bool)
 
virtual void command_session_is_loaded (void)
 
virtual int command_broadcast (const char *, lo_message)
 

Static Private Member Functions

static int osc_open (const char *path, const char *types, lo_arg **argv, int argc, lo_message msg, void *user_data)
 
static int osc_save (const char *path, const char *types, lo_arg **argv, int argc, lo_message msg, void *user_data)
 
static int osc_announce_reply (const char *path, const char *types, lo_arg **argv, int argc, lo_message msg, void *user_data)
 
static int osc_error (const char *path, const char *types, lo_arg **argv, int argc, lo_message msg, void *user_data)
 
static int osc_session_is_loaded (const char *path, const char *types, lo_arg **argv, int argc, lo_message msg, void *user_data)
 
static int osc_broadcast (const char *path, const char *types, lo_arg **argv, int argc, lo_message msg, void *user_data)
 

Private Attributes

const char * nsm_url
 
lo_server _server
 
lo_server_thread _st
 
lo_address nsm_addr
 
bool nsm_is_active
 
char * _nsm_client_id
 
char * _session_manager_name
 
char * _nsm_client_path
 

Detailed Description

Definition at line 26 of file nsmclient.h.

Member Enumeration 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 43 of file nsmclient.h.

Constructor & Destructor Documentation

◆ Client()

NSM::Client::Client ( )

◆ ~Client()

virtual NSM::Client::~Client ( )
virtual

Member Function Documentation

◆ announce()

void NSM::Client::announce ( const char *  appliction_name,
const char *  capabilities,
const char *  process_name 
)

◆ broadcast()

void NSM::Client::broadcast ( lo_message  msg)

◆ check()

void NSM::Client::check ( int  timeout = 0)

◆ client_id()

const char* NSM::Client::client_id ( void  )
inline

Definition at line 62 of file nsmclient.h.

◆ client_path()

const char* NSM::Client::client_path ( void  )
inline

Definition at line 63 of file nsmclient.h.

◆ command_active()

virtual void NSM::Client::command_active ( bool  )
inlineprotectedvirtual

Definition at line 92 of file nsmclient.h.

◆ command_broadcast()

virtual int NSM::Client::command_broadcast ( const char *  ,
lo_message   
)
inlineprotectedvirtual

Definition at line 97 of file nsmclient.h.

◆ command_open()

virtual int NSM::Client::command_open ( const char *  name,
const char *  display_name,
const char *  client_id,
char **  out_msg 
)
protectedpure virtual

Implemented in NSM_Client.

◆ command_save()

virtual int NSM::Client::command_save ( char **  out_msg)
protectedpure virtual

Implemented in NSM_Client.

◆ command_session_is_loaded()

virtual void NSM::Client::command_session_is_loaded ( void  )
inlineprotectedvirtual

Definition at line 94 of file nsmclient.h.

◆ init()

int NSM::Client::init ( const char *  nsm_url)

◆ init_thread()

int NSM::Client::init_thread ( const char *  nsm_url)

◆ is_active()

bool NSM::Client::is_active ( void  )
inline

Definition at line 59 of file nsmclient.h.

◆ is_clean()

void NSM::Client::is_clean ( void  )

◆ is_dirty()

void NSM::Client::is_dirty ( void  )

◆ message()

void NSM::Client::message ( int  priority,
const char *  msg 
)

◆ osc_announce_reply()

static int NSM::Client::osc_announce_reply ( const char *  path,
const char *  types,
lo_arg **  argv,
int  argc,
lo_message  msg,
void *  user_data 
)
staticprivate

◆ osc_broadcast()

static int NSM::Client::osc_broadcast ( const char *  path,
const char *  types,
lo_arg **  argv,
int  argc,
lo_message  msg,
void *  user_data 
)
staticprivate

◆ osc_error()

static int NSM::Client::osc_error ( const char *  path,
const char *  types,
lo_arg **  argv,
int  argc,
lo_message  msg,
void *  user_data 
)
staticprivate

◆ osc_open()

static int NSM::Client::osc_open ( const char *  path,
const char *  types,
lo_arg **  argv,
int  argc,
lo_message  msg,
void *  user_data 
)
staticprivate

◆ osc_save()

static int NSM::Client::osc_save ( const char *  path,
const char *  types,
lo_arg **  argv,
int  argc,
lo_message  msg,
void *  user_data 
)
staticprivate

◆ osc_session_is_loaded()

static int NSM::Client::osc_session_is_loaded ( const char *  path,
const char *  types,
lo_arg **  argv,
int  argc,
lo_message  msg,
void *  user_data 
)
staticprivate

◆ progress()

void NSM::Client::progress ( float  f)

◆ session_manager_name()

const char* NSM::Client::session_manager_name ( void  )
inline

Definition at line 61 of file nsmclient.h.

◆ start()

void NSM::Client::start ( void  )

◆ stop()

void NSM::Client::stop ( void  )

Member Data Documentation

◆ _nsm_client_id

char* NSM::Client::_nsm_client_id
private

Definition at line 37 of file nsmclient.h.

◆ _nsm_client_path

char* NSM::Client::_nsm_client_path
private

Definition at line 39 of file nsmclient.h.

◆ _server

lo_server NSM::Client::_server
private

Definition at line 32 of file nsmclient.h.

◆ _session_manager_name

char* NSM::Client::_session_manager_name
private

Definition at line 38 of file nsmclient.h.

◆ _st

lo_server_thread NSM::Client::_st
private

Definition at line 33 of file nsmclient.h.

◆ nsm_addr

lo_address NSM::Client::nsm_addr
private

Definition at line 34 of file nsmclient.h.

◆ nsm_is_active

bool NSM::Client::nsm_is_active
private

Definition at line 36 of file nsmclient.h.

◆ nsm_url

const char* NSM::Client::nsm_url
private

Definition at line 30 of file nsmclient.h.

The documentation for this class was generated from the following file: