• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright 2016 The gRPC Authors
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package io.grpc;
18 
19 /**
20  * Provides a way to bind instance of service implementation to server.
21  *
22  * <p>It is used by service's abstract class generated by compiler (eg.:
23  * RouteGuideGrpc.RouteGuideImplBase for RouteGuide service) and lets implementation classes to be
24  * bind to server.
25  *
26  * <pre><code>
27  * class RouteGuideService extends RouteGuideGrpc.RouteGuideImplBase {
28  *   // ...
29  * }
30  *
31  * Server server = ServerBuilder.forPort(1234).addService(new RouteGuideService()).build();
32  * </code></pre></p>
33  */
34 public interface BindableService {
35   /**
36    * Creates {@link ServerServiceDefinition} object for current instance of service implementation.
37    *
38    * @return ServerServiceDefinition object.
39    */
bindService()40   ServerServiceDefinition bindService();
41 }
42