8b5ec2af1bb56da102c9c80c5d431bef558f1049
[fanfix.git] / ConnectActionClientString.java
1 package be.nikiroo.utils.serial.server;
2
3 import java.io.IOException;
4 import java.net.Socket;
5 import java.net.UnknownHostException;
6
7 import 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 */
17 public class ConnectActionClientString extends ConnectActionClient {
18 /**
19 * Create a new {@link ConnectActionClientString} 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
25 */
26 public ConnectActionClientString(Socket s) {
27 super(s);
28 }
29
30 /**
31 * Create a new {@link ConnectActionClientString} with the current
32 * application version (see {@link Version#getCurrentVersion()}) as the
33 * client version.
34 *
35 * @param host
36 * the host to bind to
37 * @param port
38 * the port to bind to
39 * @param ssl
40 * TRUE for an SSL connection, FALSE for plain text
41 *
42 * @throws IOException
43 * in case of I/O error
44 * @throws UnknownHostException
45 * if the IP address of the host could not be determined
46 * @throws IllegalArgumentException
47 * if the port parameter is outside the specified range of valid
48 * port values, which is between 0 and 65535, inclusive
49 */
50 public ConnectActionClientString(String host, int port, boolean ssl)
51 throws IOException {
52 super(host, port, ssl);
53 }
54
55 /**
56 * Create a new {@link ConnectActionClientString}.
57 *
58 * @param host
59 * the host to bind to
60 * @param port
61 * the port to bind to
62 * @param ssl
63 * TRUE for an SSL connection, FALSE for plain text
64 * @param version
65 * the client version
66 *
67 * @throws IOException
68 * in case of I/O error
69 * @throws UnknownHostException
70 * if the IP address of the host could not be determined
71 * @throws IllegalArgumentException
72 * if the port parameter is outside the specified range of valid
73 * port values, which is between 0 and 65535, inclusive
74 */
75 public ConnectActionClientString(String host, int port, boolean ssl,
76 Version version) throws IOException {
77 super(host, port, ssl, version);
78 }
79
80 /**
81 * Create a new {@link ConnectActionClientString}.
82 *
83 * @param s
84 * the socket to bind to
85 * @param version
86 * the client version
87 */
88 public ConnectActionClientString(Socket s, Version version) {
89 super(s, version);
90 }
91
92 /**
93 * Send the given object to the server (and return the answer).
94 *
95 * @param data
96 * the data to send
97 *
98 * @return the answer, which can be NULL
99 *
100 * @throws IOException
101 * in case of I/O error
102 */
103 public String send(String data) throws IOException {
104 return action.sendString(data);
105 }
106 }