io.grpc.inprocess.InProcessServerBuilder Maven / Gradle / Ivy
/*
* Copyright 2015, gRPC Authors All rights reserved.
*
* 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 com.google.common.base.Preconditions;
import io.grpc.ExperimentalApi;
import io.grpc.ServerStreamTracer;
import io.grpc.internal.AbstractServerImplBuilder;
import io.grpc.internal.GrpcUtil;
import java.io.File;
import java.util.List;
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
*
* Server server = InProcessServerBuilder.forName("unique-name")
* .directExecutor() // directExecutor is fine for unit tests
* .addService(/* your code here */)
* .build().start();
* ManagedChannel channel = InProcessChannelBuilder.forName("unique-name")
* .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");
}
private final String name;
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
setRecordStats(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);
}
@Override
protected InProcessServer buildTransportServer(
List streamTracerFactories) {
return new InProcessServer(name, GrpcUtil.TIMER_SERVICE, streamTracerFactories);
}
@Override
public InProcessServerBuilder useTransportSecurity(File certChain, File privateKey) {
throw new UnsupportedOperationException("TLS not supported in InProcessServer");
}
}