//
   //  ========================================================================
   //  Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd.
   //  ------------------------------------------------------------------------
   //  All rights reserved. This program and the accompanying materials
   //  are made available under the terms of the Eclipse Public License v1.0
   //  and Apache License v2.0 which accompanies this distribution.
   //
   //      The Eclipse Public License is available at
  //      http://www.eclipse.org/legal/epl-v10.html
  //
  //      The Apache License v2.0 is available at
  //      http://www.opensource.org/licenses/apache2.0.php
  //
  //  You may elect to redistribute this code under either of these licenses.
  //  ========================================================================
  //
  
  package org.eclipse.jetty.websocket.api.extensions;
  
  import java.nio.ByteBuffer;
  
  /**
   * An immutable websocket frame.
   */
  public interface Frame
  {
      public static enum Type
      {
          CONTINUATION((byte)0x00),
          TEXT((byte)0x01),
          BINARY((byte)0x02),
          CLOSE((byte)0x08),
          PING((byte)0x09),
          PONG((byte)0x0A);
  
          public static Type from(byte op)
          {
              for (Type type : values())
              {
                  if (type.opcode == op)
                  {
                      return type;
                  }
              }
              throw new IllegalArgumentException("OpCode " + op + " is not a valid Frame.Type");
          }
  
          private byte opcode;
  
          private Type(byte code)
          {
              this.opcode = code;
          }
  
          public byte getOpCode()
          {
              return opcode;
          }
  
          public boolean isControl()
          {
              return (opcode >= CLOSE.getOpCode());
          }
  
          public boolean isData()
          {
              return (opcode == TEXT.getOpCode()) | (opcode == BINARY.getOpCode());
          }
  
          @Override
          public String toString()
          {
              return this.name();
          }
      }
  
      public byte[] getMask();
  
      public byte getOpCode();
  
      public ByteBuffer getPayload();
  
      public int getPayloadLength();
  
      public int getPayloadStart();
  
      public Type getType();
  
      public boolean hasPayload();
  
      public boolean isContinuation();
  
      public boolean isFin();
  
      /**
       * Same as {@link #isFin()}
       * 
       * @return true if final frame.
      */
     public boolean isLast();
 
     public boolean isMasked();
 
     public boolean isRsv1();
 
     public boolean isRsv2();
 
     public boolean isRsv3();
 
     public int remaining();
 }