io.grpc.inprocess.InProcessServerBuilder Maven / Gradle / Ivy
/*
* Copyright 2015 The gRPC Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.grpc.inprocess;
import static com.google.common.base.Preconditions.checkNotNull;
import com.google.common.base.Preconditions;
import io.grpc.ExperimentalApi;
import io.grpc.ServerStreamTracer;
import io.grpc.internal.AbstractServerImplBuilder;
import io.grpc.internal.FixedObjectPool;
import io.grpc.internal.GrpcUtil;
import io.grpc.internal.ObjectPool;
import io.grpc.internal.SharedResourcePool;
import java.io.File;
import java.util.Collections;
import java.util.List;
import java.util.UUID;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
/**
* Builder for a server that services in-process requests. Clients identify the in-process server by
* its name.
*
* The server is intended to be fully-featured, high performance, and useful in testing.
*
*
Using JUnit TestRule
* The class "GrpcServerRule" (from "grpc-java/testing") is a JUnit TestRule that
* creates a {@link InProcessServer} and a {@link io.grpc.ManagedChannel ManagedChannel}. This
* test rule contains the boilerplate code shown below. The classes "HelloWorldServerTest" and
* "HelloWorldClientTest" (from "grpc-java/examples") demonstrate basic usage.
*
* Usage example
* Server and client channel setup
*
* String uniqueName = InProcessServerBuilder.generateName();
* Server server = InProcessServerBuilder.forName(uniqueName)
* .directExecutor() // directExecutor is fine for unit tests
* .addService(/* your code here */)
* .build().start();
* ManagedChannel channel = InProcessChannelBuilder.forName(uniqueName)
* .directExecutor()
* .build();
*
*
* Usage in tests
* The channel can be used normally. A blocking stub example:
*
* TestServiceGrpc.TestServiceBlockingStub blockingStub =
* TestServiceGrpc.newBlockingStub(channel);
*
*/
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/1783")
public final class InProcessServerBuilder
extends AbstractServerImplBuilder {
/**
* Create a server builder that will bind with the given name.
*
* @param name the identity of the server for clients to connect to
* @return a new builder
*/
public static InProcessServerBuilder forName(String name) {
return new InProcessServerBuilder(name);
}
/**
* Always fails. Call {@link #forName} instead.
*/
public static InProcessServerBuilder forPort(int port) {
throw new UnsupportedOperationException("call forName() instead");
}
/**
* Generates a new server name that is unique each time.
*/
public static String generateName() {
return UUID.randomUUID().toString();
}
final String name;
int maxInboundMetadataSize = Integer.MAX_VALUE;
ObjectPool schedulerPool =
SharedResourcePool.forResource(GrpcUtil.TIMER_SERVICE);
private InProcessServerBuilder(String name) {
this.name = Preconditions.checkNotNull(name, "name");
// In-process transport should not record its traffic to the stats module.
// https://github.com/grpc/grpc-java/issues/2284
setStatsRecordStartedRpcs(false);
setStatsRecordFinishedRpcs(false);
// Disable handshake timeout because it is unnecessary, and can trigger Thread creation that can
// break some environments (like tests).
handshakeTimeout(Long.MAX_VALUE, TimeUnit.SECONDS);
}
/**
* 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.
*
* @return this
*
* @since 1.11.0
*/
public InProcessServerBuilder scheduledExecutorService(
ScheduledExecutorService scheduledExecutorService) {
schedulerPool = new FixedObjectPool<>(
checkNotNull(scheduledExecutorService, "scheduledExecutorService"));
return this;
}
/**
* Sets the maximum size of metadata allowed to be received. {@code Integer.MAX_VALUE} disables
* the enforcement. Defaults to no limit ({@code Integer.MAX_VALUE}).
*
*
There is potential for performance penalty when this setting is enabled, as the Metadata
* must actually be serialized. Since the current implementation of Metadata pre-serializes, it's
* currently negligible. But Metadata is free to change its implementation.
*
* @param bytes the maximum size of received metadata
* @return this
* @throws IllegalArgumentException if bytes is non-positive
* @since 1.17.0
*/
@Override
public InProcessServerBuilder maxInboundMetadataSize(int bytes) {
Preconditions.checkArgument(bytes > 0, "maxInboundMetadataSize must be > 0");
this.maxInboundMetadataSize = bytes;
return this;
}
@Override
protected List buildTransportServers(
List streamTracerFactories) {
return Collections.singletonList(new InProcessServer(this, streamTracerFactories));
}
@Override
public InProcessServerBuilder useTransportSecurity(File certChain, File privateKey) {
throw new UnsupportedOperationException("TLS not supported in InProcessServer");
}
}