io.grpc.binder

Class BinderChannelBuilder

java.lang.Object

io.grpc.ManagedChannelBuilder<T>

io.grpc.ForwardingChannelBuilder<BinderChannelBuilder>

io.grpc.binder.BinderChannelBuilder

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/8022")
public final class BinderChannelBuilder
extends io.grpc.ForwardingChannelBuilder<BinderChannelBuilder>

Builder for a gRPC channel which communicates with an Android bound service.

See Also:

Bound Services

Method Summary

Modifier and Type	Method and Description
protected io.grpc.ManagedChannelBuilder<?>	delegate()
static BinderChannelBuilder	forAddress(AndroidComponentAddress directAddress, android.content.Context sourceContext) Creates a channel builder that will bind to a remote Android service.
static BinderChannelBuilder	forAddress(java.lang.String name, int port) Always fails.
static BinderChannelBuilder	forTarget(java.lang.String target) Always fails.
static BinderChannelBuilder	forTarget(java.lang.String target, android.content.Context sourceContext) Creates a channel builder that will bind to a remote Android service, via a string target name which will be resolved.
BinderChannelBuilder	inboundParcelablePolicy(InboundParcelablePolicy inboundParcelablePolicy) Sets the policy for inbound parcelable objects.
BinderChannelBuilder	mainThreadExecutor(java.util.concurrent.Executor mainThreadExecutor) Provides a custom Executor for accessing this application's main thread.
BinderChannelBuilder	scheduledExecutorService(java.util.concurrent.ScheduledExecutorService scheduledExecutorService) Provides a custom scheduled executor service.
BinderChannelBuilder	securityPolicy(SecurityPolicy securityPolicy) Provides a custom security policy.
BinderChannelBuilder	setBindServiceFlags(BindServiceFlags bindServiceFlags) Specifies certain optional aspects of the underlying Android Service binding.

Methods inherited from class io.grpc.ForwardingChannelBuilder

build, 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

forAddress

public static BinderChannelBuilder forAddress(AndroidComponentAddress directAddress,
                                              android.content.Context sourceContext)

Creates a channel builder that will bind to a remote Android service.

The underlying Android binding will be torn down when the channel becomes idle. This happens after 30 minutes without use by default but can be configured via ManagedChannelBuilder.idleTimeout(long, TimeUnit) or triggered manually with ManagedChannel.enterIdle().

You the caller are responsible for managing the lifecycle of any channels built by the resulting builder. They will not be shut down automatically.

Parameters:

directAddress - the AndroidComponentAddress referencing the service to bind to.

sourceContext - the context to bind from (e.g. The current Activity or Application).

Returns:

a new builder

forTarget

public static BinderChannelBuilder forTarget(java.lang.String target,
                                             android.content.Context sourceContext)

Creates a channel builder that will bind to a remote Android service, via a string target name which will be resolved.

The underlying Android binding will be torn down when the channel becomes idle. This happens after 30 minutes without use by default but can be configured via ManagedChannelBuilder.idleTimeout(long, TimeUnit) or triggered manually with ManagedChannel.enterIdle().

You the caller are responsible for managing the lifecycle of any channels built by the resulting builder. They will not be shut down automatically.

Parameters:

target - A target uri which should resolve into an AndroidComponentAddress referencing the service to bind to.

sourceContext - the context to bind from (e.g. The current Activity or Application).

Returns:

a new builder

forAddress

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

Always fails. Call forAddress(AndroidComponentAddress, Context) instead.

forTarget

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

Always fails. Call forAddress(AndroidComponentAddress, Context) instead.

delegate

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

Specified by:

delegate in class io.grpc.ForwardingChannelBuilder<BinderChannelBuilder>

setBindServiceFlags

public BinderChannelBuilder setBindServiceFlags(BindServiceFlags bindServiceFlags)

Specifies certain optional aspects of the underlying Android Service binding.

scheduledExecutorService

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

Provides a custom scheduled executor service.

This is an optional parameter. If the user has not provided a scheduled executor service when the channel is built, the builder will use a static cached thread pool.

Returns:

this

mainThreadExecutor

public BinderChannelBuilder mainThreadExecutor(java.util.concurrent.Executor mainThreadExecutor)

Provides a custom Executor for accessing this application's main thread.

Optional. A default implementation will be used if no custom Executor is provided.

Returns:

this

securityPolicy

public BinderChannelBuilder securityPolicy(SecurityPolicy securityPolicy)

Provides a custom security policy.

This is optional. If the user has not provided a security policy, this channel will only communicate with the same application UID.

Returns:

this

inboundParcelablePolicy

public BinderChannelBuilder inboundParcelablePolicy(InboundParcelablePolicy inboundParcelablePolicy)

Sets the policy for inbound parcelable objects.