159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta/* 259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Copyright (c) 2011 jMonkeyEngine 359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * All rights reserved. 459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Redistribution and use in source and binary forms, with or without 659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * modification, are permitted provided that the following conditions are 759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * met: 859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Redistributions of source code must retain the above copyright 1059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * notice, this list of conditions and the following disclaimer. 1159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 1259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Redistributions in binary form must reproduce the above copyright 1359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * notice, this list of conditions and the following disclaimer in the 1459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * documentation and/or other materials provided with the distribution. 1559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 1659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Neither the name of 'jMonkeyEngine' nor the names of its contributors 1759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * may be used to endorse or promote products derived from this software 1859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * without specific prior written permission. 1959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 2059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 2259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 2359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 2459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 2559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 2659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 2759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 2859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 2959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 3059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 3259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 3359b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartapackage com.jme3.network; 3459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 3559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 3659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta/** 3759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Represents a remote connection to a server that can be used 3859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * for sending and receiving messages. 3959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 4059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @version $Revision: 8938 $ 4159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @author Paul Speed 4259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 4359b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartapublic interface Client extends MessageConnection 4459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta{ 4559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 4659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Starts the client allowing it to begin processing incoming 4759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * messages and delivering them to listeners. 4859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 4959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void start(); 5059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 5159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 5259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Returns true if this client is fully connected to the 5359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * host. 5459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 5559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public boolean isConnected(); 5659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 5759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 5859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Returns a unique ID for this client within the remote 5959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * server or -1 if this client isn't fully connected to the 6059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * server. 6159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 6259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public int getId(); 6359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 6459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 6559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Returns the 'game name' for servers to which this client should be able 6659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * to connect. This should match the 'game name' set on the server or this 6759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * client will be turned away. 6859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 6959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public String getGameName(); 7059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 7159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 7259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Returns the game-specific version of the server this client should 7359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * be able to connect to. 7459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 7559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public int getVersion(); 7659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 7759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 7859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Sends a message to the server. 7959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 8059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void send( Message message ); 8159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 8259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 8359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Sends a message to the other end of the connection using 8459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * the specified alternate channel. 8559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 8659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void send( int channel, Message message ); 8759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 8859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 8959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Closes this connection to the server. 9059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 9159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void close(); 9259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 9359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 9459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Adds a listener that will be notified about connection 9559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * state changes. 9659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 9759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void addClientStateListener( ClientStateListener listener ); 9859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 9959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 10059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Removes a previously registered connection listener. 10159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 10259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void removeClientStateListener( ClientStateListener listener ); 10359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 10459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 10559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Adds a listener that will be notified when any message or object 10659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * is received from the server. 10759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 10859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void addMessageListener( MessageListener<? super Client> listener ); 10959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 11059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 11159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Adds a listener that will be notified when messages of the specified 11259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * types are received. 11359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 11459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void addMessageListener( MessageListener<? super Client> listener, Class... classes ); 11559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 11659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 11759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Removes a previously registered wildcard listener. This does 11859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * not remove this listener from any type-specific registrations. 11959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 12059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void removeMessageListener( MessageListener<? super Client> listener ); 12159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 12259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 12359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Removes a previously registered type-specific listener from 12459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * the specified types. 12559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 12659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void removeMessageListener( MessageListener<? super Client> listener, Class... classes ); 12759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 12859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 12959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Adds a listener that will be notified when any connection errors 13059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * occur. If a client has no error listeners then the default behavior 13159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * is to close the connection and provide an appropriate DisconnectInfo 13259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * to any ClientStateListeners. If the application adds its own error 13359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * listeners then it must take care of closing the connection itself. 13459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 13559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void addErrorListener( ErrorListener<? super Client> listener ); 13659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 13759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 13859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Removes a previously registered error listener. 13959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 14059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void removeErrorListener( ErrorListener<? super Client> listener ); 14159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta} 14259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 14359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 144