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 import java.nio.ByteBuffer; 36 37 /** 38 * A single channel remote connection allowing the sending 39 * and receiving of data. As opposed to the Kernel, this will 40 * only ever receive data from one Endpoint and so bypasses 41 * the envelope wrapping. 42 * 43 * @version $Revision: 7012 $ 44 * @author Paul Speed 45 */ 46 public interface Connector 47 { 48 /** 49 * Returns true if this connector is currently connected. 50 */ isConnected()51 public boolean isConnected(); 52 53 /** 54 * Closes the connection. Any subsequent attempts to read 55 * or write will fail with an exception. 56 */ close()57 public void close(); 58 59 /** 60 * Returns true if there is currently data available for 61 * reading. Some connector implementations may not be able 62 * to answer this question accurately and will always return 63 * false. 64 */ available()65 public boolean available(); 66 67 /** 68 * Reads a chunk of data from the connection, blocking if 69 * there is no data available. The buffer may only be valid 70 * until the next read() call is made. Callers should copy 71 * the data if they need it for longer than that. 72 * 73 * @return The data read or null if there is no more data 74 * because the connection is closed. 75 */ read()76 public ByteBuffer read(); 77 78 /** 79 * Writes a chunk of data to the connection from data.position() 80 * to data.limit(). 81 */ write( ByteBuffer data )82 public void write( ByteBuffer data ); 83 } 84