/* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef __MOD_HTTP2_H__
#define __MOD_HTTP2_H__
/** The http2_var_lookup() optional function retrieves HTTP2 environment
* variables. */
APR_DECLARE_OPTIONAL_FN(char *,
http2_var_lookup, (apr_pool_t *, server_rec *,
conn_rec *, request_rec *, char *));
/** An optional function which returns non-zero if the given connection
* or its master connection is using HTTP/2. */
APR_DECLARE_OPTIONAL_FN(int,
http2_is_h2, (conn_rec *));
APR_DECLARE_OPTIONAL_FN(void,
http2_get_num_workers, (server_rec *s,
int *minw, int *max));
#define AP_HTTP2_HAS_GET_POLLFD
/**
* Get a apr_pollfd_t populated for a h2 connection where
* (c->master != NULL) is true and pipes are supported.
* To be used in Apache modules implementing WebSockets in Apache httpd
* versions that do not support the corresponding `ap_get_pollfd_from_conn()`
* function.
* When available, use `ap_get_pollfd_from_conn()` instead of this function.
*
* How it works: pass in a `apr_pollfd_t` which gets populated for
* monitoring the input of connection `c`. If `c` is not a HTTP/2
* stream connection, the function will return `APR_ENOTIMPL`.
* `ptimeout` is optional and, if passed, will get the timeout in effect
*
* On platforms without support for pipes (e.g. Windows), this function
* will return `APR_ENOTIMPL`.
*/
APR_DECLARE_OPTIONAL_FN(apr_status_t,
http2_get_pollfd_from_conn,
(conn_rec *c, struct apr_pollfd_t *pfd,
apr_interval_time_t *ptimeout));
/*******************************************************************************
* START HTTP/2 request engines (DEPRECATED)
******************************************************************************/
/* The following functions were introduced for the experimental mod_proxy_http2
* support, but have been abandoned since.
* They are still declared here for backward compatibility, in case someone
* tries to build an old mod_proxy_http2 against it, but will disappear
* completely sometime in the future.
*/
struct apr_thread_cond_t;
typedef struct h2_req_engine h2_req_engine;
typedef void http2_output_consumed(void *ctx, conn_rec *c, apr_off_t consumed);
typedef apr_status_t http2_req_engine_init(h2_req_engine *engine,
const char *id,
const char *type,
apr_pool_t *pool,
apr_size_t req_buffer_size,
request_rec *r,
http2_output_consumed **pconsumed,
void **pbaton);
APR_DECLARE_OPTIONAL_FN(apr_status_t,
http2_req_engine_push, (const char *engine_type,
request_rec *r,
http2_req_engine_init *einit));
APR_DECLARE_OPTIONAL_FN(apr_status_t,
http2_req_engine_pull, (h2_req_engine *engine,
apr_read_type_e block,
int capacity,
request_rec **pr));
APR_DECLARE_OPTIONAL_FN(void,
http2_req_engine_done, (h2_req_engine *engine,
conn_rec *rconn,
apr_status_t status));
/*******************************************************************************
* END HTTP/2 request engines (DEPRECATED)
******************************************************************************/
#endif
