granicus.if.org Git - apache/blob - modules/http2/h2_headers.h

   1 /* Licensed to the Apache Software Foundation (ASF) under one or more
   2  * contributor license agreements.  See the NOTICE file distributed with
   3  * this work for additional information regarding copyright ownership.
   4  * The ASF licenses this file to You under the Apache License, Version 2.0
   5  * (the "License"); you may not use this file except in compliance with
   6  * the License.  You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef __mod_h2__h2_headers__
  18 #define __mod_h2__h2_headers__
  19
  20 #include "h2.h"
  21
  22 struct h2_bucket_beam;
  23
  24 extern const apr_bucket_type_t h2_bucket_type_headers;
  25
  26 #define H2_BUCKET_IS_HEADERS(e)     (e->type == &h2_bucket_type_headers)
  27
  28 apr_bucket * h2_bucket_headers_make(apr_bucket *b, h2_headers *r);
  29
  30 apr_bucket * h2_bucket_headers_create(apr_bucket_alloc_t *list,
  31                                        h2_headers *r);
  32
  33 h2_headers *h2_bucket_headers_get(apr_bucket *b);
  34
  35 apr_bucket *h2_bucket_headers_beam(struct h2_bucket_beam *beam,
  36                                     apr_bucket_brigade *dest,
  37                                     const apr_bucket *src);
  38
  39 /**
  40  * Create the headers from the given status and headers
  41  * @param status the headers status
  42  * @param header the headers of the headers
  43  * @param notes  the notes carried by the headers
  44  * @param raw_bytes the raw network bytes (if known) used to transmit these
  45  * @param pool the memory pool to use
  46  */
  47 h2_headers *h2_headers_create(int status, apr_table_t *header,
  48                               apr_table_t *notes, apr_off_t raw_bytes,
  49                               apr_pool_t *pool);
  50
  51 /**
  52  * Create the headers from the given request_rec.
  53  * @param r the request record which was processed
  54  * @param status the headers status
  55  * @param header the headers of the headers
  56  * @param pool the memory pool to use
  57  */
  58 h2_headers *h2_headers_rcreate(request_rec *r, int status,
  59                                  apr_table_t *header, apr_pool_t *pool);
  60
  61 /**
  62  * Copy the headers into another pool. This will not copy any
  63  * header strings.
  64  */
  65 h2_headers *h2_headers_copy(apr_pool_t *pool, h2_headers *h);
  66
  67 /**
  68  * Clone the headers into another pool. This will also clone any
  69  * header strings.
  70  */
  71 h2_headers *h2_headers_clone(apr_pool_t *pool, h2_headers *h);
  72
  73 /**
  74  * Create the headers for the given error.
  75  * @param type the error code
  76  * @param req the original h2_request
  77  * @param pool the memory pool to use
  78  */
  79 h2_headers *h2_headers_die(apr_status_t type,
  80                              const struct h2_request *req, apr_pool_t *pool);
  81
  82 int h2_headers_are_response(h2_headers *headers);
  83
  84 #endif /* defined(__mod_h2__h2_headers__) */