io.netty.handler.codec.http.websocketx.extensions.WebSocketClientExtensionHandshaker Maven / Gradle / Ivy
Go to download
This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including
all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and
JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up
with different versions on classes on the class path).
/*
* Copyright 2014 The Netty Project
*
* The Netty Project licenses this file to you 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:
*
* https://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.netty.handler.codec.http.websocketx.extensions;
/**
* Handshakes a client extension with the server.
*/
public interface WebSocketClientExtensionHandshaker {
/**
* Return extension configuration to submit to the server.
*
* @return the desired extension configuration.
*/
WebSocketExtensionData newRequestData();
/**
* Handshake based on server response. It should always succeed because server response
* should be a request acknowledge.
*
* @param extensionData
* the extension configuration sent by the server.
* @return an initialized extension if handshake phase succeed or null if failed.
*/
WebSocketClientExtension handshakeExtension(WebSocketExtensionData extensionData);
}