org.harctoolbox.harchardware.comm.TcpSocketPort Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of HarcHardware Show documentation
Helper functions for accessing hardware etc.
There is a newer version: 2.4.1
/*
Copyright (C) 2012,2013 Bengt Martensson.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or (at
your option) any later version.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License along with
this program. If not, see http://www.gnu.org/licenses/.
*/

package org.harctoolbox.harchardware.comm;

import java.io.IOException;
import java.net.SocketException;
import java.net.UnknownHostException;
import java.nio.charset.Charset;
import org.harctoolbox.harchardware.ICommandLineDevice;
import org.harctoolbox.harchardware.IHarcHardware;
import org.harctoolbox.harchardware.Utils;

public class TcpSocketPort implements ICommandLineDevice, IBytesCommand, IHarcHardware {

    public final static int defaultTimeout = 2000;
    public static void main(String[] args) {
        try {
            try (TcpSocketPort port = new TcpSocketPort("denon", 23, defaultTimeout, true, ConnectionMode.keepAlive)) {
                port.sendString("MVDOWN\r");
                String result = port.readString();
                System.out.println(result);
            }
        } catch (IOException ex) {
            System.err.println(ex.getMessage());
        }
    }

    private TcpSocketChannel tcpSocketChannel;

    public TcpSocketPort(String hostIp, int portNumber, int timeout, boolean verbose, ConnectionMode connectionMode) throws UnknownHostException {
        tcpSocketChannel = new TcpSocketChannel(hostIp, portNumber, timeout, verbose, connectionMode);
    }
    public TcpSocketPort(String hostIp, int portNumber, boolean verbose, ConnectionMode connectionMode) throws UnknownHostException {
        tcpSocketChannel = new TcpSocketChannel(hostIp, portNumber, defaultTimeout, verbose, connectionMode);
    }

    public TcpSocketPort(String ipName, int portNumber) throws UnknownHostException {
        tcpSocketChannel = new TcpSocketChannel(ipName, portNumber, defaultTimeout, false, ConnectionMode.keepAlive);
    }

    @Override
    public void open() throws IOException {
        tcpSocketChannel.connect();
    }

    @Override
    public boolean ready() throws IOException {
        return tcpSocketChannel.ready();
    }

    @Override
    public void flushInput() throws IOException {
        tcpSocketChannel.flushInput();
    }


    @Override
    public void sendBytes(byte[] cmd) throws IOException {
        tcpSocketChannel.connect();
        tcpSocketChannel.getOut().write(cmd);
        tcpSocketChannel.close(false);
    }

    @Override
    public byte[] readBytes(int length) throws IOException {
        tcpSocketChannel.connect();
        byte[] result = Utils.readBytes(tcpSocketChannel.getIn(), length);
        tcpSocketChannel.close(false);
        return result;
    }

    @Override
    public void close() {
        try {
            if (tcpSocketChannel != null)
                tcpSocketChannel.close(true);
        } catch (IOException ex) {
        } finally {
            tcpSocketChannel = null;
        }
    }

    @Override
    public void sendString(String str) throws IOException {
        if (tcpSocketChannel.getVerbose())
            System.err.println(">" + str);
        sendBytes(str.getBytes(Charset.forName("US-ASCII")));
    }

    @Override
    public String readString() throws IOException {
        String str = readString(true);
        if (tcpSocketChannel.getVerbose())
            System.err.println("<" + str);
        return str;
    }

    @Override
    public String readString(boolean wait) throws IOException {
        tcpSocketChannel.connect();
        String result = tcpSocketChannel.readString(wait);
        tcpSocketChannel.close(false);
        return result;
    }

    @Override
    public boolean isValid() {
        return tcpSocketChannel != null && tcpSocketChannel.isValid();
    }

    @Override
    public String getVersion() {
        return "";
    }

    @Override
    public void setTimeout(int timeout) {
        try {
            tcpSocketChannel.setTimeout(timeout);
        } catch (SocketException ex) {
        }
    }

    @Override
    public void setVerbose(boolean verbose) {
        tcpSocketChannel.setVerbose(verbose);
    }

    @Override
    public void setDebug(int debug) {
        tcpSocketChannel.setDebug(debug);
    }

    public enum ConnectionMode {
        keepAlive,
        justInTime;
    }
}