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
33package com.jme3.network.kernel;
34
35import java.nio.ByteBuffer;
36
37/**
38 *  An abstract endpoint in a Kernel that can be used for
39 *  sending/receiving messages within the kernel space.
40 *
41 *  @version   $Revision: 7049 $
42 *  @author    Paul Speed
43 */
44public interface Endpoint
45{
46    /**
47     *  Returns an ID that is unique for this endpoint within its
48     *  Kernel instance.
49     */
50    public long getId();
51
52    /**
53     *  Returns the transport specific remote address of this endpoint
54     *  as a string.  This may or may not be unique per endpoint depending
55     *  on the type of transport.
56     */
57    public String getAddress();
58
59    /**
60     *  Returns the kernel to which this endpoint belongs.
61     */
62    public Kernel getKernel();
63
64    /**
65     *  Returns true if this endpoint is currently connected.
66     */
67    public boolean isConnected();
68
69    /**
70     *  Sends data to the other end of the connection represented
71     *  by this endpoint.
72     */
73    public void send( ByteBuffer data );
74
75    /**
76     *  Closes this endpoint without flushing any of its
77     *  currently enqueued outbound data.
78     */
79    public void close();
80
81    /**
82     *  Closes this endpoint, optionally flushing any queued
83     *  data before closing.  As soon as this method is called,
84     *  ne send() calls will fail with an exception... even while
85     *  close() is still flushing the earlier queued messages.
86     */
87    public void close(boolean flushData);
88}
89