• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright 2015 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.netty;
18 
19 import io.grpc.Internal;
20 import io.netty.channel.ChannelHandler;
21 import io.netty.util.AsciiString;
22 
23 /**
24  * A class that provides a Netty handler to control protocol negotiation.
25  */
26 @Internal
27 public interface ProtocolNegotiator {
28 
29   /**
30    * The Netty handler to control the protocol negotiation.
31    */
32   interface Handler extends ChannelHandler {
33     /**
34      * The HTTP/2 scheme to be used when sending {@code HEADERS}.
35      */
scheme()36     AsciiString scheme();
37   }
38 
39   /**
40    * Creates a new handler to control the protocol negotiation. Once the negotiation has completed
41    * successfully, the provided handler is installed. Must call {@code
42    * grpcHandler.onHandleProtocolNegotiationCompleted()} at certain point if the negotiation has
43    * completed successfully.
44    */
newHandler(GrpcHttp2ConnectionHandler grpcHandler)45   Handler newHandler(GrpcHttp2ConnectionHandler grpcHandler);
46 }
47