org.eclipse.scada.da.server.exporter.modbus

Class StaticModbusExport.Builder

java.lang.Object

org.eclipse.scada.da.server.exporter.modbus.StaticModbusExport.Builder

Enclosing class:

StaticModbusExport

public static class StaticModbusExport.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
StaticModbusExport.Builder(Hive hive)

Method Summary

Methods

Modifier and Type	Method and Description
void	addExport(String itemId, int offset, SourceType type) Add an export (source definition) to the current set
ModbusExport	build() Build a new modbus export instance based on the current builder state Note: The call is responsible for disposing the created instance using ModbusExport.dispose().
void	setDefinitions(Collection<SourceDefinition> definitions) Set (replace) all current source definitions
void	setHiveProperies(Properties hiveProperies) Set the hive session creation properties (e.g.
void	setIoProcessor(org.apache.mina.core.service.IoProcessor<org.apache.mina.transport.socket.nio.NioSession> processor) Set a custom IO processor
void	setPort(int port)
void	setReadTimeout(int readTimeout) Set a new read timeout in milliseconds The default read timeout is 30000ms (30 seconds)
void	setSlaveId(short slaveId)
void	setThreadFactory(ThreadFactory threadFactory) Set a custom thread factory If the thread factory is null, or not set then a default thread factory will be used

Methods inherited from class java.lang.Object

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

Constructor Detail

StaticModbusExport.Builder

public StaticModbusExport.Builder(Hive hive)

Method Detail

setHiveProperies

public void setHiveProperies(Properties hiveProperies)

Set the hive session creation properties (e.g. username/password)

Parameters:

hiveProperies - the hive session creation properties

setReadTimeout

public void setReadTimeout(int readTimeout)

Set a new read timeout in milliseconds
The default read timeout is 30000ms (30 seconds)

Parameters:

readTimeout - the new read timeout

setPort

public void setPort(int port)

setSlaveId

public void setSlaveId(short slaveId)

setThreadFactory

public void setThreadFactory(ThreadFactory threadFactory)

Set a custom thread factory
If the thread factory is null, or not set then a default thread factory will be used

Parameters:

threadFactory - the thread factory to use

setIoProcessor

public void setIoProcessor(org.apache.mina.core.service.IoProcessor<org.apache.mina.transport.socket.nio.NioSession> processor)

Set a custom IO processor

Parameters:

processor -

setDefinitions

public void setDefinitions(Collection<SourceDefinition> definitions)

Set (replace) all current source definitions

Parameters:

definitions - the new source definitions

addExport

public void addExport(String itemId,
             int offset,
             SourceType type)

Add an export (source definition) to the current set

Parameters:

itemId - the ID of the item

offset - the offset (in bytes) were to map the item to

type - the data type provider

build

public ModbusExport build()

Build a new modbus export instance based on the current builder state
Note: The call is responsible for disposing the created instance using ModbusExport.dispose().

Returns:

a newly created modbus instance