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 com.jme3.network.Filter; 36 import java.nio.ByteBuffer; 37 38 /** 39 * Defines the basic byte[] passing messaging 40 * kernel. 41 * 42 * @version $Revision: 8843 $ 43 * @author Paul Speed 44 */ 45 public interface Kernel 46 { 47 /** 48 * A marker envelope returned from read() that indicates that 49 * there are events pending. This allows a single thread to 50 * more easily process the envelopes and endpoint events. 51 */ 52 public static final Envelope EVENTS_PENDING = new Envelope( null, new byte[0], false ); 53 54 /** 55 * Initializes the kernel and starts any internal processing. 56 */ 57 public void initialize(); 58 59 /** 60 * Gracefully terminates the kernel and stops any internal 61 * daemon processing. This method will not return until all 62 * internal threads have been shut down. 63 */ 64 public void terminate() throws InterruptedException; 65 66 /** 67 * Dispatches the data to all endpoints managed by the 68 * kernel that match the specified endpoint filter.. 69 * If 'copy' is true then the implementation will copy the byte buffer 70 * before delivering it to endpoints. This allows the caller to reuse 71 * the data buffer. Though it is important that the buffer not be changed 72 * by another thread while this call is running. 73 * Only the bytes from data.position() to data.remaining() are sent. 74 */ 75 public void broadcast( Filter<? super Endpoint> filter, ByteBuffer data, boolean reliable, 76 boolean copy ); 77 78 /** 79 * Returns true if there are waiting envelopes. 80 */ 81 public boolean hasEnvelopes(); 82 83 /** 84 * Removes one envelope from the received messages queue or 85 * blocks until one is available. 86 */ 87 public Envelope read() throws InterruptedException; 88 89 /** 90 * Removes and returnsn one endpoint event from the event queue or 91 * null if there are no endpoint events. 92 */ 93 public EndpointEvent nextEvent(); 94 } 95
