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.kernel; 3459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 3559b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.network.Filter; 3659b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport java.nio.ByteBuffer; 3759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 3859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta/** 3959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Defines the basic byte[] passing messaging 4059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * kernel. 4159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 4259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @version $Revision: 8843 $ 4359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @author Paul Speed 4459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 4559b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartapublic interface Kernel 4659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta{ 4759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 4859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * A marker envelope returned from read() that indicates that 4959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * there are events pending. This allows a single thread to 5059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * more easily process the envelopes and endpoint events. 5159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 5259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public static final Envelope EVENTS_PENDING = new Envelope( null, new byte[0], false ); 5359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 5459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 5559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Initializes the kernel and starts any internal processing. 5659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 5759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void initialize(); 5859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 5959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 6059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Gracefully terminates the kernel and stops any internal 6159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * daemon processing. This method will not return until all 6259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * internal threads have been shut down. 6359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 6459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void terminate() throws InterruptedException; 6559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 6659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 6759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Dispatches the data to all endpoints managed by the 6859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * kernel that match the specified endpoint filter.. 6959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * If 'copy' is true then the implementation will copy the byte buffer 7059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * before delivering it to endpoints. This allows the caller to reuse 7159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * the data buffer. Though it is important that the buffer not be changed 7259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * by another thread while this call is running. 7359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Only the bytes from data.position() to data.remaining() are sent. 7459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 7559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public void broadcast( Filter<? super Endpoint> filter, ByteBuffer data, boolean reliable, 7659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta boolean copy ); 7759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 7859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 7959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Returns true if there are waiting envelopes. 8059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 8159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public boolean hasEnvelopes(); 8259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 8359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 8459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Removes one envelope from the received messages queue or 8559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * blocks until one is available. 8659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 8759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public Envelope read() throws InterruptedException; 8859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 8959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 9059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Removes and returnsn one endpoint event from the event queue or 9159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * null if there are no endpoint events. 9259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 9359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public EndpointEvent nextEvent(); 9459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta} 95