org.rvpf.pap.dnp3.transport

Class MasterOutstationAssociation

Object

Association

MasterOutstationAssociation

public final class MasterOutstationAssociation
extends Association

Master-outstation association.

Constructor Summary

Constructors

Constructor and Description
MasterOutstationAssociation(short localDeviceAddress, short remoteDeviceAddress, RemoteEndPoint remoteEndPoint) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
ReadTransaction.Request	addReadRequest(Point point) Adds a read request for a point.
WriteTransaction.Request	addWriteRequest(PointValue pointValue) Adds write request for a point value.
ReadTransaction.Response[]	commitReadRequests() Commits read requests.
WriteTransaction.Response[]	commitWriteRequests() Commits write requests.
void	disconnect() Disconnects.
byte	getLatestRequestSequenceSent() Gets the latest request sequenceSent.
Optional<Fragment>	getLatestSolicitedResponseFragment() Gets the latest solicited response fragment.
Optional<Fragment>	getLatestUnsolicitedResponseFragment() Gets the latest unsolicited response fragment.
boolean	isUnsolicitedSupported() Gets the unsolicited supported indicator.
boolean	isWithOutstation() Asks if with outstation.
void	rollbackReadRequests() Rolls back read requests.
void	rollbackWriteRequests() Rolls back write requests.
void	setLatestRequestSequenceSent(byte latestRequestSequenceSent) Sets the latest request sequence sent.
void	setLatestSolicitedResponseFragment(Fragment latestSolicitedResponseFragment) Sets the latest solicited response rragment.
void	setLatestUnsolicitedResponseFragment(Fragment latestUnsolicitedResponseFragment) Sets the latest unsolicited response fragment.
void	setUnsolicitedSupported(boolean unsolicitedSupported) Sets the unsolicited supported indicator.

Methods inherited from class Association

close, equals, expectConfirm, getApplicationLayer, getConnection, getConnectionManager, getDataLinkLayer, getLocalDeviceAddress, getRemoteDeviceAddress, getRemoteEndPoint, getTransportFunction, hashCode, onConfirm, toString, waitForConfirm

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MasterOutstationAssociation

public MasterOutstationAssociation(short localDeviceAddress,
                                   short remoteDeviceAddress,
                                   @Nonnull
                                   RemoteEndPoint remoteEndPoint)

Constructs an instance.

Parameters:

localDeviceAddress - The local device address.

remoteDeviceAddress - The remote device address.

remoteEndPoint - The remote end point.

Method Detail

addReadRequest

@Nonnull
 @CheckReturnValue
public ReadTransaction.Request addReadRequest(@Nonnull
                                                                            Point point)

Adds a read request for a point.

Parameters:

point - The point.

Returns:

The new read request.

addWriteRequest

@Nonnull
 @CheckReturnValue
public WriteTransaction.Request addWriteRequest(@Nonnull
                                                                              PointValue pointValue)

Adds write request for a point value.

Parameters:

pointValue - The point value.

Returns:

The new write request.

commitReadRequests

@Nonnull
 @CheckReturnValue
public ReadTransaction.Response[] commitReadRequests()
                                                                            throws ServiceNotAvailableException

Commits read requests.

Returns:

The responses.

Throws:

ServiceNotAvailableException - On connection failure.

commitWriteRequests

@Nonnull
 @CheckReturnValue
public WriteTransaction.Response[] commitWriteRequests()
                                                                              throws ServiceNotAvailableException

Commits write requests.

Returns:

The responses.

Throws:

ServiceNotAvailableException - On connection failure.

disconnect

public void disconnect()

Disconnects.

getLatestRequestSequenceSent

@CheckReturnValue
public byte getLatestRequestSequenceSent()

Gets the latest request sequenceSent.

Returns:

The latest request sequence sent.

getLatestSolicitedResponseFragment

@Nonnull
 @CheckReturnValue
public Optional<Fragment> getLatestSolicitedResponseFragment()

Gets the latest solicited response fragment.

Returns:

The latest solicited response fragment (may be empty).

getLatestUnsolicitedResponseFragment

@Nonnull
 @CheckReturnValue
public Optional<Fragment> getLatestUnsolicitedResponseFragment()

Gets the latest unsolicited response fragment.

Returns:

The latest unsolicited response fragment (may be emppty).

isUnsolicitedSupported

@CheckReturnValue
public boolean isUnsolicitedSupported()

Gets the unsolicited supported indicator.

Returns:

The unsolicited supported indicator.

isWithOutstation

public boolean isWithOutstation()

Asks if with outstation.

Specified by:

isWithOutstation in class Association

Returns:

True if with outstation.

rollbackReadRequests

public void rollbackReadRequests()

Rolls back read requests.

rollbackWriteRequests

public void rollbackWriteRequests()

Rolls back write requests.

setLatestRequestSequenceSent

public void setLatestRequestSequenceSent(byte latestRequestSequenceSent)

Sets the latest request sequence sent.

Parameters:

latestRequestSequenceSent - The latest request sequence sent.

setLatestSolicitedResponseFragment

public void setLatestSolicitedResponseFragment(@Nonnull
                                               Fragment latestSolicitedResponseFragment)

Sets the latest solicited response rragment.

Parameters:

latestSolicitedResponseFragment - The latest solicited response fragment.

setLatestUnsolicitedResponseFragment

public void setLatestUnsolicitedResponseFragment(@Nonnull
                                                 Fragment latestUnsolicitedResponseFragment)

Sets the latest unsolicited response fragment.

Parameters:

latestUnsolicitedResponseFragment - The latest unsolicited response fragment.

setUnsolicitedSupported

public void setUnsolicitedSupported(boolean unsolicitedSupported)

Sets the unsolicited supported indicator.

Parameters:

unsolicitedSupported - The unsolicited supported indicator.