io.grpc.transport.okhttp

Class OkHttpClientTransport

java.lang.Object

io.grpc.transport.okhttp.OkHttpClientTransport

All Implemented Interfaces:

ClientTransport

public class OkHttpClientTransport
extends Object
implements ClientTransport

A okhttp-based ClientTransport implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface io.grpc.transport.ClientTransport

ClientTransport.Listener

Field Summary

Fields

Modifier and Type	Field and Description
static ConnectionSpec	DEFAULT_CONNECTION_SPEC

Method Summary

Modifier and Type	Method and Description
io.grpc.transport.okhttp.OkHttpClientStream	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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_CONNECTION_SPEC

public static final ConnectionSpec DEFAULT_CONNECTION_SPEC

Method Detail

newStream

public io.grpc.transport.okhttp.OkHttpClientStream newStream(MethodDescriptor<?,?> method,
                                                             Metadata.Headers headers,
                                                             ClientStreamListener listener)

Description copied from interface: ClientTransport

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).

Specified by:

newStream in interface ClientTransport

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.

start

public void start(ClientTransport.Listener listener)

Description copied from interface: ClientTransport

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

Specified by:

start in interface ClientTransport

Parameters:

listener - non-null listener of transport events

shutdown

public void shutdown()

Description copied from interface: ClientTransport

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

Specified by:

shutdown in interface ClientTransport