Added doc about the required members for spdylay_session_callbacks when

it is passed to spdylay_session_{client,server}_new().
This commit is contained in:
Tatsuhiro Tsujikawa 2012-03-14 00:36:53 +09:00
parent 07b02404c3
commit a01b63b37a
1 changed files with 10 additions and 0 deletions

View File

@ -984,6 +984,11 @@ typedef struct {
* |callbacks|. |user_data| is an arbitrary user supplied data, which
* will be passed to the callback functions.
*
* Some of the members of |callbacks| can be ``NULL``, but
* :member:`spdylay_session_callbacks.send_callback` and
* :member:`spdylay_session_callbacks.recv_callback` are must be
* specified.
*
* This function returns 0 if it succeeds, or one of the following
* negative error codes:
*
@ -1008,6 +1013,11 @@ int spdylay_session_client_new(spdylay_session **session_ptr,
* |callbacks|. |user_data| is an arbitrary user supplied data, which
* will be passed to the callback functions.
*
* Some of the members of |callbacks| can be ``NULL``, but
* :member:`spdylay_session_callbacks.send_callback` and
* :member:`spdylay_session_callbacks.recv_callback` are must be
* specified.
*
* This function returns 0 if it succeeds, or one of the following
* negative error codes:
*