Imported Upstream version 1.0.0
[platform/upstream/nghttp2.git] / doc / nghttp2_session_server_new.rst
1
2 nghttp2_session_server_new
3 ==========================
4
5 Synopsis
6 --------
7
8 *#include <nghttp2/nghttp2.h>*
9
10 .. function:: int nghttp2_session_server_new(nghttp2_session **session_ptr, const nghttp2_session_callbacks *callbacks, void *user_data)
11
12     
13     Initializes *\*session_ptr* for server use.  The all members of
14     *callbacks* are copied to *\*session_ptr*. Therefore *\*session_ptr*
15     does not store *callbacks*.  The *user_data* is an arbitrary user
16     supplied data, which will be passed to the callback functions.
17     
18     The :type:`nghttp2_send_callback` must be specified.  If the
19     application code uses `nghttp2_session_recv()`, the
20     :type:`nghttp2_recv_callback` must be specified.  The other members
21     of *callbacks* can be ``NULL``.
22     
23     If this function fails, *\*session_ptr* is left untouched.
24     
25     This function returns 0 if it succeeds, or one of the following
26     negative error codes:
27     
28     :macro:`NGHTTP2_ERR_NOMEM`
29         Out of memory.