io.grpc.binder

Class BinderServerBuilder

java.lang.Object

io.grpc.ServerBuilder<T>

io.grpc.ForwardingServerBuilder<BinderServerBuilder>

io.grpc.binder.BinderServerBuilder

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

Builder for a server that services requests from an Android Service.

Method Summary

Modifier and Type	Method and Description
io.grpc.Server	build() Builds a Server according to this builder's parameters and stores its listening IBinder in the IBinderReceiver passed to forAddress(AndroidComponentAddress, IBinderReceiver).
protected io.grpc.ServerBuilder<?>	delegate()
BinderServerBuilder	enableStats() Enable stats collection using census.
BinderServerBuilder	enableTracing() Enable tracing using census.
static BinderServerBuilder	forAddress(AndroidComponentAddress listenAddress, IBinderReceiver receiver) Creates a server builder that will listen for bindings to the specified address.
static BinderServerBuilder	forPort(int port) Always fails.
BinderServerBuilder	inboundParcelablePolicy(InboundParcelablePolicy inboundParcelablePolicy) Sets the policy for inbound parcelable objects.
BinderServerBuilder	scheduledExecutorService(java.util.concurrent.ScheduledExecutorService scheduledExecutorService) Provides a custom scheduled executor service.
BinderServerBuilder	securityPolicy(ServerSecurityPolicy securityPolicy) Provides a custom security policy.
BinderServerBuilder	useTransportSecurity(java.io.File certChain, java.io.File privateKey)

Methods inherited from class io.grpc.ForwardingServerBuilder

addService, addService, addStreamTracerFactory, addTransportFilter, callExecutor, compressorRegistry, decompressorRegistry, directExecutor, executor, fallbackHandlerRegistry, handshakeTimeout, intercept, keepAliveTime, keepAliveTimeout, maxConnectionAge, maxConnectionAgeGrace, maxConnectionIdle, maxInboundMessageSize, maxInboundMetadataSize, permitKeepAliveTime, permitKeepAliveWithoutCalls, setBinaryLog, toString, useTransportSecurity

Methods inherited from class io.grpc.ServerBuilder

addServices

Methods inherited from class java.lang.Object

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

Method Detail

forAddress

public static BinderServerBuilder forAddress(AndroidComponentAddress listenAddress,
                                             IBinderReceiver receiver)

Creates a server builder that will listen for bindings to the specified address.

The listening IBinder associated with new Servers will be stored in binderReceiver upon build(). Callers should return it from Service.onBind(Intent) when the binding intent matches listenAddress.

Parameters:

listenAddress - an Android Service and binding Intent associated with this server.

receiver - an "out param" for the new Server's listening IBinder

Returns:

a new builder

forPort

public static BinderServerBuilder forPort(int port)

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

delegate

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

Specified by:

delegate in class io.grpc.ForwardingServerBuilder<BinderServerBuilder>

enableStats

public BinderServerBuilder enableStats()

Enable stats collection using census.

enableTracing

public BinderServerBuilder enableTracing()

Enable tracing using census.

scheduledExecutorService

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

Provides a custom scheduled executor service.

It's 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

securityPolicy

public BinderServerBuilder securityPolicy(ServerSecurityPolicy securityPolicy)

Provides a custom security policy.

This is optional. If the user has not provided a security policy, the server will default to only accepting calls from the same application UID.

Returns:

this

inboundParcelablePolicy

public BinderServerBuilder inboundParcelablePolicy(InboundParcelablePolicy inboundParcelablePolicy)

Sets the policy for inbound parcelable objects.

useTransportSecurity

public BinderServerBuilder useTransportSecurity(java.io.File certChain,
                                                java.io.File privateKey)

Overrides:

useTransportSecurity in class io.grpc.ForwardingServerBuilder<BinderServerBuilder>

build

public io.grpc.Server build()

Builds a Server according to this builder's parameters and stores its listening IBinder in the IBinderReceiver passed to forAddress(AndroidComponentAddress, IBinderReceiver).

Overrides:

build in class io.grpc.ForwardingServerBuilder<BinderServerBuilder>

Returns:

the new Server