Package org.apache.plc4x.java.base.connection

Class NettyPlcConnection

java.lang.Object

org.apache.plc4x.java.base.connection.AbstractPlcConnection

org.apache.plc4x.java.base.connection.NettyPlcConnection

All Implemented Interfaces:

AutoCloseable, PlcConnectionMetadata, PlcConnection

public abstract class NettyPlcConnection
extends AbstractPlcConnection

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	awaitSessionSetupComplete
protected io.netty.channel.Channel	channel
protected ChannelFactory	channelFactory
protected boolean	connected
protected static io.netty.util.Timer	timer	a HashedWheelTimer shall be only instantiated once.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NettyPlcConnection(ChannelFactory channelFactory)
protected	NettyPlcConnection(ChannelFactory channelFactory, boolean awaitSessionSetupComplete)

Method Summary

Modifier and Type	Method	Description
void	close()
void	connect()
io.netty.channel.Channel	getChannel()
protected abstract io.netty.channel.ChannelHandler	getChannelHandler(CompletableFuture<Void> sessionSetupCompleteFuture)
boolean	isConnected()	Check if the communication channel is active (channel.isActive()) and the driver for a given protocol has finished establishing the connection.
CompletableFuture<Void>	ping()
protected void	sendChannelCreatedEvent()

Methods inherited from class org.apache.plc4x.java.base.connection.AbstractPlcConnection

canRead, canSubscribe, canWrite, checkInternal, getMetadata, readRequestBuilder, subscriptionRequestBuilder, unsubscriptionRequestBuilder, writeRequestBuilder

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.plc4x.java.api.PlcConnection

prepareField

Field Details

timer

protected static final io.netty.util.Timer timer

a HashedWheelTimer shall be only instantiated once.

channelFactory

protected final ChannelFactory channelFactory

awaitSessionSetupComplete

protected final boolean awaitSessionSetupComplete

channel

protected io.netty.channel.Channel channel

connected

protected boolean connected

Constructor Details

NettyPlcConnection

protected NettyPlcConnection(ChannelFactory channelFactory)

NettyPlcConnection

protected NettyPlcConnection(ChannelFactory channelFactory, boolean awaitSessionSetupComplete)

Method Details

connect

public void connect() throws PlcConnectionException

Throws:

PlcConnectionException

ping

public CompletableFuture<Void> ping()

Specified by:

ping in interface PlcConnection

Overrides:

ping in class AbstractPlcConnection

close

public void close() throws PlcConnectionException

Throws:

PlcConnectionException

isConnected

public boolean isConnected()

Check if the communication channel is active (channel.isActive()) and the driver for a given protocol has finished establishing the connection.

getChannel

public io.netty.channel.Channel getChannel()

getChannelHandler

protected abstract io.netty.channel.ChannelHandler getChannelHandler(CompletableFuture<Void> sessionSetupCompleteFuture)

sendChannelCreatedEvent

protected void sendChannelCreatedEvent()