Home | History | Annotate | Download | only in kernel 
      1 /*
      2  * Copyright (c) 2011 jMonkeyEngine
      3  * All rights reserved.
      4  *
      5  * Redistribution and use in source and binary forms, with or without
      6  * modification, are permitted provided that the following conditions are
      7  * met:
      8  *
      9  * * Redistributions of source code must retain the above copyright
     10  *   notice, this list of conditions and the following disclaimer.
     11  *
     12  * * Redistributions in binary form must reproduce the above copyright
     13  *   notice, this list of conditions and the following disclaimer in the
     14  *   documentation and/or other materials provided with the distribution.
     15  *
     16  * * Neither the name of 'jMonkeyEngine' nor the names of its contributors
     17  *   may be used to endorse or promote products derived from this software
     18  *   without specific prior written permission.
     19  *
     20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
     24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
     25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
     26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
     27  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
     28  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
     29  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
     30  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     31  */
     32 
     33 package com.jme3.network.kernel;
     34 
     35 /**
     36  *  Encapsulates a received piece of data.  This is used by the Kernel
     37  *  to track incoming chunks of data.
     38  *
     39  *  @version   $Revision: 8843 $
     40  *  @author    Paul Speed
     41  */
     42 public class Envelope
     43 {
     44     private Endpoint source;
     45     private byte[] data;
     46     private boolean reliable;
     47 
     48     /**
     49      *  Creates an incoming envelope holding the data from the specified
     50      *  source.  The 'reliable' flag further indicates on which mode of
     51      *  transport the data arrrived.
     52      */
     53     public Envelope( Endpoint source, byte[] data, boolean reliable )
     54     {
     55         this.source = source;
     56         this.data = data;
     57         this.reliable = reliable;
     58     }
     59 
     60     public Endpoint getSource()
     61     {
     62         return source;
     63     }
     64 
     65     public byte[] getData()
     66     {
     67         return data;
     68     }
     69 
     70     public boolean isReliable()
     71     {
     72         return reliable;
     73     }
     74 
     75     public String toString()
     76     {
     77         return "Envelope[" + source + ", " + (reliable?"reliable":"unreliable") + ", " + data.length + "]";
     78     }
     79 }
     80