All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.eclipse.jetty.websocket.api.extensions.Extension Maven / Gradle / Ivy

There is a newer version: 11.0.0.beta1
Show newest version
//
//  ========================================================================
//  Copyright (c) 1995-2015 Mort Bay Consulting Pty. Ltd.
//  ------------------------------------------------------------------------
//  All rights reserved. This program and the accompanying materials
//  are made available under the terms of the Eclipse Public License v1.0
//  and Apache License v2.0 which accompanies this distribution.
//
//      The Eclipse Public License is available at
//      http://www.eclipse.org/legal/epl-v10.html
//
//      The Apache License v2.0 is available at
//      http://www.opensource.org/licenses/apache2.0.php
//
//  You may elect to redistribute this code under either of these licenses.
//  ========================================================================
//

package org.eclipse.jetty.websocket.api.extensions;

/**
 * Interface for WebSocket Extensions.
 * 

* That {@link Frame}s are passed through the Extension via the {@link IncomingFrames} and {@link OutgoingFrames} interfaces */ public interface Extension extends IncomingFrames, OutgoingFrames { /** * The active configuration for this extension. * * @return the configuration for this extension. never null. */ public ExtensionConfig getConfig(); /** * The Sec-WebSocket-Extensions name for this extension. *

* Also known as the extension-token per Section 9.1. Negotiating Extensions. */ public String getName(); /** * Used to indicate that the extension makes use of the RSV1 bit of the base websocket framing. *

* This is used to adjust validation during parsing, as well as a checkpoint against 2 or more extensions all simultaneously claiming ownership of RSV1. * * @return true if extension uses RSV1 for its own purposes. */ public abstract boolean isRsv1User(); /** * Used to indicate that the extension makes use of the RSV2 bit of the base websocket framing. *

* This is used to adjust validation during parsing, as well as a checkpoint against 2 or more extensions all simultaneously claiming ownership of RSV2. * * @return true if extension uses RSV2 for its own purposes. */ public abstract boolean isRsv2User(); /** * Used to indicate that the extension makes use of the RSV3 bit of the base websocket framing. *

* This is used to adjust validation during parsing, as well as a checkpoint against 2 or more extensions all simultaneously claiming ownership of RSV3. * * @return true if extension uses RSV3 for its own purposes. */ public abstract boolean isRsv3User(); /** * Set the next {@link IncomingFrames} to call in the chain. * * @param nextIncoming * the next incoming extension */ public void setNextIncomingFrames(IncomingFrames nextIncoming); /** * Set the next {@link OutgoingFrames} to call in the chain. * * @param nextOutgoing * the next outgoing extension */ public void setNextOutgoingFrames(OutgoingFrames nextOutgoing); // TODO: Extension should indicate if it requires boundary of fragments to be preserved // TODO: Extension should indicate if it uses the Extension data field of frame for its own reasons. }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy