The HTTP Filter API is used by components that want to process HTTP traffic. HTTP Filter components get access to HTTP requests, responses and their data as well as access to HTTP tunnel requests and data (CONNECT request). Filters can manipulate the data, delay it or halt it completely.

HTTP Filters exist in a chain and data passes down the chain of filters in one direction for requests and in the other direction for the responses. Therefore when you insert your filter into the chain, the order in which it recevies data will change depending on which direction the data is travelling.

When you insert your filter into the chain you select a priority that places it within the chain relative to other filters.

HTTP Buffers

Data that passes through the chain exists inside an HTTP buffer object. In order to facilitate performant buffer access HTTP buffers are manipulated through a set of HTTP buffer API functions. See API functions beginning with HTTPFilterBuffer and HTTPBufferHandle for more information.

HTTP Context Data

During HTTP processing your component might require access to various pieces of information about the HTTP request, response or HTTP session. This includes, among other things, data such as the user that initiated the request, client IP, server requested and HTTP headers.

The API function HTTPFilterQueryContextData can be used to retrieve this information.

HTTP Tunnels

TBD