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.netty.handler.codec.http.websocketx;
17
18 import io.netty.buffer.ByteBuf;
19 import io.netty.buffer.Unpooled;
20
21 /**
22 * Web Socket frame containing binary data.
23 */
24 public class BinaryWebSocketFrame extends WebSocketFrame {
25
26 /**
27 * Creates a new empty binary frame.
28 */
29 public BinaryWebSocketFrame() {
30 super(Unpooled.buffer(0));
31 }
32
33 /**
34 * Creates a new binary frame with the specified binary data. The final fragment flag is set to true.
35 *
36 * @param binaryData
37 * the content of the frame.
38 */
39 public BinaryWebSocketFrame(ByteBuf binaryData) {
40 super(binaryData);
41 }
42
43 /**
44 * Creates a new binary frame with the specified binary data and the final fragment flag.
45 *
46 * @param finalFragment
47 * flag indicating if this frame is the final fragment
48 * @param rsv
49 * reserved bits used for protocol extensions
50 * @param binaryData
51 * the content of the frame.
52 */
53 public BinaryWebSocketFrame(boolean finalFragment, int rsv, ByteBuf binaryData) {
54 super(finalFragment, rsv, binaryData);
55 }
56
57 @Override
58 public BinaryWebSocketFrame copy() {
59 return (BinaryWebSocketFrame) super.copy();
60 }
61
62 @Override
63 public BinaryWebSocketFrame duplicate() {
64 return (BinaryWebSocketFrame) super.duplicate();
65 }
66
67 @Override
68 public BinaryWebSocketFrame retainedDuplicate() {
69 return (BinaryWebSocketFrame) super.retainedDuplicate();
70 }
71
72 @Override
73 public BinaryWebSocketFrame replace(ByteBuf content) {
74 return new BinaryWebSocketFrame(isFinalFragment(), rsv(), content);
75 }
76
77 @Override
78 public BinaryWebSocketFrame retain() {
79 super.retain();
80 return this;
81 }
82
83 @Override
84 public BinaryWebSocketFrame retain(int increment) {
85 super.retain(increment);
86 return this;
87 }
88
89 @Override
90 public BinaryWebSocketFrame touch() {
91 super.touch();
92 return this;
93 }
94
95 @Override
96 public BinaryWebSocketFrame touch(Object hint) {
97 super.touch(hint);
98 return this;
99 }
100 }