com.ghgande.j2mod.modbus.slave

Class ModbusSlave

java.lang.Object

com.ghgande.j2mod.modbus.slave.ModbusSlave

public class ModbusSlave
extends Object

Class that implements a wrapper around a Slave Listener

Version:

2.0 (March 2016)

Author:

Steve O'Hara (4NG)

Method Summary

Modifier and Type	Method and Description
ProcessImage	addProcessImage(int unitId, ProcessImage processImage) Adds a process image for the given Unit ID
void	close() Convenience method for closing this port and removing it from the running list - simply calls ModbusSlaveFactory.close(this)
String	getError() Returns the last error accrued by the listener
int	getPort() Returns the port that this IP slave is listening on
ProcessImage	getProcessImage(int unitId) Returns the process image for the given Unit ID
SerialParameters	getSerialParams() Returns the serial parameters of this slave if it is a Serial type
String	getThreadName() Gets the name of the thread used by the listener
ModbusSlaveType	getType() Returns the type of this slave
void	open() Opens the listener to service requests
ProcessImage	removeProcessImage(int unitId) Removes the process image for the given Unit ID
void	setThreadName(String threadName) Sets the name of the thread used by the listener

Methods inherited from class java.lang.Object

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

Method Detail

getType

public ModbusSlaveType getType()

Returns the type of this slave

Returns:

Type of slave

getPort

public int getPort()

Returns the port that this IP slave is listening on

Returns:

Port being listened on if TCP or UDP

getProcessImage

public ProcessImage getProcessImage(int unitId)

Returns the process image for the given Unit ID

Parameters:

unitId - Unit ID of the associated image

Returns:

Process image

removeProcessImage

public ProcessImage removeProcessImage(int unitId)

Removes the process image for the given Unit ID

Parameters:

unitId - Unit ID of the associated image

Returns:

Process image

addProcessImage

public ProcessImage addProcessImage(int unitId,
                                    ProcessImage processImage)

Adds a process image for the given Unit ID

Parameters:

unitId - Unit ID to associate with this image

processImage - Process image to add

Returns:

Process image

getSerialParams

public SerialParameters getSerialParams()

Returns the serial parameters of this slave if it is a Serial type

Returns:

Serial parameters

open

public void open()
          throws ModbusException

Opens the listener to service requests

Throws:

ModbusException - If we cannot listen

close

public void close()

Convenience method for closing this port and removing it from the running list - simply calls ModbusSlaveFactory.close(this)

getError

public String getError()

Returns the last error accrued by the listener

Returns:

Error if there is one

getThreadName

public String getThreadName()

Gets the name of the thread used by the listener

Returns:

Name of thread or null if not assigned

setThreadName

public void setThreadName(String threadName)

Sets the name of the thread used by the listener

Parameters:

threadName - Name to use for the thread