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 and 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 and Description
protected	NettyPlcConnection(ChannelFactory channelFactory)
protected	NettyPlcConnection(ChannelFactory channelFactory, boolean awaitSessionSetupComplete)

Method Summary

Modifier and Type	Method and Description
protected <T> T	checkInternal(Object o, Class<T> clazz) Can be used to check and cast a parameter to its required internal type (can be used for general type checking too).
void	close()
void	connect()
io.netty.channel.Channel	getChannel()
protected abstract io.netty.channel.ChannelHandler	getChannelHandler(CompletableFuture<Void> sessionSetupCompleteFuture)
boolean	isConnected()
protected void	sendChannelCreatedEvent()

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

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

Methods inherited from class java.lang.Object

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

Field Detail

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 Detail

NettyPlcConnection

protected NettyPlcConnection(ChannelFactory channelFactory)

NettyPlcConnection

protected NettyPlcConnection(ChannelFactory channelFactory,
                             boolean awaitSessionSetupComplete)

Method Detail

connect

public void connect()
             throws PlcConnectionException

Throws:

PlcConnectionException

close

public void close()
           throws PlcConnectionException

Throws:

PlcConnectionException

isConnected

public boolean isConnected()

getChannel

public io.netty.channel.Channel getChannel()

getChannelHandler

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

sendChannelCreatedEvent

protected void sendChannelCreatedEvent()

checkInternal

protected <T> T checkInternal(Object o,
                              Class<T> clazz)

Can be used to check and cast a parameter to its required internal type (can be used for general type checking too).

Type Parameters:

T - the type of the expected clazz.

Parameters:

o - the object to be checked against target clazz.

clazz - the expected clazz.

Returns:

the cast type of clazz.