io.grpc.android

Class AndroidChannelBuilder

java.lang.Object

io.grpc.ManagedChannelBuilder<T>

io.grpc.ForwardingChannelBuilder<AndroidChannelBuilder>

io.grpc.android.AndroidChannelBuilder

public final class AndroidChannelBuilder
extends io.grpc.ForwardingChannelBuilder<AndroidChannelBuilder>

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
io.grpc.ManagedChannel	build() Builds a channel with current configurations.
AndroidChannelBuilder	context(android.content.Context context) Enables automatic monitoring of the device's network state.
protected io.grpc.ManagedChannelBuilder<?>	delegate()
static AndroidChannelBuilder	forAddress(java.lang.String name, int port) Creates a new builder with the given host and port.
static AndroidChannelBuilder	forTarget(java.lang.String target) Creates a new builder with the given target string that will be resolved by NameResolver.
static AndroidChannelBuilder	fromBuilder(io.grpc.ManagedChannelBuilder<?> builder) Deprecated. Use usingBuilder(ManagedChannelBuilder) instead.
static AndroidChannelBuilder	usingBuilder(io.grpc.ManagedChannelBuilder<?> builder) Creates a new builder, which delegates to the given ManagedChannelBuilder.

Methods inherited from class io.grpc.ForwardingChannelBuilder

compressorRegistry, decompressorRegistry, defaultLoadBalancingPolicy, defaultServiceConfig, directExecutor, disableRetry, disableServiceConfigLookUp, enableFullStreamDecompression, enableRetry, executor, idleTimeout, intercept, intercept, keepAliveTime, keepAliveTimeout, keepAliveWithoutCalls, maxHedgedAttempts, maxInboundMessageSize, maxInboundMetadataSize, maxRetryAttempts, maxTraceEvents, nameResolverFactory, offloadExecutor, overrideAuthority, perRpcBufferLimit, proxyDetector, retryBufferSize, setBinaryLog, thisT, toString, usePlaintext, userAgent, useTransportSecurity

Methods inherited from class java.lang.Object

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

Method Detail

forTarget

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

Creates a new builder with the given target string that will be resolved by NameResolver.

forAddress

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

Creates a new builder with the given host and port.

fromBuilder

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/6043")
 @Deprecated
public static AndroidChannelBuilder fromBuilder(io.grpc.ManagedChannelBuilder<?> builder)

Deprecated. Use usingBuilder(ManagedChannelBuilder) instead.

Creates a new builder, which delegates to the given ManagedChannelBuilder.

usingBuilder

public static AndroidChannelBuilder usingBuilder(io.grpc.ManagedChannelBuilder<?> builder)

Creates a new builder, which delegates to the given ManagedChannelBuilder.

The provided builder becomes "owned" by AndroidChannelBuilder. The caller should not modify the provided builder and AndroidChannelBuilder may modify it. That implies reusing the provided builder to build another channel may result with unexpected configurations. That usage should be discouraged.

Since:

1.24.0

context

public AndroidChannelBuilder context(android.content.Context context)

Enables automatic monitoring of the device's network state.

delegate

protected io.grpc.ManagedChannelBuilder<?> delegate()

Specified by:

delegate in class io.grpc.ForwardingChannelBuilder<AndroidChannelBuilder>

build

public io.grpc.ManagedChannel build()

Builds a channel with current configurations.

Overrides:

build in class io.grpc.ForwardingChannelBuilder<AndroidChannelBuilder>