spdylay/doc/apiref-header.rst

API Reference
=============

Includes
--------

To use the public APIs, include ``spdylay/spdylay.h``::

    #include <spdylay/spdylay.h>

Remarks
-------

Do not call `spdylay_session_send`, `spdylay_session_recv` or
`spdylay_session_mem_recv` from the spdylay callback functions
directly or indirectly. It will lead to the crash. You can submit
requests or frames in the callbacks then call `spdylay_session_send`,
`spdylay_session_recv` or `spdylay_session_mem_recv` outside of the
callbacks.
Added API reference generator script. Formatted the public APIs with Sphinx syntax. 2012-03-13 11:32:52 -04:00			`API Reference`
			`=============`

			`Includes`
			`--------`

			To use the public APIs, include ``spdylay/spdylay.h``::

			`#include <spdylay/spdylay.h>`
Add remarks about callbacks and spdylay_session_{recv,send} 2012-12-22 11:24:56 -05:00
			`Remarks`
			`-------`

			Do not call `spdylay_session_send`, `spdylay_session_recv` or
			`spdylay_session_mem_recv` from the spdylay callback functions
			`directly or indirectly. It will lead to the crash. You can submit`
			requests or frames in the callbacks then call `spdylay_session_send`,
			`spdylay_session_recv` or `spdylay_session_mem_recv` outside of the
			`callbacks.`