1 /* 2 * Copyright 2019 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 import io.netty5.handler.codec.http.websocketx.WebSocketFrame; 19 20 /** 21 * Filter that is responsible to skip the evaluation of a certain extension 22 * according to standard. 23 */ 24 public interface WebSocketExtensionFilter { 25 26 /** 27 * A {@link WebSocketExtensionFilter} that never skip the evaluation of an 28 * any given extensions {@link WebSocketExtension}. 29 */ 30 WebSocketExtensionFilter NEVER_SKIP = frame -> false; 31 32 /** 33 * A {@link WebSocketExtensionFilter} that always skip the evaluation of an 34 * any given extensions {@link WebSocketExtension}. 35 */ 36 WebSocketExtensionFilter ALWAYS_SKIP = frame -> true; 37 38 /** 39 * Returns {@code true} if the evaluation of the extension must skipped 40 * for the given frame otherwise {@code false}. 41 */ 42 boolean mustSkip(WebSocketFrame frame); 43 44 }