View Javadoc
1   /*
2    * Copyright 2012 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;
17  
18  import io.netty5.buffer.api.Buffer;
19  
20  /**
21   * Web Socket frame containing binary data.
22   */
23  public class BinaryWebSocketFrame extends WebSocketFrame {
24      /**
25       * Creates a new binary frame with the specified binary data. The final fragment flag is set to true.
26       *
27       * @param binaryData the content of the frame.
28       */
29      public BinaryWebSocketFrame(Buffer binaryData) {
30          super(binaryData);
31      }
32  
33      /**
34       * Creates a new binary frame with the specified binary data and the final fragment flag.
35       *
36       * @param finalFragment flag indicating if this frame is the final fragment
37       * @param rsv reserved bits used for protocol extensions
38       * @param binaryData the content of the frame.
39       */
40      public BinaryWebSocketFrame(boolean finalFragment, int rsv, Buffer binaryData) {
41          super(finalFragment, rsv, binaryData);
42      }
43  
44      private BinaryWebSocketFrame(BinaryWebSocketFrame copyFrom, Buffer data) {
45          super(copyFrom, data);
46      }
47  
48      @Override
49      protected WebSocketFrame receive(Buffer buf) {
50          return new BinaryWebSocketFrame(this, buf);
51      }
52  }