Package eu.cloudnetservice.driver.network.netty

Class NettyNetworkHandler

java.lang.Object

io.netty5.channel.SimpleChannelInboundHandler<BasePacket>

eu.cloudnetservice.driver.network.netty.NettyNetworkHandler

All Implemented Interfaces:

io.netty5.channel.ChannelHandler

Direct Known Subclasses:

NettyNetworkClientHandler, NettyNetworkServerHandler

@Internal
public abstract class NettyNetworkHandler
extends io.netty5.channel.SimpleChannelInboundHandler<BasePacket>

The default netty inbound handler used to call downstream packet listeners when receiving a packet.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
protected NettyNetworkChannel	channel
protected final EventManager	eventManager
private static final eu.cloudnetservice.common.log.Logger	LOGGER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NettyNetworkHandler(@NonNull EventManager eventManager)	Constructs a new netty network handler instance.

Method Summary

Modifier and Type	Method	Description
void	channelExceptionCaught(@NonNull io.netty5.channel.ChannelHandlerContext ctx, @NonNull Throwable cause)
void	channelInactive(@NonNull io.netty5.channel.ChannelHandlerContext ctx)
void	channelReadComplete(@NonNull io.netty5.channel.ChannelHandlerContext ctx)
protected abstract @NonNull Collection<NetworkChannel>	channels()	Get all channels which are connected to the underlying network component.
protected void	doHandlePacket(@NonNull BasePacket packet)	Handles the incoming packet and posts it either to the associated waiting query handler or directly into the packet registry, calling all associated handlers.
protected void	messageReceived(@NonNull io.netty5.channel.ChannelHandlerContext ctx, @NonNull BasePacket msg)
protected abstract @NonNull Executor	packetDispatcher()	Get the packet dispatcher used to dispatch incoming packets.

Methods inherited from class io.netty5.channel.SimpleChannelInboundHandler

acceptInboundMessage, channelRead

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty5.channel.ChannelHandler

bind, channelActive, channelInboundEvent, channelRegistered, channelShutdown, channelUnregistered, channelWritabilityChanged, close, connect, deregister, disconnect, flush, handlerAdded, handlerRemoved, isSharable, pendingOutboundBytes, read, register, sendOutboundEvent, shutdown, write

Field Details

LOGGER

private static final eu.cloudnetservice.common.log.Logger LOGGER

eventManager

protected final EventManager eventManager

channel

protected volatile NettyNetworkChannel channel

Constructor Details

NettyNetworkHandler

protected NettyNetworkHandler(@NonNull
 @NonNull EventManager eventManager)

Constructs a new netty network handler instance.

Parameters:

eventManager - the event manager of the current component.

Throws:

NullPointerException - if the given event manager is null.

Method Details

channelInactive

public void channelInactive(@NonNull
 @NonNull io.netty5.channel.ChannelHandlerContext ctx)
                     throws Exception

Throws:

Exception

channelExceptionCaught

public void channelExceptionCaught(@NonNull
 @NonNull io.netty5.channel.ChannelHandlerContext ctx,
 @NonNull
 @NonNull Throwable cause)

channelReadComplete

public void channelReadComplete(@NonNull
 @NonNull io.netty5.channel.ChannelHandlerContext ctx)

messageReceived

protected void messageReceived(@NonNull
 @NonNull io.netty5.channel.ChannelHandlerContext ctx,
 @NonNull
 @NonNull BasePacket msg)

Specified by:

messageReceived in class io.netty5.channel.SimpleChannelInboundHandler<BasePacket>

doHandlePacket

protected void doHandlePacket(@NonNull
 @NonNull BasePacket packet)

Handles the incoming packet and posts it either to the associated waiting query handler or directly into the packet registry, calling all associated handlers.

Parameters:

packet - the packet to handle.

Throws:

NullPointerException - if the given packet is null.

channels

@NonNull
protected abstract @NonNull Collection<NetworkChannel> channels()

Get all channels which are connected to the underlying network component.

Returns:

all connected channels.

packetDispatcher

@NonNull
protected abstract @NonNull Executor packetDispatcher()

Get the packet dispatcher used to dispatch incoming packets. Each dispatcher is normally bound to the network component which opened/received the connection and requested this handler.

Returns:

the dispatcher used to dispatch packets.