Class DefaultNetworkChannel

java.lang.Object

eu.cloudnetservice.driver.network.DefaultNetworkChannel

All Implemented Interfaces:

NetworkChannel, PacketSender

Direct Known Subclasses:

NettyNetworkChannel

public abstract class DefaultNetworkChannel
extends Object
implements NetworkChannel

The default abstract implementation of a network channel.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
private static final AtomicLong	CHANNEL_ID_COUNTER
private final long	channelId
private final HostAndPort	clientAddress
private final boolean	clientProvidedChannel
private final NetworkChannelHandler	handler
private final PacketListenerRegistry	packetRegistry
private final QueryPacketManager	queryPacketManager
private final HostAndPort	serverAddress

Constructor Summary

Constructors

Constructor	Description
DefaultNetworkChannel(@NonNull PacketListenerRegistry packetRegistry, @NonNull HostAndPort serverAddress, @NonNull HostAndPort clientAddress, boolean clientProvidedChannel, @NonNull NetworkChannelHandler handler)	Constructs a new default network channel instance.

Method Summary

Modifier and Type	Method	Description
long	channelId()	Get a unique numeric id of this channel.
@NonNull HostAndPort	clientAddress()	Get the client host from/to the channel is connected.
boolean	clientProvidedChannel()	Get if this client is opened by a client rather than a server.
@NonNull NetworkChannelHandler	handler()	Get the handler of this channel listening to all kind of operations on this channel.
@NonNull PacketListenerRegistry	packetRegistry()	Get the packet listener registry responsible for this channel.
@NonNull QueryPacketManager	queryPacketManager()	Get the query packet manager of this channel.
@NonNull CompletableFuture<Packet>	sendQueryAsync(@NonNull Packet packet)	Converts and sends the given packet as a query into this channel, returning a future either completed with the response to the query or an exception if no response to the packet was received in time.
@NonNull HostAndPort	serverAddress()	Get the server host from/to the channel is connected.

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.cloudnetservice.driver.network.NetworkChannel

active, close, writeable

Methods inherited from interface eu.cloudnetservice.driver.network.protocol.PacketSender

sendPacket, sendPacket, sendPacketSync

Field Details

CHANNEL_ID_COUNTER

private static final AtomicLong CHANNEL_ID_COUNTER

channelId

private final long channelId

queryPacketManager

private final QueryPacketManager queryPacketManager

packetRegistry

private final PacketListenerRegistry packetRegistry

serverAddress

private final HostAndPort serverAddress

clientAddress

private final HostAndPort clientAddress

clientProvidedChannel

private final boolean clientProvidedChannel

handler

private final NetworkChannelHandler handler

Constructor Details

DefaultNetworkChannel

public DefaultNetworkChannel(@NonNull
 @NonNull PacketListenerRegistry packetRegistry,
 @NonNull
 @NonNull HostAndPort serverAddress,
 @NonNull
 @NonNull HostAndPort clientAddress,
 boolean clientProvidedChannel,
 @NonNull
 @NonNull NetworkChannelHandler handler)

Constructs a new default network channel instance.

Parameters:

packetRegistry - the packet registry to use for the channel.

serverAddress - the associated server address for the connection.

clientAddress - the associated client address for the connection.

clientProvidedChannel - true if this channel was opened by a client, false otherwise.

handler - the handler to post underlying network events to.

Throws:

NullPointerException - if one of the given arguments is null.

Method Details

sendQueryAsync

@NonNull
public @NonNull CompletableFuture<Packet> sendQueryAsync(@NonNull
 @NonNull Packet packet)

Converts and sends the given packet as a query into this channel, returning a future either completed with the response to the query or an exception if no response to the packet was received in time.

Specified by:

sendQueryAsync in interface NetworkChannel

Parameters:

packet - the packet to send as a query.

Returns:

a future completed with the result of the query or an exception in case of a timeout.

channelId

public long channelId()

Get a unique numeric id of this channel. The ids are starting at 1.

Specified by:

channelId in interface NetworkChannel

Returns:

a unique numeric id of this channel.

packetRegistry

@NonNull
public @NonNull PacketListenerRegistry packetRegistry()

Get the packet listener registry responsible for this channel.

Specified by:

packetRegistry in interface NetworkChannel

Returns:

the packet listener registry responsible for this channel.

queryPacketManager

@NonNull
public @NonNull QueryPacketManager queryPacketManager()

Get the query packet manager of this channel.

Specified by:

queryPacketManager in interface NetworkChannel

Returns:

the query packet manager of this channel.

serverAddress

@NonNull
public @NonNull HostAndPort serverAddress()

Get the server host from/to the channel is connected.

Specified by:

serverAddress in interface NetworkChannel

Returns:

the server address of the channel.

clientAddress

@NonNull
public @NonNull HostAndPort clientAddress()

Get the client host from/to the channel is connected.

Specified by:

clientAddress in interface NetworkChannel

Returns:

the client address of the channel.

clientProvidedChannel

public boolean clientProvidedChannel()

Get if this client is opened by a client rather than a server.

Specified by:

clientProvidedChannel in interface NetworkChannel

Returns:

true if this channel was opened by a client, false otherwise.

handler

@NonNull
public @NonNull NetworkChannelHandler handler()

Get the handler of this channel listening to all kind of operations on this channel.

Specified by:

handler in interface NetworkChannel

Returns:

the listener for channel operations.