.. osc4py3 documentation master file, created by
   sphinx-quickstart on Wed Sep  2 10:19:29 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

#####################
Osc4py3 documentation
#####################

   
- `Module documentation <http://osc4py3.readthedocs.org/>`_ 
  (on Read The Docs)
- `Subversion repository & bug tracking <https://sourcesup.renater.fr/scm/viewvc.php?root=osc4py3>`_
  (on french academic SourceSup site).
- `Developer page <https://perso.limsi.fr/pointal/dev:osc4py3>`_


Osc4py3 is an implementation of `Open Sound Control (OSC)`_ message
transport protocol within a Python3 package.

.. _Open Sound Control (OSC): http://opensoundcontrol.org/

It manages different sides of OSC in possibly different contexts:

- encoding/decoding of OSC message packets (including bundles)
- routing of incoming messages based on selector regexps or globbing
- timed messages with possible delay period
- named client/server for sending/subscribing (light coupling)
- different scheduling models (single process, totally multithread, only multithread for communications)
- extra processing of packets (hack points to encrypt/decrypt, sign/verify…)

Note: routing, timed messages, named client/server, scheduling models make a complex system
(see the “big picture” in doc). The :mod:`oscbuildparse` module of :mod:`osc4py3` package can
be used as is and provides nice OSC packets encoding/decoding functions usable in your own message
transmission scheme.

The documentation is splitted in two main parts, a user guide for simple package
use, and a developer guide explaining how things are organized and work together.

Contents

.. toctree::
    :maxdepth: 3
    :numbered:

    userdoc.rst
    msgbund.rst
    devdoc.rst

.. ::
   Indices and tables
   ==================

   * :ref:`genindex`
   * :ref:`modindex`
   * :ref:`search`