jdoc
[fanfix.git] / src / be / nikiroo / utils / serial / server / ConnectActionClientObject.java
CommitLineData
79ce1a49
NR
1package be.nikiroo.utils.serial.server;
2
3import java.io.IOException;
4import java.net.Socket;
f4053377 5import java.net.UnknownHostException;
79ce1a49
NR
6
7import be.nikiroo.utils.Version;
8
9/**
10 * Class used for the client basic handling.
11 * <p>
12 * It represents a single action: a client is expected to only execute one
13 * action.
14 *
15 * @author niki
16 */
17public class ConnectActionClientObject extends ConnectActionClient {
18 /**
19 * Create a new {@link ConnectActionClientObject} with the current
20 * application version (see {@link Version#getCurrentVersion()}) as the
21 * client version.
22 *
23 * @param s
24 * the socket to bind to
8468bb79
NR
25 * @param key
26 * an optional key to encrypt all the communications (if NULL,
27 * everything will be sent in clear text)
79ce1a49 28 */
8468bb79
NR
29 public ConnectActionClientObject(Socket s, String key) {
30 super(s, key);
79ce1a49
NR
31 }
32
33 /**
34 * Create a new {@link ConnectActionClientObject} with the current
35 * application version (see {@link Version#getCurrentVersion()}) as the
36 * client version.
37 *
38 * @param host
39 * the host to bind to
40 * @param port
41 * the port to bind to
8468bb79
NR
42 * @param key
43 * an optional key to encrypt all the communications (if NULL,
44 * everything will be sent in clear text)
79ce1a49
NR
45 *
46 * @throws IOException
f4053377
NR
47 * in case of I/O error
48 * @throws UnknownHostException
49 * if the IP address of the host could not be determined
50 * @throws IllegalArgumentException
51 * if the port parameter is outside the specified range of valid
52 * port values, which is between 0 and 65535, inclusive
79ce1a49 53 */
8468bb79 54 public ConnectActionClientObject(String host, int port, String key)
79ce1a49 55 throws IOException {
8468bb79 56 super(host, port, key);
79ce1a49
NR
57 }
58
79ce1a49
NR
59 /**
60 * Serialise and send the given object to the server (and return the
61 * deserialised answer).
62 *
63 * @param data
64 * the data to send
65 *
66 * @return the answer, which can be NULL
67 *
68 * @throws IOException
69 * in case of I/O error
70 * @throws NoSuchFieldException
71 * if the serialised data contains information about a field
72 * which does actually not exist in the class we know of
73 * @throws NoSuchMethodException
74 * if a class described in the serialised data cannot be created
75 * because it is not compatible with this code
76 * @throws ClassNotFoundException
77 * if a class described in the serialised data cannot be found
78 */
79 public Object send(Object data) throws IOException, NoSuchFieldException,
80 NoSuchMethodException, ClassNotFoundException {
81 return action.sendObject(data);
82 }
83}