Class ForwardingHttpJsonClientCall<RequestT,ResponseT> (2.20.1)

public abstract class ForwardingHttpJsonClientCall<RequestT,ResponseT> extends HttpJsonClientCall<RequestT,ResponseT>

A HttpJsonClientCall which forwards all of its methods to another HttpJsonClientCall.

Inheritance

java.lang.Object > HttpJsonClientCall > ForwardingHttpJsonClientCall<RequestT,ResponseT>

Inherited Members

HttpJsonClientCall.cancel(String,Throwable)

HttpJsonClientCall.halfClose()

HttpJsonClientCall.request(int)

HttpJsonClientCall.sendMessage(RequestT)

HttpJsonClientCall.start(HttpJsonClientCall.Listener<ResponseT>,HttpJsonMetadata)

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Type Parameters

Name	Description
RequestT
ResponseT

Constructors

ForwardingHttpJsonClientCall()

public ForwardingHttpJsonClientCall()

Methods

cancel(String message, Throwable cause)

public void cancel(String message, Throwable cause)

Prevent any further processing for this HttpJsonClientCall. No further messages may be sent or will be received. The server is not informed of cancellations. Cancellation is permitted even if previously #halfClosed. Cancelling an already cancel()ed ClientCall has no effect.

No other methods on this class can be called after this method has been called.

Parameters

Name	Description
message	`String`
cause	`Throwable`

Overrides

HttpJsonClientCall<RequestT,ResponseT>.cancel(String message, Throwable cause)

delegate()

protected abstract HttpJsonClientCall<RequestT,ResponseT> delegate()

Returns

Type	Description
HttpJsonClientCall<RequestT,ResponseT>

halfClose()

public void halfClose()

Close the call for request message sending. Incoming response messages are unaffected. This should be called when no more messages will be sent from the client.

Overrides

HttpJsonClientCall<RequestT,ResponseT>.halfClose()

request(int numMessages)

public void request(int numMessages)

Requests up to the given number of messages from the call to be delivered to HttpJsonClientCall.Listener#onMessage(Object). No additional messages will be delivered.

Message delivery is guaranteed to be sequential in the order received. In addition, the listener methods will not be accessed concurrently. While it is not guaranteed that the same thread will always be used, it is guaranteed that only a single thread will access the listener at a time.

If called multiple times, the number of messages able to delivered will be the sum of the calls.

This method is safe to call from multiple threads without external synchronization.

Parameter

Name	Description
numMessages	`int`

Overrides

HttpJsonClientCall<RequestT,ResponseT>.request(int numMessages)

sendMessage(RequestT message)

public void sendMessage(RequestT message)

Send a request message to the server. May be called zero or more times but for unary and server streaming calls it must be called not more than once.

Parameter

Name	Description
message	`RequestT`

Overrides

HttpJsonClientCall<RequestT,ResponseT>.sendMessage(RequestT message)

start(HttpJsonClientCall.Listener<ResponseT> responseListener, HttpJsonMetadata requestHeaders)

public void start(HttpJsonClientCall.Listener<ResponseT> responseListener, HttpJsonMetadata requestHeaders)

Start a call, using responseListener for processing response messages.

It must be called prior to any other method on this class, except for #cancel which may be called at any time.

Parameters

Name	Description
responseListener	`Listener<ResponseT>`
requestHeaders	`HttpJsonMetadata`

Overrides

HttpJsonClientCall<RequestT,ResponseT>.start(HttpJsonClientCall.Listener<ResponseT> responseListener, HttpJsonMetadata requestHeaders)