org.bidib.jbidibc.netbidib.debug.NetBidibDebugClientInterface Maven / Gradle / Ivy

Go to download
package org.bidib.jbidibc.netbidib.debug;

import org.bidib.jbidibc.messages.ConnectionListener;
import org.bidib.jbidibc.messages.exception.PortNotOpenedException;

public interface NetBidibDebugClientInterface {

    /**
     * Open the communication port with the specified name.
     * 
     * @param portName
     *            the port name
     * @param connectionListener
     *            the connection listener
     * @throws PortNotOpenedException
     *             thrown if open the communication port failed
     */
    void open(String portName, ConnectionListener connectionListener) throws PortNotOpenedException;

    /**
     * @return returns {@code true} if the port is opened, {@code false} otherwise
     */
    boolean isOpened();

    /**
     * Close the communication port.
     */
    void close();

    /**
     * Send the bytes to the outputstream.
     * 
     * @param data
     *            the data to send
     */
    void send(final byte[] data);

}