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 org.jboss.netty.handler.codec.http.websocketx;
    17
    18  import org.jboss.netty.buffer.ChannelBuffer;
    19
    20  /**
    21   * Base class for web socket frames
    22   */
    23  public abstract class WebSocketFrame {
    24
    25      /**
    26       * Flag to indicate if this frame is the final fragment in a message. The first fragment (frame) may also be the
    27       * final fragment.
    28       */
    29      private boolean finalFragment = true;
    30
    31      /**
    32       * RSV1, RSV2, RSV3 used for extensions
    33       */
    34      private int rsv;
    35
    36      /**
    37       * Contents of this frame
    38       */
    39      private ChannelBuffer binaryData;
    40
    41      /**
    42       * Returns binary data
    43       */
    44      public ChannelBuffer getBinaryData() {
    45          return binaryData;
    46      }
    47
    48      /**
    49       * Sets the binary data for this frame
    50       */
    51      public void setBinaryData(ChannelBuffer binaryData) {
    52          this.binaryData = binaryData;
    53      }
    54
    55      /**
    56       * Flag to indicate if this frame is the final fragment in a message. The first fragment (frame) may also be the
    57       * final fragment.
    58       */
    59      public boolean isFinalFragment() {
    60          return finalFragment;
    61      }
    62
    63      public void setFinalFragment(boolean finalFragment) {
    64          this.finalFragment = finalFragment;
    65      }
    66
    67      /**
    68       * Bits used for extensions to the standard.
    69       */
    70      public int getRsv() {
    71          return rsv;
    72      }
    73
    74      public void setRsv(int rsv) {
    75          this.rsv = rsv;
    76      }
    77
    78  }