Skip to content
Andrew Ray edited this page Mar 21, 2014 · 2 revisions

GUID mapping

  • Bridge.ws_init kernel_of_kernel_guid

  • Kernel.start_kernel kernel_guid_of_notebook_guid

  • Kernel.start_kernel add_kernel

  • Kernel.get_kernel kernel_of_notebook_guid

  • Kernel.close_kernel kernel_of_kernel_guid

  • Kernel.close_kernel delete_kernel

  • Iocamlserver.notebook_list notebook_guid_of_filename

  • Iocamlserver.notebook_list kernel_guid_of_kernel

  • Iocamlserver.register_notebooks notebook_guid_of_filename

  • Iocamlserver.save_notebook notebook_guid_of_filename

  • Iocamlserver.save_notebook filename_of_notebook_guid

  • Iocamlserver.`Root_new notebook_guid_of_filename

  • Iocamlserver.`Root_name notebook_guid_of_filename

  • Iocamlserver.`Notebook_guid filename_of_notebook_guid

  • Iocamlserver.`Kernels_restart notebook_guid_of_kernel_guid

  • Iocamlserver.`Kernels_interrupt kernel_of_kernel_guid

  • Iocamlserver.run_servers notebook_guid_of_filename

  • Iocamlserver.close_kernels iter_kernels

Message flow

Dashboard

  1. `Root - serve dashboard

  2. `Notebooks - notebook_list

     map filenames to notebook GUIDS and optionally
     kernel guids.  notebook guids may be need to be
     created.  kernel guids may or may not exist.
    

Notebooks

  1. `Root/<notebook_guid> - serve notebook html

     given the notebook guid generated when the page was served
    
  2. `Notebooks/<notebook_guid> - GET serve notebook json

     find the filename from the notebook guid given.
     if a notebook is renamed that mapping must update.
    
  3. `Kernels/?<notebook_guid> - POST serve kernel_id json, start kernel

     generate the kernel_guid and kernel and map to notebook_guid
    
  4. `Notebooks/<notebook_guid> - PUT save notebook json

     this is either a save or a rename.  here we have issue.
    

in step 6 if the file name of the notebook has changed, we need to update the guid mapping. We then also need to consider guids with differing filenames.

Clone this wiki locally