]> granicus.if.org Git - curl/commitdiff
http2: curl_pushheader_byname now takes a const char *
authorDaniel Stenberg <daniel@haxx.se>
Tue, 2 Jun 2015 09:50:00 +0000 (11:50 +0200)
committerDaniel Stenberg <daniel@haxx.se>
Wed, 24 Jun 2015 21:44:42 +0000 (23:44 +0200)
docs/libcurl/opts/CURLMOPT_PUSHFUNCTION.3
include/curl/multi.h
lib/http2.c

index 0e4e3326e204bc2c5bf9f9cc0307c6e7060a80e4..3d87e2344aff873cb2d1f869d293c05f7e4c589d 100644 (file)
 .\"
 .TH CURLMOPT_PUSHFUNCTION 3 "1 Jun 2015" "libcurl 7.44.0" "curl_multi_setopt options"
 .SH NAME
-CURLMOPT_PUSHFUNCTION \- approve or deny server pushes
+CURLMOPT_PUSHFUNCTION \- callback that approves or denies server pushes
 .SH SYNOPSIS
 .nf
 #include <curl/curl.h>
 
 char *curl_pushheader_bynum(push_headers, int num);
-char *curl_pushheader_byname(push_headers, char *name);
+char *curl_pushheader_byname(push_headers, const char *name);
 
 int curl_push_callback(CURL *parent,
                        CURL *easy,
@@ -46,13 +46,13 @@ pushes will be denied automatically.
 .SH CALLBACK DESCRIPTION
 The callback gets its arguments like this:
 
-\fIeasy\fP is a newly created handle that represents this new transfer.
-
 \fIparent\fP is the handle of the stream on which this push arrives. The new
 handle has been duphandle()d from the parent, meaning that it has gotten all
 its options inherited. It is then up to the application to alter any options
 if desired.
 
+\fIeasy\fP is a newly created handle that represents this upcoming transfer.
+
 \fInum_headers\fP is the number of name+value pairs that was received and can
 be accessed
 
@@ -71,12 +71,13 @@ functions. These functions can only be used from within this callback and they
 can only access the PUSH_PROMISE headers. The normal response headers will be
 pased to the header callback for pushed streams just as for normal streams.
 .IP curl_pushheader_bynum
-Returns the header at index 'num' (or NULL). The returned pointer points
-to a "name:value" string that will be freed when this callback returns.
+Returns the header at index 'num' (or NULL). The returned pointer points to a
+"name:value" string that will be freed when this callback returns.
 .IP curl_pushheader_byname
 Returns the value for the given header name (or NULL). This is a shortcut so
 that the application doesn't have to loop through all headers to find the one
-it is interested in.
+it is interested in. The data pointed will be freed when this callback
+returns.
 .SH CALLBACK RETURN VALUE
 .IP "CURL_PUSH_OK (0)"
 The application has accepted the stream and it can now start receiving data,
index b2670e2547e6b2abf22bf84c456d27e2c96382bc..d34694c4c62f9c08b61cbb356c30028d817c8f15 100644 (file)
@@ -298,9 +298,8 @@ struct curl_pushheaders;  /* forward declaration only */
 
 CURL_EXTERN char *curl_pushheader_bynum(struct curl_pushheaders *h,
                                         size_t num);
-
 CURL_EXTERN char *curl_pushheader_byname(struct curl_pushheaders *h,
-                                         char *name);
+                                         const char *name);
 
 typedef int (*curl_push_callback)(CURL *parent,
                                   CURL *easy,
index 5587b3d2b6a71331d1f6a8ec07c6cbd37e12d3b8..4eae850c66999817d0fbd65a478642e6950011c4 100644 (file)
@@ -236,7 +236,7 @@ char *curl_pushheader_bynum(struct curl_pushheaders *h, size_t num)
 /*
  * push header access function. Only to be used from within the push callback
  */
-char *curl_pushheader_byname(struct curl_pushheaders *h, char *header)
+char *curl_pushheader_byname(struct curl_pushheaders *h, const char *header)
 {
   /* Verify that we got a good easy handle in the push header struct, mostly to
      detect rubbish input fast(er). */