org.openmuc.jmbus.transportlayer

Interface TransportLayer

All Superinterfaces:

java.lang.AutoCloseable

public interface TransportLayer
extends java.lang.AutoCloseable

The MBus transport layer interface.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the transport layer.
java.io.DataInputStream	getInputStream() Get the input stream of the layer.
java.io.DataOutputStream	getOutputStream() Get the output stream of the layer.
int	getTimeout() Get the response timeout in MILLIS.
boolean	isClosed() Check if the layer is open.
void	open() Opens the transport layer.
void	setTimeout(int timeout) Set the response timeout.

Method Detail

open

void open()
   throws java.io.IOException

Opens the transport layer. The layer needs to be opened before attempting to read a device.

Throws:

java.io.IOException - if an I/O error occurs while opening.

close

void close()

Closes the transport layer.

Specified by:

close in interface java.lang.AutoCloseable

getOutputStream

java.io.DataOutputStream getOutputStream()

Get the output stream of the layer.

Returns:

the output stream.

getInputStream

java.io.DataInputStream getInputStream()

Get the input stream of the layer.

Returns:

the input stream.

isClosed

boolean isClosed()

Check if the layer is open.

Returns:

true if the layer is closed.

setTimeout

void setTimeout(int timeout)
         throws java.io.IOException

Set the response timeout.

Parameters:

timeout - the timeout in MILLIS.

Throws:

java.io.IOException - if an I/O error occurs.

getTimeout

int getTimeout()
        throws java.io.IOException

Get the response timeout in MILLIS.

Returns:

the response timeout in MILLIS.

Throws:

java.io.IOException - if an I/O error occurs.