com.ghgande.j2mod.modbus.net

Class AbstractUDPTerminal

java.lang.Object

com.ghgande.j2mod.modbus.net.AbstractUDPTerminal

public abstract class AbstractUDPTerminal
extends Object

Interface defining a UDPTerminal.

Version:

2.0 (March 2016)

Author:

Dieter Wimberger, Steve O'Hara (4NG)

Constructor Summary

Constructors

Constructor and Description
AbstractUDPTerminal()

Method Summary

Modifier and Type	Method and Description
abstract void	activate() Activate this UDPTerminal.
abstract void	deactivate() Deactivates this UDPTerminal.
InetAddress	getAddress() Gets the local adapter address
int	getPort() Returns the local port the terminal is listening on
ModbusUDPTransport	getTransport() Get the transport
boolean	isActive() Tests if this UDPSlaveTerminal is active.
abstract byte[]	receiveMessage() Receives and returns a message.
abstract void	sendMessage(byte[] msg) Sends the given message.
void	setTimeout(int timeout) Sets the timeout in milliseconds for this UDPSlaveTerminal.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractUDPTerminal

public AbstractUDPTerminal()

Method Detail

getAddress

public InetAddress getAddress()

Gets the local adapter address

Returns:

Adapter address

getPort

public int getPort()

Returns the local port the terminal is listening on

Returns:

Port number

isActive

public boolean isActive()

Tests if this UDPSlaveTerminal is active.

Returns:

true if active, false otherwise.

setTimeout

public void setTimeout(int timeout)

Sets the timeout in milliseconds for this UDPSlaveTerminal.

Parameters:

timeout - the timeout as int.

getTransport

public ModbusUDPTransport getTransport()

Get the transport

Returns:

Transport

activate

public abstract void activate()
                       throws Exception

Activate this UDPTerminal.

Throws:

Exception - if there is a network failure.

deactivate

public abstract void deactivate()

Deactivates this UDPTerminal.

sendMessage

public abstract void sendMessage(byte[] msg)
                          throws Exception

Sends the given message.

Parameters:

msg - the message as byte[].

Throws:

Exception - if sending the message fails.

receiveMessage

public abstract byte[] receiveMessage()
                               throws Exception

Receives and returns a message.

Returns:

the message as a newly allocated byte[].

Throws:

Exception - if receiving a message fails.