Home | History | Annotate | Download | only in network 
      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;
     34 
     35 import java.util.Set;
     36 
     37 /**
     38  *  This is the connection back to a client that is being
     39  *  hosted in a server instance.
     40  *
     41  *  @version   $Revision: 7485 $
     42  *  @author    Paul Speed
     43  */
     44 public interface HostedConnection extends MessageConnection
     45 {
     46     /**
     47      *  Returns the Server instance that is hosting this connection.
     48      */
     49     public Server getServer();
     50 
     51     /**
     52      *  Returns the server-unique ID for this client.
     53      */
     54     public int getId();
     55 
     56     /**
     57      *  Returns the transport specific remote address of this connection
     58      *  as a string.  This may or may not be unique per connection depending
     59      *  on the type of transport.  It is provided for information and filtering
     60      *  purposes.
     61      */
     62     public String getAddress();
     63 
     64     /**
     65      *  Closes and removes this connection from the server
     66      *  sending the optional reason to the remote client.
     67      */
     68     public void close( String reason );
     69 
     70     /**
     71      *  Sets a session attribute specific to this connection.  If the value
     72      *  is set to null then the attribute is removed.
     73      *
     74      *  @return The previous session value for this key or null
     75      *          if there was no previous value.
     76      */
     77     public Object setAttribute( String name, Object value );
     78 
     79     /**
     80      *  Retrieves a previosly stored session attribute or
     81      *  null if no such attribute exists.
     82      */
     83     public <T> T getAttribute( String name );
     84 
     85     /**
     86      *  Returns a read-only set of attribute names currently stored
     87      *  for this client session.
     88      */
     89     public Set<String> attributeNames();
     90 }
     91