header.h 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. #ifndef CURLINC_HEADER_H
  2. #define CURLINC_HEADER_H
  3. /***************************************************************************
  4. * _ _ ____ _
  5. * Project ___| | | | _ \| |
  6. * / __| | | | |_) | |
  7. * | (__| |_| | _ <| |___
  8. * \___|\___/|_| \_\_____|
  9. *
  10. * Copyright (C) Daniel Stenberg, <[email protected]>, et al.
  11. *
  12. * This software is licensed as described in the file COPYING, which
  13. * you should have received as part of this distribution. The terms
  14. * are also available at https://curl.se/docs/copyright.html.
  15. *
  16. * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  17. * copies of the Software, and permit persons to whom the Software is
  18. * furnished to do so, under the terms of the COPYING file.
  19. *
  20. * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  21. * KIND, either express or implied.
  22. *
  23. * SPDX-License-Identifier: curl
  24. *
  25. ***************************************************************************/
  26. #ifdef __cplusplus
  27. extern "C" {
  28. #endif
  29. struct curl_header {
  30. char *name; /* this might not use the same case */
  31. char *value;
  32. size_t amount; /* number of headers using this name */
  33. size_t index; /* ... of this instance, 0 or higher */
  34. unsigned int origin; /* see bits below */
  35. void *anchor; /* handle privately used by libcurl */
  36. };
  37. /* 'origin' bits */
  38. #define CURLH_HEADER (1<<0) /* plain server header */
  39. #define CURLH_TRAILER (1<<1) /* trailers */
  40. #define CURLH_CONNECT (1<<2) /* CONNECT headers */
  41. #define CURLH_1XX (1<<3) /* 1xx headers */
  42. #define CURLH_PSEUDO (1<<4) /* pseudo headers */
  43. typedef enum {
  44. CURLHE_OK,
  45. CURLHE_BADINDEX, /* header exists but not with this index */
  46. CURLHE_MISSING, /* no such header exists */
  47. CURLHE_NOHEADERS, /* no headers at all exist (yet) */
  48. CURLHE_NOREQUEST, /* no request with this number was used */
  49. CURLHE_OUT_OF_MEMORY, /* out of memory while processing */
  50. CURLHE_BAD_ARGUMENT, /* a function argument was not okay */
  51. CURLHE_NOT_BUILT_IN /* if API was disabled in the build */
  52. } CURLHcode;
  53. CURL_EXTERN CURLHcode curl_easy_header(CURL *easy,
  54. const char *name,
  55. size_t index,
  56. unsigned int origin,
  57. int request,
  58. struct curl_header **hout);
  59. CURL_EXTERN struct curl_header *curl_easy_nextheader(CURL *easy,
  60. unsigned int origin,
  61. int request,
  62. struct curl_header *prev);
  63. #ifdef __cplusplus
  64. } /* end of extern "C" */
  65. #endif
  66. #endif /* CURLINC_HEADER_H */