summaryrefslogtreecommitdiff
path: root/src/main/java/com/keuin/psmb4j/BaseClient.java
blob: 3c5cf08cd7052ba713eb14392cb985f93a8990c4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
package com.keuin.psmb4j;

import com.keuin.psmb4j.error.IllegalParameterException;
import com.keuin.psmb4j.error.UnsupportedProtocolException;
import com.keuin.psmb4j.util.InputStreamUtils;

import java.io.DataInputStream;
import java.io.DataOutputStream;
import java.io.IOException;
import java.net.Socket;
import java.net.SocketException;
import java.nio.charset.StandardCharsets;
import java.util.Arrays;

public abstract class BaseClient implements AutoCloseable {

    protected final int protocolVersion = 1;
    protected final int MAX_CSTRING_LENGTH = 1024;
    protected final int DEFAULT_SOCKET_TIMEOUT_MILLIS = 0;

    private final String host;
    private final int port;

    private Socket socket;
    protected DataInputStream is;
    protected DataOutputStream os;

    protected final Object socketWriteLock = new Object();
    protected final Object socketReadLock = new Object();

    public BaseClient(String host, int port) {
        this.host = host;
        this.port = port;
    }

    /**
     * Connect to the server.
     * This method must be called before sending any other messages,
     * and should be called only once.
     * If an IO error occurred when doing some operation,
     * this client must be reconnected before next operations.
     * @throws IOException if a network error occurred
     */
    public void connect() throws IOException {
        try {
            if (this.socket != null) {
                throw new IllegalStateException("already connected");
            }
            this.socket = new Socket(host, port);
            this.socket.setSoTimeout(DEFAULT_SOCKET_TIMEOUT_MILLIS);
            this.is = new DataInputStream(this.socket.getInputStream());
            this.os = new DataOutputStream(this.socket.getOutputStream());

            os.writeBytes("PSMB");
            os.writeInt(protocolVersion);
            os.writeInt(0); // options
            os.flush();
            var response = InputStreamUtils.readCString(is, MAX_CSTRING_LENGTH);
            if (response.equals("UNSUPPORTED PROTOCOL")) {
                throw new UnsupportedProtocolException();
            } else if (response.equals("OK")) {
                var serverOptions = is.readInt();
                if (serverOptions != 0) {
                    throw new IllegalParameterException("Illegal server options: " + serverOptions);
                }
            }
        } catch (IOException ex) {
            // failed to connect, reset to initial state
            close();
            throw ex;
        }
    }

    public void keepAlive() throws IOException {
        final var nop = new byte[]{'N', 'O', 'P'};
        final var nil = new byte[]{'N', 'I', 'L'};
        synchronized (socketReadLock) {
            synchronized (socketWriteLock) {
                // lock the whole bidirectional communication
                os.write(nop);
                os.flush();
                // wait for a response NIL
                var response = InputStreamUtils.readBytes(is, 3);
                if (!Arrays.equals(response, nil)) {
                    throw new RuntimeException("illegal command from server: " +
                            new String(response, StandardCharsets.US_ASCII));
                }
            }
        }
    }

    public void disconnect() {
        if (os != null) {
            try {
                os.writeBytes("BYE");
                os.flush();
                os.close();
            } catch (IOException ignored) {
                os = null;
            }
        }
        if (is != null) {
            try {
                is.close();
            } catch (IOException ignored) {
                is = null;
            }
        }
        if (socket != null) {
            try {
                socket.close();
            } catch (IOException ignored) {
                socket = null;
            }
        }
    }

    protected void setSocketTimeout(int t) throws SocketException {
        this.socket.setSoTimeout(t);
    }

    @Override
    public void close() {
        disconnect();
    }
}