PROTOTYPE: connect to existing Matlab sessions

Author: brunobeltran

.gitignore

@@ -37,3 +37,6 @@ rebuildTags.sh
 
 # caused py setup.py develop
 pymatbridge.egg-info
+
+# so vim-ers can use "YouCompleteMe"
+.ycm_extra_conf.py

pymatbridge/matlab/matlabserver.m

@@ -1,12 +1,17 @@
-function matlabserver(socket_address)
+function matlabserver(socket_address, exit_when_done)
+%MATLABSERVER   Take Commands from Python via ZMQ
 % This function takes a socket address as input and initiates a ZMQ session
 % over the socket. I then enters the listen-respond mode until it gets an
 % "exit" command
 
 json_startup
 messenger('init', socket_address);
 
-c=onCleanup(@()exit);
+if nargin > 1 && exit_when_done
+    c = onCleanup(@stop_messenger_and_exit);
+else
+    c = onCleanup(@stop_messenger);
+end
 
 while(1)
     msg_in = messenger('listen');
@@ -17,7 +22,6 @@ function matlabserver(socket_address)
             messenger('respond', 'connected');
 
         case {'exit'}
-            messenger('exit');
             break;
 
         case {'eval'}
@@ -29,3 +33,14 @@ function matlabserver(socket_address)
     end
 
 end
+
+end %matlabserver
+
+function stop_messenger_and_exit()
+    messenger('exit');
+    exit;
+end
+
+function stop_messenger()
+    messenger('exit');
+end

pymatbridge/messenger/mexa64/messenger.mexa64

@@ -48,61 +48,58 @@ void cleanup (void) {
     mexPrintf("Socket closed\n");
     zmq_term(ctx);
     mexPrintf("Context terminated\n");
+    initialized = 0;
 }
 
 
 /* Gateway function with Matlab */
 void mexFunction(int nlhs, mxArray *plhs[],
                  int nrhs, const mxArray *prhs[]) {
     char *cmd;
+    mxLogical *p;
     /* If no input argument, print out the usage */
     if (nrhs == 0) {
         mexErrMsgTxt("Usage: messenger('init|listen|respond', extra1, extra2, ...)");
     }
-
+    if (nlhs > 1) {
+        mexErrMsgTxt("messenger: too many outputs, I return a single bool");
+    }
     /* Get the input command */
     if(!(cmd = mxArrayToString(prhs[0]))) {
         mexErrMsgTxt("Cannot read the command");
     }
-
+    /* we'll return true on completion of valid command, else false */
+    plhs[0] = mxCreateLogicalMatrix(1, 1);
+    p = mxGetLogicals(plhs[0]);
+    p[0] = 0;
     /* Initialize a new server session */
     if (strcmp(cmd, "init") == 0) {
         char *socket_addr;
-        mxLogical *p;
-
         /* Check if the input format is valid */
         if (nrhs != 2) {
-            mexErrMsgTxt("Missing argument: socket address");
+            mexErrMsgTxt("Usage: messenger('init', socket_addr)");
         }
         if (!(socket_addr = mxArrayToString(prhs[1]))) {
             mexErrMsgTxt("Cannot read socket address");
         }
-
-        plhs[0] = mxCreateLogicalMatrix(1, 1);
-        p = mxGetLogicals(plhs[0]);
-
         if (!initialized) {
             if (!initialize(socket_addr)) {
                 p[0] = 1;
                 mexPrintf("Socket created at: %s\n", socket_addr);
             } else {
-                p[0] = 0;
                 mexErrMsgTxt("Socket creation failed.");
             }
         } else {
             mexErrMsgTxt("One socket has already been initialized.");
         }
-
-        return;
-
     /* Listen over an existing socket */
     } else if (strcmp(cmd, "listen") == 0) {
         int byte_recvd;
         char *recv_buffer = mxCalloc(BUFLEN, sizeof(char));
         zmq_pollitem_t polls[] = {{socket_ptr, 0, ZMQ_POLLIN, 0}};
-        
+
         if (!checkInitialized()) return;
-        
+
         /* allow MATLAB to draw its graphics every 20ms */
         while (zmq_poll(polls, 1, 20000) == 0) {
             mexEvalString("drawnow");
@@ -116,12 +113,10 @@ void mexFunction(int nlhs, mxArray *plhs[],
         } else if (byte_recvd > BUFLEN){
             mexErrMsgTxt("Receiver buffer overflow. Message truncated");
         } else {
-        	sprintf(recv_buffer, "Failed to receive a message due to ZMQ error %s", strerror(errno));
+            sprintf(recv_buffer, "Failed to receive a message due to ZMQ error %s", strerror(errno));
             mexErrMsgTxt(recv_buffer);
         }
-
-        return;
-
+        p[0] = 1;
     /* Send a message out */
     } else if (strcmp(cmd, "respond") == 0) {
         size_t msglen;
@@ -141,21 +136,17 @@ void mexFunction(int nlhs, mxArray *plhs[],
         plhs[0] = mxCreateLogicalMatrix(1, 1);
         p = mxGetLogicals(plhs[0]);
 
-        if (msglen == zmq_send(socket_ptr, msg_out, msglen, 0)) {
+        if (msglen == (size_t) zmq_send(socket_ptr, msg_out, msglen, 0)) {
             p[0] = 1;
         } else {
-            p[0] = 0;
             mexErrMsgTxt("Failed to send message due to ZMQ error");
         }
-
-        return;
-
     /* Close the socket and context */
     } else if (strcmp(cmd, "exit") == 0) {
         cleanup();
-
-        return;
+        p[0] = 1;
     } else {
         mexErrMsgTxt("Unidentified command");
     }
+    return;
 }

pymatbridge/messenger/src/messenger.c

@@ -120,8 +120,8 @@ class _Session(object):
     this directly; rather, use the Matlab or Octave subclasses.
     """
 
-    def __init__(self, executable, socket_addr=None,
-                 id='python-matlab-bridge', log=False, maxtime=60,
+    def __init__(self, executable=None, socket_addr=None,
+                 id='python-matlab-bridge', log=False, maxtime=15,
                  platform=None, startup_options=None,
                  loglevel=logging.WARNING):
         """
@@ -146,7 +146,7 @@ def __init__(self, executable, socket_addr=None,
 
         maxtime : float
            The maximal time to wait for a response from the session (optional,
-           Default is 10 sec)
+           Default is 15 sec)
 
         platform : string
            The OS of the machine on which this is running. Per default this
@@ -186,7 +186,7 @@ def __init__(self, executable, socket_addr=None,
         atexit.register(self.stop)
 
     def _program_name(self):  # pragma: no cover
-        raise NotImplemented
+        raise NotImplementedError
 
     def _preamble_code(self):
         # suppress warnings while loading the path, in the case of
@@ -199,7 +199,7 @@ def _preamble_code(self):
                 "cd('%s');" % os.getcwd()]
 
     def _execute_flag(self):  # pragma: no cover
-        raise NotImplemented
+        raise NotImplementedError
 
     def _run_server(self):
         code = self._preamble_code()
@@ -221,10 +221,14 @@ def start(self):
             self.socket_addr = self.socket_addr + ":%s"%rndport
 
         # Start the MATLAB server in a new process
-        self.logger.info("Starting %s on ZMQ socket %s" \
-                % (self._program_name(), self.socket_addr))
+        self.logger.info("Starting ZMQ socket %s" \
+                % (self.socket_addr, ))
         self.logger.info("Send 'exit' command to kill the server")
-        self._run_server()
+
+        if self.executable is not None:
+            self.logger.info("Launching %s, sending ZMQ 'exit' will kill it." \
+                    % (self._program_name(), ))
+            self._run_server()
 
         # Start the client
         self.socket.connect(self.socket_addr)
@@ -426,8 +430,9 @@ def _bind_method(self, name, unconditionally=False):
 
 class Matlab(_Session):
     def __init__(self, executable='matlab', socket_addr=None,
-                 id='python-matlab-bridge', log=False, maxtime=60,
-                 platform=None, startup_options=None):
+                 id='python-matlab-bridge', log=False, maxtime=15,
+                 platform=None, startup_options=None,
+                 loglevel=logging.WARNING):
         """
         Initialize this thing.
 
@@ -436,7 +441,7 @@ def __init__(self, executable='matlab', socket_addr=None,
 
         executable : str
             A string that would start Matlab at the terminal. Per default, this
-            is set to 'matlab', so that you can alias in your bash setup
+            is set to 'matlab'.
 
         socket_addr : str
             A string that represents a valid ZMQ socket address, such as
@@ -450,7 +455,7 @@ def __init__(self, executable='matlab', socket_addr=None,
 
         maxtime : float
            The maximal time to wait for a response from matlab (optional,
-           Default is 10 sec)
+           Default is 15 sec)
 
         platform : string
            The OS of the machine on which this is running. Per default this
@@ -470,7 +475,7 @@ def __init__(self, executable='matlab', socket_addr=None,
         if log:
             startup_options += ' -logfile ./pymatbridge/logs/matlablog_%s.txt' % id
         super(Matlab, self).__init__(executable, socket_addr, id, log, maxtime,
-                                     platform, startup_options)
+                                     platform, startup_options, loglevel)
 
     def _program_name(self):
         return 'MATLAB'
@@ -481,8 +486,9 @@ def _execute_flag(self):
 
 class Octave(_Session):
     def __init__(self, executable='octave', socket_addr=None,
-                 id='python-matlab-bridge', log=False, maxtime=60,
-                 platform=None, startup_options=None):
+                 id='python-matlab-bridge', log=False, maxtime=15,
+                 platform=None, startup_options=None,
+                 loglevel=logging.WARNING):
         """
         Initialize this thing.
 
@@ -505,7 +511,7 @@ def __init__(self, executable='octave', socket_addr=None,
 
         maxtime : float
            The maximal time to wait for a response from octave (optional,
-           Default is 10 sec)
+           Default is 15 sec)
 
         platform : string
            The OS of the machine on which this is running. Per default this