io.grpc.transport

Interface ClientTransport

All Known Implementing Classes:

OkHttpClientTransport

public interface ClientTransport

The client-side transport encapsulating a single connection to a remote server. Allows creation of new Stream instances for communication with the server.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ClientTransport.Listener Receives notifications for the transport life-cycle events.

Method Summary

Modifier and Type	Method and Description
ClientStream	newStream(MethodDescriptor<?,?> method, Metadata.Headers headers, ClientStreamListener listener) Creates a new stream for sending messages to the remote end-point.
void	shutdown() Initiates an orderly shutdown of the transport.
void	start(ClientTransport.Listener listener) Starts transport.

Method Detail

newStream

ClientStream newStream(MethodDescriptor<?,?> method,
                       Metadata.Headers headers,
                       ClientStreamListener listener)

Creates a new stream for sending messages to the remote end-point.

This method returns immediately and does not wait for any validation of the request. If creation fails for any reason, ClientStreamListener.closed(io.grpc.Status, io.grpc.Metadata.Trailers) will be called to provide the error information. Any sent messages for this stream will be buffered until creation has completed (either successfully or unsuccessfully).

Parameters:

method - the descriptor of the remote method to be called for this stream.

headers - to send at the beginning of the call

listener - the listener for the newly created stream.

Returns:

the newly created stream.

Throws:

IllegalStateException - if the service is already stopped.

start

void start(ClientTransport.Listener listener)

Starts transport. Implementations must not call listener until after start() returns.

Parameters:

listener - non-null listener of transport events

shutdown

void shutdown()

Initiates an orderly shutdown of the transport. Existing streams continue, but new streams will fail (once ClientTransport.Listener.transportShutdown() callback called).