Class InProcessServerBuilder


  • @ExperimentalApi("https://github.com/grpc/grpc-java/issues/1783")
    public final class InProcessServerBuilder
    extends ForwardingServerBuilder<InProcessServerBuilder>
    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 InProcessServer and a 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);
     
    • Method Detail

      • forName

        public static InProcessServerBuilder forName​(java.lang.String name)
        Create a server builder that will bind with the given name.
        Parameters:
        name - the identity of the server for clients to connect to
        Returns:
        a new builder
      • forAddress

        public static InProcessServerBuilder forAddress​(java.net.SocketAddress listenAddress)
        Create a server builder which listens on the given address.
        Parameters:
        listenAddress - The SocketAddress this server will listen on.
        Returns:
        a new builder
      • generateName

        public static java.lang.String generateName()
        Generates a new server name that is unique each time.
      • scheduledExecutorService

        public InProcessServerBuilder 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
        Since:
        1.11.0
      • maxInboundMetadataSize

        public InProcessServerBuilder maxInboundMetadataSize​(int bytes)
        Sets the maximum size of metadata allowed to be received. Integer.MAX_VALUE disables the enforcement. Defaults to no limit (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.

        Overrides:
        maxInboundMetadataSize in class ForwardingServerBuilder<InProcessServerBuilder>
        Parameters:
        bytes - the maximum size of received metadata
        Returns:
        this
        Throws:
        java.lang.IllegalArgumentException - if bytes is non-positive
        Since:
        1.17.0