Blame view

3rdparty/curl/share/man/man3/CURLMOPT_PUSHDATA.3 2.63 KB
a86c63ca   Hu Chunming   提交三方库文件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
  .\" **************************************************************************
  .\" *                                  _   _ ____  _
  .\" *  Project                     ___| | | |  _ \| |
  .\" *                             / __| | | | |_) | |
  .\" *                            | (__| |_| |  _ <| |___
  .\" *                             \___|\___/|_| \_\_____|
  .\" *
  .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
  .\" *
  .\" * This software is licensed as described in the file COPYING, which
  .\" * you should have received as part of this distribution. The terms
  .\" * are also available at https://curl.se/docs/copyright.html.
  .\" *
  .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  .\" * copies of the Software, and permit persons to whom the Software is
  .\" * furnished to do so, under the terms of the COPYING file.
  .\" *
  .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  .\" * KIND, either express or implied.
  .\" *
  .\" **************************************************************************
  .\"
  .TH CURLMOPT_PUSHDATA 3 "November 04, 2020" "libcurl 7.77.0" "curl_multi_setopt options"
  
  .SH NAME
  CURLMOPT_PUSHDATA \- pointer to pass to push callback
  .SH SYNOPSIS
  .nf
  #include <curl/curl.h>
  
  CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_PUSHDATA, void *pointer);
  .fi
  .SH DESCRIPTION
  Set \fIpointer\fP to pass as the last argument to the
  \fICURLMOPT_PUSHFUNCTION(3)\fP callback. The pointer will not be touched or
  used by libcurl itself, only passed on to the callback function.
  .SH DEFAULT
  NULL
  .SH PROTOCOLS
  HTTP(S)
  .SH EXAMPLE
  .nf
  /* only allow pushes for file names starting with "push-" */
  int push_callback(CURL *parent,
                    CURL *easy,
                    size_t num_headers,
                    struct curl_pushheaders *headers,
                    void *userp)
  {
    char *headp;
    int *transfers = (int *)userp;
    FILE *out;
    headp = curl_pushheader_byname(headers, ":path");
    if(headp && !strncmp(headp, "/push-", 6)) {
      fprintf(stderr, "The PATH is %s\\n", headp);
  
      /* save the push here */
      out = fopen("pushed-stream", "wb");
  
      /* write to this file */
      curl_easy_setopt(easy, CURLOPT_WRITEDATA, out);
  
      (*transfers)++; /* one more */
  
      return CURL_PUSH_OK;
    }
    return CURL_PUSH_DENY;
  }
  
  curl_multi_setopt(multi, CURLMOPT_PUSHFUNCTION, push_callback);
  curl_multi_setopt(multi, CURLMOPT_PUSHDATA, &counter);
  .fi
  .SH AVAILABILITY
  Added in 7.44.0
  .SH RETURN VALUE
  Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
  .SH "SEE ALSO"
  .BR CURLMOPT_PUSHFUNCTION "(3), " CURLMOPT_PIPELINING "(3), "
  .BR CURLOPT_PIPEWAIT "(3), "
  .BR RFC 7540