cvs commit: spice/sandbox/packet/src/java/org/realityforge/packet/encoder Encoder.java

donaldp     03/11/10 20:44:03

  Added:       sandbox/packet/src/java/org/realityforge/packet/encoder
                        Encoder.java
  Log:
  Add Encoder interface
  
  Revision  Changes    Path
  1.1                  spice/sandbox/packet/src/java/org/realityforge/packet/encoder/Encoder.java
  
  Index: Encoder.java
  ===================================================================
  /*
   * Copyright (C) The Spice Group. All rights reserved.
   *
   * This software is published under the terms of the Spice
   * Software License version 1.1, a copy of which has been included
   * with this distribution in the LICENSE.txt file.
   */
  package org.realityforge.packet.encoder;
  
  import org.realityforge.packet.Packet;
  import java.nio.ByteBuffer;
  
  /**
   * The Encoder is responsible for encoding and decoding Packets to ByteBuffers.
   *
   * @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
   * @version $Revision: 1.1 $ $Date: 2003/11/11 04:44:03 $
   */
  public interface Encoder
  {
      /**
       * Encode the packet into ByteBuffer if there is enough space.
       *
       * @param packet the packet
       * @param output the output buffer
       * @return true if packet encoded, false otherwise
       */
      boolean encode( Packet packet, ByteBuffer output );
  
      /**
       * Decode packet from ByteBuffer if enough data is present.
       *
       * @param input the input buffer
       * @return the Packet if decoded else null
       */
      Packet decode( ByteBuffer input );
  }
  
  
  


-------------------------------------------------------
This SF.Net email sponsored by: ApacheCon 2003,
16-19 November in Las Vegas. Learn firsthand the latest
developments in Apache, PHP, Perl, XML, Java, MySQL,
WebDAV, and more! http://www.apachecon.com/