diff options
Diffstat (limited to 'engine/src/networking/com/jme3/network/Client.java')
| -rw-r--r-- | engine/src/networking/com/jme3/network/Client.java | 143 |
1 files changed, 143 insertions, 0 deletions
diff --git a/engine/src/networking/com/jme3/network/Client.java b/engine/src/networking/com/jme3/network/Client.java new file mode 100644 index 0000000..86ee8c6 --- /dev/null +++ b/engine/src/networking/com/jme3/network/Client.java @@ -0,0 +1,143 @@ +/* + * Copyright (c) 2011 jMonkeyEngine + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * * Neither the name of 'jMonkeyEngine' nor the names of its contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED + * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR + * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +package com.jme3.network; + + +/** + * Represents a remote connection to a server that can be used + * for sending and receiving messages. + * + * @version $Revision: 8938 $ + * @author Paul Speed + */ +public interface Client extends MessageConnection +{ + /** + * Starts the client allowing it to begin processing incoming + * messages and delivering them to listeners. + */ + public void start(); + + /** + * Returns true if this client is fully connected to the + * host. + */ + public boolean isConnected(); + + /** + * Returns a unique ID for this client within the remote + * server or -1 if this client isn't fully connected to the + * server. + */ + public int getId(); + + /** + * Returns the 'game name' for servers to which this client should be able + * to connect. This should match the 'game name' set on the server or this + * client will be turned away. + */ + public String getGameName(); + + /** + * Returns the game-specific version of the server this client should + * be able to connect to. + */ + public int getVersion(); + + /** + * Sends a message to the server. + */ + public void send( Message message ); + + /** + * Sends a message to the other end of the connection using + * the specified alternate channel. + */ + public void send( int channel, Message message ); + + /** + * Closes this connection to the server. + */ + public void close(); + + /** + * Adds a listener that will be notified about connection + * state changes. + */ + public void addClientStateListener( ClientStateListener listener ); + + /** + * Removes a previously registered connection listener. + */ + public void removeClientStateListener( ClientStateListener listener ); + + /** + * Adds a listener that will be notified when any message or object + * is received from the server. + */ + public void addMessageListener( MessageListener<? super Client> listener ); + + /** + * Adds a listener that will be notified when messages of the specified + * types are received. + */ + public void addMessageListener( MessageListener<? super Client> listener, Class... classes ); + + /** + * Removes a previously registered wildcard listener. This does + * not remove this listener from any type-specific registrations. + */ + public void removeMessageListener( MessageListener<? super Client> listener ); + + /** + * Removes a previously registered type-specific listener from + * the specified types. + */ + public void removeMessageListener( MessageListener<? super Client> listener, Class... classes ); + + /** + * Adds a listener that will be notified when any connection errors + * occur. If a client has no error listeners then the default behavior + * is to close the connection and provide an appropriate DisconnectInfo + * to any ClientStateListeners. If the application adds its own error + * listeners then it must take care of closing the connection itself. + */ + public void addErrorListener( ErrorListener<? super Client> listener ); + + /** + * Removes a previously registered error listener. + */ + public void removeErrorListener( ErrorListener<? super Client> listener ); +} + + |