io.grpc.android

Class AndroidChannelBuilder

java.lang.Object

<any>

io.grpc.android.AndroidChannelBuilder

public final class AndroidChannelBuilder
extends <any>

Builds a ManagedChannel that, when provided with a Context, will automatically monitor the Android device's network state to smoothly handle intermittent network failures.

Currently only compatible with gRPC's OkHttp transport, which must be available at runtime.

Requires the Android ACCESS_NETWORK_STATE permission.

Since:

1.12.0

Method Summary

Modifier and Type	Method and Description
ManagedChannel	build()
AndroidChannelBuilder	context(Context context) Enables automatic monitoring of the device's network state.
protected <any>	delegate()
static AndroidChannelBuilder	forAddress(java.lang.String name, int port)
static AndroidChannelBuilder	forTarget(java.lang.String target)
AndroidChannelBuilder	scheduledExecutorService(java.util.concurrent.ScheduledExecutorService scheduledExecutorService) Set the delegate channel builder's scheduledExecutorService.
AndroidChannelBuilder	sslSocketFactory(javax.net.ssl.SSLSocketFactory factory) Set the delegate channel builder's sslSocketFactory.
AndroidChannelBuilder	transportExecutor(java.util.concurrent.Executor transportExecutor) Set the delegate channel builder's transportExecutor.

Methods inherited from class java.lang.Object

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

Method Detail

forTarget

public static final AndroidChannelBuilder forTarget(java.lang.String target)

forAddress

public static AndroidChannelBuilder forAddress(java.lang.String name,
                                               int port)

context

public AndroidChannelBuilder context(Context context)

Enables automatic monitoring of the device's network state.

transportExecutor

public AndroidChannelBuilder transportExecutor(java.util.concurrent.Executor transportExecutor)

Set the delegate channel builder's transportExecutor.

sslSocketFactory

public AndroidChannelBuilder sslSocketFactory(javax.net.ssl.SSLSocketFactory factory)

Set the delegate channel builder's sslSocketFactory.

scheduledExecutorService

public AndroidChannelBuilder scheduledExecutorService(java.util.concurrent.ScheduledExecutorService scheduledExecutorService)

Set the delegate channel builder's scheduledExecutorService.

delegate

protected <any> delegate()

build

public ManagedChannel build()