Commit | Line | Data |
---|---|---|
79ce1a49 NR |
1 | package be.nikiroo.utils.serial.server; |
2 | ||
3 | import java.io.IOException; | |
4 | import java.net.Socket; | |
5 | ||
6 | import be.nikiroo.utils.Version; | |
7 | ||
8 | /** | |
9 | * This class implements a simple server that can listen for connections and | |
10 | * send/receive objects. | |
11 | * <p> | |
12 | * Note: this {@link ServerObject} has to be discarded after use (cannot be | |
13 | * started twice). | |
14 | * | |
15 | * @author niki | |
16 | */ | |
17 | abstract public class ServerObject extends Server { | |
18 | /** | |
19 | * Create a new server that will start listening on the network when | |
20 | * {@link ServerObject#start()} is called. | |
21 | * | |
22 | * @param port | |
23 | * the port to listen on, or 0 to assign any unallocated port | |
24 | * found (which can later on be queried via | |
25 | * {@link ServerObject#getPort()} | |
26 | * @param ssl | |
27 | * use a SSL connection (or not) | |
28 | * | |
29 | * @throws IOException | |
30 | * in case of I/O error | |
31 | */ | |
32 | public ServerObject(int port, boolean ssl) throws IOException { | |
33 | super(port, ssl); | |
34 | } | |
35 | ||
36 | /** | |
37 | * Create a new server that will start listening on the network when | |
38 | * {@link ServerObject#start()} is called. | |
39 | * | |
40 | * @param name | |
41 | * the server name (only used for debug info and traces) | |
42 | * @param port | |
43 | * the port to listen on | |
44 | * @param ssl | |
45 | * use a SSL connection (or not) | |
46 | * | |
47 | * @throws IOException | |
48 | * in case of I/O error | |
49 | */ | |
50 | public ServerObject(String name, int port, boolean ssl) throws IOException { | |
51 | super(name, port, ssl); | |
52 | } | |
53 | ||
54 | @Override | |
55 | protected ConnectActionServer createConnectActionServer(Socket s) { | |
56 | return new ConnectActionServerObject(s) { | |
57 | @Override | |
58 | public void action(Version clientVersion) throws Exception { | |
59 | try { | |
60 | for (Object data = rec(); true; data = rec()) { | |
61 | Object rep = null; | |
62 | try { | |
63 | rep = onRequest(this, clientVersion, data); | |
64 | } catch (Exception e) { | |
65 | onError(e); | |
66 | } | |
67 | send(rep); | |
68 | } | |
69 | } catch (NullPointerException e) { | |
70 | // Client has no data any more, we quit | |
71 | getTraceHandler() | |
72 | .trace(getName() | |
73 | + ": client has data no more, stopping connection"); | |
74 | } | |
75 | } | |
79ce1a49 NR |
76 | }; |
77 | } | |
78 | ||
79 | /** | |
80 | * This is the method that is called on each client request. | |
81 | * <p> | |
82 | * You are expected to react to it and return an answer (which can be NULL). | |
83 | * | |
84 | * @param action | |
85 | * the client action | |
86 | * @param clientVersion | |
87 | * the client version | |
88 | * @param data | |
89 | * the data sent by the client (which can be NULL) | |
90 | * | |
91 | * @return the answer to return to the client (which can be NULL) | |
92 | * | |
93 | * @throws Exception | |
94 | * in case of an exception, the error will only be logged | |
95 | */ | |
96 | abstract protected Object onRequest(ConnectActionServerObject action, | |
97 | Version clientVersion, Object data) throws Exception; | |
98 | } |