HttpResponseFuture (WSO2 Transport HTTP Netty Component 6.3.35 API)

All Known Implementing Classes:

DefaultHttpResponseFuture
```
public interface HttpResponseFuture
```
Represents the future events and results of connectors.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`OperationStatus`	`getStatus()` Reruns the status of the future.
`void`	`notifyHttpListener(HttpCarbonMessage httpMessage)` Notifies the http message listener when there is an event.
`void`	`notifyHttpListener(Throwable throwable)` Notifies the listener when there is an event.
`void`	`notifyPromiseAvailability()` Notifies the promise listener when there is an event.
`void`	`notifyPushPromise()` Notifies the push promise listener when there is an event.
`void`	`notifyPushResponse(int streamId, HttpCarbonMessage pushResponse)` Notifies push response listener when there is a push response.
`void`	`notifyPushResponse(int streamId, Throwable throwable)` Notifies the Push Response Listener when there is an error.
`void`	`notifyResponseHandle(ResponseHandle responseHandle)` Notifies the response handle listener when there is an event.
`void`	`notifyResponseHandle(Throwable throwable)` Notifies the response handle listener when there is an error.
`void`	`removeHttpListener()` Removes the message listener set to the future.
`void`	`removePromiseAvailabilityListener()` Removes the promise availability listener.
`void`	`removePushPromiseListener()` Removes the push promise listener set to the future.
`void`	`removePushResponseListener(int promisedId)` Removes the Push Response listener.
`void`	`removeResponseHandleListener()` Removes the handle listener set to the future.
`void`	`resetStatus()` Reset the states associated with the future.
`void`	`setBackPressureHandler(BackPressureHandler backPressureHandler)` Sets back pressure handler.
`void`	`setHttpConnectorListener(HttpConnectorListener connectorListener)` Sets listener for the connector future.
`void`	`setPromiseAvailabilityListener(HttpClientConnectorListener promiseAvailabilityListener)` Sets the listener for the promise availability future.
`void`	`setPushPromiseListener(HttpConnectorListener pushPromiseListener)` Sets listener for the push promise future.
`void`	`setPushResponseListener(HttpConnectorListener pushResponseListener, int promiseId)` Sets the Push Response listener.
`void`	`setResponseHandleListener(HttpClientConnectorListener responseHandleListener)` Sets response handle listener.
`HttpResponseFuture`	`sync()` Makes the async operation sync.

- Method Detail
  - setHttpConnectorListener
```
void setHttpConnectorListener(HttpConnectorListener connectorListener)
```
    Sets listener for the connector future.
    
    Parameters:
    
    connectorListener - the listener that receive http message events related to the connector
  - removeHttpListener
```
void removeHttpListener()
```
    Removes the message listener set to the future.
  - notifyHttpListener
```
void notifyHttpListener(HttpCarbonMessage httpMessage)
```
    Notifies the http message listener when there is an event.
    
    Parameters:
    
    httpMessage - the entity which contains the data related to the event
  - notifyHttpListener
```
void notifyHttpListener(Throwable throwable)
```
    Notifies the listener when there is an event.
    
    Parameters:
    
    throwable - the entity which contains the data related to the error
  - getStatus
```
OperationStatus getStatus()
```
    Reruns the status of the future.
    
    Returns:
    
    the status of the HttpResponseFuture
  - resetStatus
```
void resetStatus()
```
    Reset the states associated with the future. Status need to be reset if we are to reuse the future for more than once with sync operation.
  - setBackPressureHandler
```
void setBackPressureHandler(BackPressureHandler backPressureHandler)
```
    Sets back pressure handler.
    
    Parameters:
    
    backPressureHandler - which handles backpressure
  - sync
```
HttpResponseFuture sync()
                 throws InterruptedException
```
    Makes the async operation sync.
    
    Returns:
    
    Status future
    
    Throws:
    
    InterruptedException - if the connection is interrupted
  - setResponseHandleListener
```
void setResponseHandleListener(HttpClientConnectorListener responseHandleListener)
```
    Sets response handle listener.
    
    Parameters:
    
    responseHandleListener - the listener that receives events related to the handle
  - removeResponseHandleListener
```
void removeResponseHandleListener()
```
    Removes the handle listener set to the future.
  - notifyResponseHandle
```
void notifyResponseHandle(ResponseHandle responseHandle)
```
    Notifies the response handle listener when there is an event.
    
    Parameters:
    
    responseHandle - the entity which contains the data related to the event
  - notifyResponseHandle
```
void notifyResponseHandle(Throwable throwable)
```
    Notifies the response handle listener when there is an error.
    
    Parameters:
    
    throwable - the error related to the error
  - setPromiseAvailabilityListener
```
void setPromiseAvailabilityListener(HttpClientConnectorListener promiseAvailabilityListener)
```
    Sets the listener for the promise availability future.
    
    Parameters:
    
    promiseAvailabilityListener - the listener that receives events related to the promise availability.
  - removePromiseAvailabilityListener
```
void removePromiseAvailabilityListener()
```
    Removes the promise availability listener.
  - notifyPromiseAvailability
```
void notifyPromiseAvailability()
```
    Notifies the promise listener when there is an event.
  - setPushPromiseListener
```
void setPushPromiseListener(HttpConnectorListener pushPromiseListener)
```
    Sets listener for the push promise future.
    
    Parameters:
    
    pushPromiseListener - the listener that receives events related to the connector
  - removePushPromiseListener
```
void removePushPromiseListener()
```
    Removes the push promise listener set to the future.
  - notifyPushPromise
```
void notifyPushPromise()
```
    Notifies the push promise listener when there is an event.
  - setPushResponseListener
```
void setPushResponseListener(HttpConnectorListener pushResponseListener,
                             int promiseId)
```
    Sets the Push Response listener.
    
    Parameters:
    
    pushResponseListener - the push response listener
    
    promiseId - the promised stream id which the push response is suppose to arrive
  - removePushResponseListener
```
void removePushResponseListener(int promisedId)
```
    Removes the Push Response listener.
    
    Parameters:
    
    promisedId - the promised stream id which the push response is suppose to arrive
  - notifyPushResponse
```
void notifyPushResponse(int streamId,
                        HttpCarbonMessage pushResponse)
```
    Notifies push response listener when there is a push response.
    
    Parameters:
    
    streamId - stream id of the received push response
    
    pushResponse - push response message
  - notifyPushResponse
```
void notifyPushResponse(int streamId,
                        Throwable throwable)
```
    Notifies the Push Response Listener when there is an error.
    
    Parameters:
    
    streamId - stream id of the received or to be received push response
    
    throwable - data related to the error

Interface HttpResponseFuture

Method Summary

Method Detail

setHttpConnectorListener

removeHttpListener

notifyHttpListener

notifyHttpListener

getStatus

resetStatus

setBackPressureHandler

sync

setResponseHandleListener

removeResponseHandleListener

notifyResponseHandle

notifyResponseHandle

setPromiseAvailabilityListener

removePromiseAvailabilityListener

notifyPromiseAvailability

setPushPromiseListener

removePushPromiseListener

notifyPushPromise

setPushResponseListener

removePushResponseListener

notifyPushResponse

notifyPushResponse