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    *   http://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 PingWebSocketFrame extends WebSocketFrame {
25  
26      /**
27       * Creates a new empty ping frame.
28       */
29      public PingWebSocketFrame() {
30          super(true, 0, Unpooled.buffer(0));
31      }
32  
33      /**
34       * Creates a new ping frame with the specified binary data.
35       *
36       * @param binaryData
37       *            the content of the frame.
38       */
39      public PingWebSocketFrame(ByteBuf binaryData) {
40          super(binaryData);
41      }
42  
43      /**
44       * Creates a new ping frame with the specified binary data
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 PingWebSocketFrame(boolean finalFragment, int rsv, ByteBuf binaryData) {
54          super(finalFragment, rsv, binaryData);
55      }
56  
57      @Override
58      public PingWebSocketFrame copy() {
59          return new PingWebSocketFrame(isFinalFragment(), rsv(), content().copy());
60      }
61  
62      @Override
63      public PingWebSocketFrame duplicate() {
64          return new PingWebSocketFrame(isFinalFragment(), rsv(), content().duplicate());
65      }
66  
67      @Override
68      public PingWebSocketFrame retain() {
69          super.retain();
70          return this;
71      }
72  
73      @Override
74      public PingWebSocketFrame retain(int increment) {
75          super.retain(increment);
76          return this;
77      }
78  }