1 package com.ericsson.research.transport;
2
3 /*
4 * ##_BEGIN_LICENSE_##
5 * Transport Abstraction Package (trap)
6 * ----------
7 * Copyright (C) 2014 Ericsson AB
8 * ----------
9 * Redistribution and use in source and binary forms, with or without modification,
10 * are permitted provided that the following conditions are met:
11 *
12 * 1. Redistributions of source code must retain the above copyright notice, this
13 * list of conditions and the following disclaimer.
14 *
15 * 2. Redistributions in binary form must reproduce the above copyright notice,
16 * this list of conditions and the following disclaimer in the documentation
17 * and/or other materials provided with the distribution.
18 *
19 * 3. Neither the name of the Ericsson AB nor the names of its contributors
20 * may be used to endorse or promote products derived from this software without
21 * specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
25 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26 * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
27 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
31 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
32 * OF THE POSSIBILITY OF SUCH DAMAGE.
33 * ##_END_LICENSE_##
34 */
35
36 import java.nio.channels.SelectionKey;
37
38 // All functions in a NioEndpoint will be called from the main NioManager run loop, thus must execute and return fast.
39 public interface NioEndpoint
40 {
41
42 /**
43 * Create a child that can be used for accepting.
44 * @return A newly created NioEndpoint object capable of processing replies from this NioManager
45 * @throws UnsupportedOperationException if this NioEndpoint canAccept() returns false
46 */
47 NioEndpoint createAcceptChild();
48
49 // Connect a NioEndpoint with a NioManager. The SelectionKey should be treated as opaque.
50 void setNioManager(NioManager nioManager, SelectionKey key);
51 SelectionKey getKey();
52
53 // Incoming data
54 void receive(byte[] data, int size);
55
56 // Asynchronous feedback.
57 void notifyAccepted(NioEndpoint endpoint);
58 void notifyConnected();
59 void notifyClosed();
60 void notifyError(Exception e);
61
62 boolean canAccept();
63
64 }