View Javadoc
1   /*
2    * Copyright 2025 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.netty.handler.codec.http.websocketx;
17  
18  /**
19   * Allows to customize how the mask is generated that is used to mask the {@link WebSocketFrame}. Masking
20   * is only be done on the client-side.
21   */
22  public interface WebSocketFrameMaskGenerator {
23  
24      /**
25       * Return the next mask that is used to mask the payload of the {@link WebSocketFrame}.
26       *
27       * @return  mask.
28       */
29      int nextMask();
30  }