nonlib/NSM/Client.H

   1
   2 /*******************************************************************************/
   3 /* Copyright (C) 2012 Jonathan Moore Liles                                     */
   4 /*                                                                             */
   5 /* This program is free software; you can redistribute it and/or modify it     */
   6 /* under the terms of the GNU General Public License as published by the       */
   7 /* Free Software Foundation; either version 2 of the License, or (at your      */
   8 /* option) any later version.                                                  */
   9 /*                                                                             */
  10 /* This program is distributed in the hope that it will be useful, but WITHOUT */
  11 /* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       */
  12 /* FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for   */
  13 /* more details.                                                               */
  14 /*                                                                             */
  15 /* You should have received a copy of the GNU General Public License along     */
  16 /* with This program; see the file COPYING.  If not,write to the Free Software */
  17 /* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  18 /*******************************************************************************/
  19
  20 #pragma once
  21
  22 #include <lo/lo.h>
  23
  24 namespace NSM
  25 {
  26
  27     class Client
  28     {
  29
  30     private:
  31
  32         const char *nsm_url;
  33
  34         lo_server _server;
  35         lo_server_thread _st;
  36         lo_address nsm_addr;
  37
  38         bool nsm_is_active;
  39         char *nsm_client_id;
  40         char *_session_manager_name;
  41
  42     public:
  43
  44         enum
  45         {
  46             ERR_OK = 0,
  47             ERR_GENERAL    = -1,
  48             ERR_INCOMPATIBLE_API = -2,
  49             ERR_BLACKLISTED      = -3,
  50             ERR_LAUNCH_FAILED    = -4,
  51             ERR_NO_SUCH_FILE     = -5,
  52             ERR_NO_SESSION_OPEN  = -6,
  53             ERR_UNSAVED_CHANGES  = -7,
  54             ERR_NOT_NOW          = -8
  55         };
  56
  57         Client ( );
  58         virtual ~Client ( );
  59
  60         bool is_active ( void ) { return nsm_is_active; }
  61
  62         const char *session_manager_name ( void ) { return _session_manager_name; }
  63
  64         /* Client->Server methods */
  65         void is_dirty ( void );
  66         void is_clean ( void );
  67         void progress ( float f );
  68         void message( int priority, const char *msg );
  69         void announce ( const char *appliction_name, const char *capabilities, const char *process_name );
  70
  71         void broadcast ( lo_message msg );
  72
  73         /* init without threading */
  74         int init ( const char *nsm_url );
  75         /* init with threading */
  76         int init_thread ( const char *nsm_url );
  77
  78         /* call this periodically to check for new messages */
  79         void check ( int timeout = 0 );
  80
  81         /* or call these to start and stop a thread (must do your own locking in handler!) */
  82         void start ( void );
  83         void stop ( void );
  84
  85     protected:
  86
  87         /* Server->Client methods */
  88         virtual int command_open ( const char *name, const char *display_name, const char *client_id, char **out_msg ) = 0;
  89         virtual int command_save ( char **out_msg ) = 0;
  90
  91         virtual void command_active ( bool ) { }
  92
  93         virtual void command_session_is_loaded ( void ) { }
  94
  95         /* invoked when an unrecognized message is received. Should return 0 if you handled it, -1 otherwise. */
  96         virtual int command_broadcast ( const char *, lo_message ) { return -1; }
  97
  98     private:
  99
 100         /* osc handlers */
 101         static int osc_open ( const char *path, const char *types, lo_arg **argv, int argc, lo_message msg, void *user_data );
 102         static int osc_save ( const char *path, const char *types, lo_arg **argv, int argc, lo_message msg, void *user_data );
 103         static int osc_announce_reply ( const char *path, const char *types, lo_arg **argv, int argc, lo_message msg, void *user_data );
 104         static int osc_error ( const char *path, const char *types, lo_arg **argv, int argc, lo_message msg, void *user_data );
 105         static int osc_session_is_loaded ( const char *path, const char *types, lo_arg **argv, int argc, lo_message msg, void *user_data );
 106         static int osc_broadcast ( const char *path, const char *types, lo_arg **argv, int argc, lo_message msg, void *user_data );
 107
 108     };
 109 };