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)
static AndroidChannelBuilder	fromBuilder(<any> builder)
AndroidChannelBuilder	scheduledExecutorService(java.util.concurrent.ScheduledExecutorService scheduledExecutorService) Deprecated. Use #fromBuilder(ManagedChannelBuilder) with a pre-configured ManagedChannelBuilder instead.
AndroidChannelBuilder	sslSocketFactory(javax.net.ssl.SSLSocketFactory factory) Deprecated. Use #fromBuilder(ManagedChannelBuilder) with a pre-configured ManagedChannelBuilder instead.
AndroidChannelBuilder	transportExecutor(java.util.concurrent.Executor transportExecutor) Deprecated. Use #fromBuilder(ManagedChannelBuilder) with a pre-configured ManagedChannelBuilder instead.

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)

fromBuilder

public static AndroidChannelBuilder fromBuilder(<any> builder)

context

public AndroidChannelBuilder context(Context context)

Enables automatic monitoring of the device's network state.

transportExecutor

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

Deprecated. Use #fromBuilder(ManagedChannelBuilder) with a pre-configured ManagedChannelBuilder instead.

Set the delegate channel builder's transportExecutor.

sslSocketFactory

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

Deprecated. Use #fromBuilder(ManagedChannelBuilder) with a pre-configured ManagedChannelBuilder instead.

Set the delegate channel builder's sslSocketFactory.

scheduledExecutorService

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

Deprecated. Use #fromBuilder(ManagedChannelBuilder) with a pre-configured ManagedChannelBuilder instead.

Set the delegate channel builder's scheduledExecutorService.

delegate

protected <any> delegate()

build

public ManagedChannel build()