ThrottleRequestFilter (AHC/Client 3.0.0.Beta3 API)

java.lang.Object
- org.asynchttpclient.filter.ThrottleRequestFilter

All Implemented Interfaces:

RequestFilter
```
public class ThrottleRequestFilter
extends Object
implements RequestFilter
```
A RequestFilter throttles requests and block when the number of permits is reached, waiting for the response to arrives before executing the next request.

Constructor Summary

Constructors
Constructor	Description
`ThrottleRequestFilter(int maxConnections)`
`ThrottleRequestFilter(int maxConnections, int maxWait)`
`ThrottleRequestFilter(int maxConnections, int maxWait, boolean fair)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`<T> FilterContext<T>`	`filter(FilterContext<T> ctx)`	An `AsyncHttpClient` will invoke `RequestFilter.filter(org.asynchttpclient.filter.FilterContext<T>)` and will use the returned `FilterContext.getRequest()` and `FilterContext.getAsyncHandler()` to continue the request processing.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ThrottleRequestFilter
```
public ThrottleRequestFilter(int maxConnections)
```
  - ThrottleRequestFilter
```
public ThrottleRequestFilter(int maxConnections,
                             int maxWait)
```
  - ThrottleRequestFilter
```
public ThrottleRequestFilter(int maxConnections,
                             int maxWait,
                             boolean fair)
```
- Method Detail
  - filter
```
public <T> FilterContext<T> filter(FilterContext<T> ctx)
                            throws FilterException
```
    Description copied from interface: RequestFilter
    
    An AsyncHttpClient will invoke RequestFilter.filter(org.asynchttpclient.filter.FilterContext<T>) and will use the returned FilterContext.getRequest() and FilterContext.getAsyncHandler() to continue the request processing.
    
    Specified by:
    
    filter in interface RequestFilter
    
    Type Parameters:
    
    T - the handler result type
    
    Parameters:
    
    ctx - a FilterContext
    
    Returns:
    
    FilterContext. The FilterContext instance may not the same as the original one.
    
    Throws:
    
    FilterException - to interrupt the filter processing.