Common Declarations
=====================

Miscellaneous types and utilities





---------------------------------
         Definitions
---------------------------------



Default number of process workers.




Maximum number of process worker restarts before we give up.




Default number of WSGI threads to run.




Default max (fs) path length: 



.. c:macro:: YMO_WSGI_HDR_NAME_MAX_LEN

   Header-field name max length 


   .. code-block:: c
      :caption: Definition
   
      #define YMO_WSGI_HDR_NAME_MAX_LEN       256


.. c:macro:: YMO_WSGI_WORKER_QUEUE_POOL_SIZE

   Number of queue nodes preallocated per thread worker.


   .. code-block:: c
      :caption: Definition
   
      #define YMO_WSGI_WORKER_QUEUE_POOL_SIZE 100


.. c:macro:: YMO_WSGI_EXCHANGE_POOL_SIZE

   Number of exchange structs to preallocated per session.


   .. code-block:: c
      :caption: Definition
   
      #define YMO_WSGI_EXCHANGE_POOL_SIZE     2


.. c:macro:: YIMMO_CONTEXT_PY

   cast a C yimmo context to a Python object pointer.


   .. code-block:: c
      :caption: Definition
   
      #define YIMMO_CONTEXT_PY(ptr) ((PyObject*)(ptr))


.. c:macro:: YIMMO_CONTEXT_C

   cast a Python object pointer to a C yimmo context.


   .. code-block:: c
      :caption: Definition
   
      #define YIMMO_CONTEXT_C(ptr) ((yimmo_context_t*)(ptr))


.. c:macro:: YIMMO_WEBSOCKET_PY

   cast a C yimmo websocket to a Python object pointer.


   .. code-block:: c
      :caption: Definition
   
      #define YIMMO_WEBSOCKET_PY(ptr) ((PyObject*)(ptr))


.. c:macro:: YIMMO_WEBSOCKET_C

   cast a Python object pointer to a C yimmo websocket.


   .. code-block:: c
      :caption: Definition
   
      #define YIMMO_WEBSOCKET_C(ptr) ((yimmo_websocket_t*)(ptr))


---------------------------------
          Types
---------------------------------



.. c:type:: ymo_wsgi_worker_t

   Encapsulates the data for a single yimmo-wsgi _thread_ worker.


   .. code-block:: c
      :caption: Definition
   
      typedef struct ymo_wsgi_worker ymo_wsgi_worker_t;


.. c:type:: ymo_wsgi_session_t

   Encapsulate the data for a single yimmo-wsgi HTTP session.


   .. code-block:: c
      :caption: Definition
   
      typedef struct ymo_wsgi_session ymo_wsgi_session_t;


.. c:type:: ymo_wsgi_exchange_t

   Encapsulates the data for a single yimmo-wsgi exchange — i.e. a
   request/response pair.


   .. code-block:: c
      :caption: Definition
   
      typedef struct ymo_wsgi_exchange ymo_wsgi_exchange_t;


.. c:type:: yimmo_context_t

   Encapsulates the "WSGI view" of a session, ``environ``, ``start_response``,
   etc. For more info, see PEP3333.


   .. code-block:: c
      :caption: Definition
   
      typedef struct yimmo_context yimmo_context_t;


.. c:type:: yimmo_websocket_t

   A Yimmo Python WebSocket connection. 


   .. code-block:: c
      :caption: Definition
   
      typedef struct yimmo_websocket yimmo_websocket_t;


.. c:type:: ymo_wsgi_proc_t

   Encapsulates the data for a single yimmo-wsgi _process_ worker.


   .. code-block:: c
      :caption: Definition
   
      typedef struct ymo_wsgi_proc ymo_wsgi_proc_t;


.. c:type:: ymo_wsgi_exchange_pool_t

   Pool type used to minimize ``malloc``/``free`` calls for sessions which
   involve multiple exchanges.


   .. code-block:: c
      :caption: Definition
   
      typedef struct ymo_wsgi_exchange_pool ymo_wsgi_exchange_pool_t;