Skip to content
Browse files

Fix manpages for HTTP callbacks

Change-Id: I6017d7569b610a08f3342a2b3db6572fea5bcc45
Reviewed-on: http://review.couchbase.org/25385
Tested-by: Sergey Avseyev <sergey.avseyev@gmail.com>
Reviewed-by: Trond Norbye <trond.norbye@gmail.com>
  • Loading branch information...
1 parent ba82ccc commit 79d911fac6721b181d7f9e00e2deb2aa3c3257fd @avsej avsej committed with trondn Mar 28, 2013
View
17 man/bsd/man3/lcb_set_http_complete_callback.3
@@ -2,12 +2,12 @@
.\" Title: lcb_set_http_complete_callback
.\" Author: Trond Norbye <trond.norbye@couchbase.com>
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\" Date: 01/07/2013
+.\" Date: 03/28/2013
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
-.TH "LCB_SET_HTTP_COMPLET" "3" "01/07/2013" "\ \&" "\ \&"
+.TH "LCB_SET_HTTP_COMPLET" "3" "03/28/2013" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -44,10 +44,11 @@ The callback parameter is a the callback function to call for each http response
.RS 4
.\}
.nf
-void function(lcb_t instance,
+void function(lcb_http_request_t request,
+ lcb_t instance,
const void* cookie,
lcb_error_t error,
- lcb_http_resp_t * resp);
+ const lcb_http_resp_t *resp);
.fi
.if n \{\
.RE
@@ -71,7 +72,7 @@ typedef struct {
lcb_size_t nbytes; /* The number of bytes in the content */
} v0;
} v;
-} lcb_http_complete_resp_t;
+} lcb_http_resp_t;
.fi
.if n \{\
.RE
@@ -125,9 +126,11 @@ Example 2: Install custom callback
.\}
.nf
\&.\&.\&.
-static void callback(lcb_t instance, const void *cookie,
+static void callback(lcb_http_request_t request,
+ lcb_t instance,
+ const void *cookie,
lcb_error_t error,
- const lcb_http_complete_resp_t *resp)
+ const lcb_http_resp_t *resp)
{
if (error == LCB_SUCCESS) {
switch (resp\->version) {
View
16 man/bsd/man3/lcb_set_http_data_callback.3
@@ -2,12 +2,12 @@
.\" Title: lcb_set_http_data_callback
.\" Author: Trond Norbye <trond.norbye@couchbase.com>
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\" Date: 01/07/2013
+.\" Date: 03/28/2013
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
-.TH "LCB_SET_HTTP_DATA_CA" "3" "01/07/2013" "\ \&" "\ \&"
+.TH "LCB_SET_HTTP_DATA_CA" "3" "03/28/2013" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -46,10 +46,11 @@ Passing NULL as the callback function may be used to query the current callback
.RS 4
.\}
.nf
-void function(lcb_t instance,
+void function(lcb_http_request_t request,
+ lcb_t instance,
const void* cookie,
lcb_error_t error,
- lcb_http_resp_t * resp);
+ const lcb_http_resp_t *resp);
.fi
.if n \{\
.RE
@@ -73,7 +74,7 @@ typedef struct {
lcb_size_t nbytes; /* The number of bytes in the content */
} v0;
} v;
-} lcb_http_data_resp_t;
+} lcb_http_resp_t;
.fi
.if n \{\
.RE
@@ -129,9 +130,10 @@ Example 2: Install custom callback
.\}
.nf
\&.\&.\&.
-static void callback(lcb_t instance, const void *cookie,
+static void callback(lcb_http_request_t request,
+ lcb_t instance, const void *cookie,
lcb_error_t error,
- const lcb_http_data_resp_t *resp)
+ const lcb_http_resp_t *resp)
{
if (error == LCB_SUCCESS) {
switch (resp\->version) {
View
13 man/man3couchbase/lcb_set_http_complete_callback.3couchbase.txt
@@ -23,10 +23,11 @@ http response. Passing NULL as the callback function may be used to
query the current callback function. The lcb_http_complete_callback is
a function with the following signature:
- void function(lcb_t instance,
+ void function(lcb_http_request_t request,
+ lcb_t instance,
const void* cookie,
lcb_error_t error,
- lcb_http_resp_t * resp);
+ const lcb_http_resp_t *resp);
instance is the libcouchbase instance that this response is called
from. The cookie is cookie you passed to lcb_make_http_request.
@@ -46,7 +47,7 @@ lcb_http_resp_t is a structure defined in <libcouchbase/arguments.h>:
lcb_size_t nbytes; /* The number of bytes in the content */
} v0;
} v;
- } lcb_http_complete_resp_t;
+ } lcb_http_resp_t;
RETURN VALUES
-------------
@@ -74,9 +75,11 @@ Example 2: Install custom callback
#include <libcouchbase/couchbase.h>
...
- static void callback(lcb_t instance, const void *cookie,
+ static void callback(lcb_http_request_t request,
+ lcb_t instance,
+ const void *cookie,
lcb_error_t error,
- const lcb_http_complete_resp_t *resp)
+ const lcb_http_resp_t *resp)
{
if (error == LCB_SUCCESS) {
switch (resp->version) {
View
12 man/man3couchbase/lcb_set_http_data_callback.3couchbase.txt
@@ -28,10 +28,11 @@ Passing NULL as the callback function may be used to query the current
callback function. The lcb_http_data_callback is a function with the
following signature:
- void function(lcb_t instance,
+ void function(lcb_http_request_t request,
+ lcb_t instance,
const void* cookie,
lcb_error_t error,
- lcb_http_resp_t * resp);
+ const lcb_http_resp_t *resp);
instance is the libcouchbase instance that this response is called
from. The cookie is cookie you passed to lcb_make_http_request.
@@ -51,7 +52,7 @@ lcb_http_resp_t is a structure defined in <libcouchbase/arguments.h>:
lcb_size_t nbytes; /* The number of bytes in the content */
} v0;
} v;
- } lcb_http_data_resp_t;
+ } lcb_http_resp_t;
The callback function will be called for each chunk received. When all
@@ -82,9 +83,10 @@ Example 2: Install custom callback
#include <libcouchbase/couchbase.h>
...
- static void callback(lcb_t instance, const void *cookie,
+ static void callback(lcb_http_request_t request,
+ lcb_t instance, const void *cookie,
lcb_error_t error,
- const lcb_http_data_resp_t *resp)
+ const lcb_http_resp_t *resp)
{
if (error == LCB_SUCCESS) {
switch (resp->version) {
View
17 man/svr4/man3couchbase/lcb_set_http_complete_callback.3couchbase
@@ -2,12 +2,12 @@
.\" Title: lcb_set_http_complete_callback
.\" Author: Trond Norbye <trond.norbye@couchbase.com>
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\" Date: 01/07/2013
+.\" Date: 03/28/2013
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
-.TH "LCB_SET_HTTP_COMPLET" "3couchbase" "01/07/2013" "\ \&" "\ \&"
+.TH "LCB_SET_HTTP_COMPLET" "3couchbase" "03/28/2013" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -44,10 +44,11 @@ The callback parameter is a the callback function to call for each http response
.RS 4
.\}
.nf
-void function(lcb_t instance,
+void function(lcb_http_request_t request,
+ lcb_t instance,
const void* cookie,
lcb_error_t error,
- lcb_http_resp_t * resp);
+ const lcb_http_resp_t *resp);
.fi
.if n \{\
.RE
@@ -71,7 +72,7 @@ typedef struct {
lcb_size_t nbytes; /* The number of bytes in the content */
} v0;
} v;
-} lcb_http_complete_resp_t;
+} lcb_http_resp_t;
.fi
.if n \{\
.RE
@@ -125,9 +126,11 @@ Example 2: Install custom callback
.\}
.nf
\&.\&.\&.
-static void callback(lcb_t instance, const void *cookie,
+static void callback(lcb_http_request_t request,
+ lcb_t instance,
+ const void *cookie,
lcb_error_t error,
- const lcb_http_complete_resp_t *resp)
+ const lcb_http_resp_t *resp)
{
if (error == LCB_SUCCESS) {
switch (resp\->version) {
View
16 man/svr4/man3couchbase/lcb_set_http_data_callback.3couchbase
@@ -2,12 +2,12 @@
.\" Title: lcb_set_http_data_callback
.\" Author: Trond Norbye <trond.norbye@couchbase.com>
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\" Date: 01/07/2013
+.\" Date: 03/28/2013
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
-.TH "LCB_SET_HTTP_DATA_CA" "3couchbase" "01/07/2013" "\ \&" "\ \&"
+.TH "LCB_SET_HTTP_DATA_CA" "3couchbase" "03/28/2013" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -46,10 +46,11 @@ Passing NULL as the callback function may be used to query the current callback
.RS 4
.\}
.nf
-void function(lcb_t instance,
+void function(lcb_http_request_t request,
+ lcb_t instance,
const void* cookie,
lcb_error_t error,
- lcb_http_resp_t * resp);
+ const lcb_http_resp_t *resp);
.fi
.if n \{\
.RE
@@ -73,7 +74,7 @@ typedef struct {
lcb_size_t nbytes; /* The number of bytes in the content */
} v0;
} v;
-} lcb_http_data_resp_t;
+} lcb_http_resp_t;
.fi
.if n \{\
.RE
@@ -129,9 +130,10 @@ Example 2: Install custom callback
.\}
.nf
\&.\&.\&.
-static void callback(lcb_t instance, const void *cookie,
+static void callback(lcb_http_request_t request,
+ lcb_t instance, const void *cookie,
lcb_error_t error,
- const lcb_http_data_resp_t *resp)
+ const lcb_http_resp_t *resp)
{
if (error == LCB_SUCCESS) {
switch (resp\->version) {

0 comments on commit 79d911f

Please sign in to comment.
Something went wrong with that request. Please try again.