1 /*
2 * Copyright 2014 The Netty Project
3 *
4 * The Netty Project licenses this file to you under the Apache License,
5 * version 2.0 (the "License"); you may not use this file except in compliance
6 * with the License. You may obtain a copy of the License at:
7 *
8 * https://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, WITHOUT
12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 * License for the specific language governing permissions and limitations
14 * under the License.
15 */
16 package io.netty5.handler.codec.http.websocketx.extensions;
17
18
19 /**
20 * Handshakes a client extension with the server.
21 */
22 public interface WebSocketClientExtensionHandshaker {
23
24 /**
25 * Return extension configuration to submit to the server.
26 *
27 * @return the desired extension configuration.
28 */
29 WebSocketExtensionData newRequestData();
30
31 /**
32 * Handshake based on server response. It should always succeed because server response
33 * should be a request acknowledge.
34 *
35 * @param extensionData
36 * the extension configuration sent by the server.
37 * @return an initialized extension if handshake phase succeed or null if failed.
38 */
39 WebSocketClientExtension handshakeExtension(WebSocketExtensionData extensionData);
40
41 }