org.rvpf.pap.dnp3.transport

Class Connection

Object

PAPConnection.Abstract

Connection

All Implemented Interfaces:

PAPConnection, ServiceThread.Target

Direct Known Subclasses:

SerialConnection, TCPConnection, UDPConnection

public abstract class Connection
extends PAPConnection.Abstract
implements ServiceThread.Target

Connection.

Nested Class Summary

Nested classes/interfaces inherited from interface PAPConnection

PAPConnection.Abstract

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Connection(LocalEndPoint localEndPoint, RemoteEndPoint remoteEndPoint) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
void	activate() Activates.
void	doClose() Does close.
protected abstract void	doReceive(ByteBuffer buffer) Do receives.
protected abstract void	doSend(ByteBuffer buffer) Do sends.
Optional<Exception>	getException() Gets the exception.
LocalEndPoint	getLocalEndPoint() Gets the local end point.
RemoteEndPoint	getRemoteEndPoint() Gets the remote end point.
boolean	isOnMaster() Asks if the local end point is on a master.
boolean	isOnOutstation() Asks if the local end point is on an outstation
void	receive(ByteBuffer buffer) Receives.
void	run()
void	send(ByteBuffer buffer) Sends.

Methods inherited from class PAPConnection.Abstract

close, getName, getThisLogger, isClosed

Methods inherited from class Object

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

Constructor Detail

Connection

protected Connection(@Nonnull
                     LocalEndPoint localEndPoint,
                     @Nonnull
                     RemoteEndPoint remoteEndPoint)

Constructs an instance.

Parameters:

localEndPoint - The local end point.

remoteEndPoint - The remote end point.

Method Detail

activate

public void activate()

Activates.

doClose

public void doClose()
             throws IOException

Does close.

Specified by:

doClose in class PAPConnection.Abstract

Throws:

IOException - To be logged.

getException

@Nonnull
 @CheckReturnValue
public Optional<Exception> getException()

Gets the exception.

Returns:

The exception (may be empty).

getLocalEndPoint

@Nonnull
 @CheckReturnValue
public LocalEndPoint getLocalEndPoint()

Gets the local end point.

Returns:

The local end point.

getRemoteEndPoint

@Nonnull
 @CheckReturnValue
public RemoteEndPoint getRemoteEndPoint()

Gets the remote end point.

Returns:

The remote end point.

isOnMaster

@CheckReturnValue
public boolean isOnMaster()

Asks if the local end point is on a master.

Returns:

True if the local end point is on a master.

isOnOutstation

@CheckReturnValue
public boolean isOnOutstation()

Asks if the local end point is on an outstation

Returns:

True if the local end point is on an outstation

receive

public final void receive(@Nonnull
                          ByteBuffer buffer)
                   throws IOException

Receives.

Parameters:

buffer - A buffer to receive data.

Throws:

IOException - On I/O exception.

run

public void run()
         throws Exception

Specified by:

run in interface ServiceThread.Target

Throws:

Exception

send

public final void send(@Nonnull
                       ByteBuffer buffer)
                throws IOException

Sends.

Parameters:

buffer - A buffer containing the data.

Throws:

IOException - On I/O exception.

doReceive

protected abstract void doReceive(@Nonnull
                                  ByteBuffer buffer)
                           throws IOException

Do receives.

Parameters:

buffer - A buffer to receive data.

Throws:

IOException - On I/O exception.

doSend

protected abstract void doSend(@Nonnull
                               ByteBuffer buffer)
                        throws IOException

Do sends.

Parameters:

buffer - A buffer containing the data.

Throws:

IOException - On I/O exception.