org.wso2.transport.http.netty.contract

Interface HttpClientConnector

All Known Implementing Classes:

DefaultHttpClientConnector

public interface HttpClientConnector

Allows to send outbound messages.

Method Summary

Modifier and Type	Method and Description
boolean	close() Close the connection related to this connector.
HttpResponseFuture	connect() Creates the connection to the back-end.
HttpResponseFuture	getNextPushPromise(ResponseHandle responseHandle) Gets the next available Http2PushPromise related to the ResponseHandle in asynchronous manner.
HttpResponseFuture	getPushResponse(Http2PushPromise pushPromise) Gets the push response in asynchronous manner.
HttpResponseFuture	getResponse(ResponseHandle responseHandle) Fetches the response related to the ResponseHandle in asynchronous manner.
HttpResponseFuture	hasPushPromise(ResponseHandle responseHandle) Checks whether a Http2PushPromise exists in asynchronous manner.
void	rejectPushResponse(Http2PushPromise pushPromise) Rejects a server push response which is expected to receive over a promised stream.
HttpResponseFuture	send(HttpCarbonMessage httpCarbonMessage) Send httpMessages to the back-end in asynchronous manner.

Method Detail

connect

HttpResponseFuture connect()

Creates the connection to the back-end.

Returns:

the future that can be used to get future events of the connection.

send

HttpResponseFuture send(HttpCarbonMessage httpCarbonMessage)

Send httpMessages to the back-end in asynchronous manner.

Parameters:

httpCarbonMessage - HttpCarbonMessage which should be sent to the remote server.

Returns:

the status of the asynchronous send action.

close

boolean close()

Close the connection related to this connector.

Returns:

return the status of the close action.

getResponse

HttpResponseFuture getResponse(ResponseHandle responseHandle)

Fetches the response related to the ResponseHandle in asynchronous manner.

Parameters:

responseHandle - the Response Handle which represent the asynchronous service invocation

Returns:

the status of the asynchronous response fetch action

getNextPushPromise

HttpResponseFuture getNextPushPromise(ResponseHandle responseHandle)

Gets the next available Http2PushPromise related to the ResponseHandle in asynchronous manner.

Parameters:

responseHandle - the Response Handle which represent the asynchronous service invocation

Returns:

the status of the asynchronous push promise fetch action

hasPushPromise

HttpResponseFuture hasPushPromise(ResponseHandle responseHandle)

Checks whether a Http2PushPromise exists in asynchronous manner.

Parameters:

responseHandle - the Response Handle which represent the asynchronous service invocation

Returns:

the status of the asynchronous push promise check action

rejectPushResponse

void rejectPushResponse(Http2PushPromise pushPromise)

Rejects a server push response which is expected to receive over a promised stream. This method will do the best to prevent receiving a server push which is promised by a particular PUSH_PROMISE frame. This basically sends a RST_STREAM referring the promised stream to reject the server push message. However invoking this does not guarantee that the server will not start sending the push message. As per the spec, server is allowed to start sending the push response without waiting for an acknowledgement from the client.

Parameters:

pushPromise - push promise related to the server push which is need to be rejected

getPushResponse

HttpResponseFuture getPushResponse(Http2PushPromise pushPromise)

Gets the push response in asynchronous manner.

Parameters:

pushPromise - push promise related to the server push

Returns:

returns the status of the asynchronous push response fetch action