Package de.dytanic.cloudnet.driver.network

Class DefaultNetworkChannel

java.lang.Object

de.dytanic.cloudnet.driver.network.DefaultNetworkChannel

All Implemented Interfaces:

INetworkChannel, IPacketSender, java.lang.AutoCloseable

Direct Known Subclasses:

NettyNetworkChannel

public abstract class DefaultNetworkChannel
extends java.lang.Object
implements INetworkChannel

Constructor Summary

Constructors

Constructor	Description
DefaultNetworkChannel(IPacketListenerRegistry packetRegistry, HostAndPort serverAddress, HostAndPort clientAddress, boolean clientProvidedChannel, INetworkChannelHandler handler)

Method Summary

Modifier and Type	Method	Description
long	getChannelId()	Returns the unique channelId.
HostAndPort	getClientAddress()	Returns the client address from this channel
INetworkChannelHandler	getHandler()	Returns the networkChannelHandler from this channel
IPacketListenerRegistry	getPacketRegistry()	Returns the own packet listener registry.
HostAndPort	getServerAddress()	Returns the server address from this channel
boolean	isClientProvidedChannel()	Returns that, the channel based of the client site connection
de.dytanic.cloudnet.common.concurrent.ITask<IPacket>	registerQueryResponseHandler(java.util.UUID uniqueId)
de.dytanic.cloudnet.common.concurrent.ITask<ChunkedQueryResponse>	sendChunkedPacketQuery(@NotNull IPacket packet)
boolean	sendChunkedPackets(@NotNull de.dytanic.cloudnet.common.document.gson.JsonDocument header, @NotNull java.io.InputStream inputStream, int channel)
boolean	sendChunkedPackets(@NotNull java.util.UUID uniqueId, @NotNull de.dytanic.cloudnet.common.document.gson.JsonDocument header, @NotNull java.io.InputStream inputStream, int channel)
boolean	sendChunkedPacketsResponse(@NotNull java.util.UUID uniqueId, @NotNull de.dytanic.cloudnet.common.document.gson.JsonDocument header, @NotNull java.io.InputStream inputStream)
void	sendPacket(@NotNull IPacket... packets)	Transport packet instances into the network to the receiver.
IPacket	sendQuery(@NotNull IPacket packet)
de.dytanic.cloudnet.common.concurrent.ITask<IPacket>	sendQueryAsync(@NotNull IPacket packet)
void	setHandler(INetworkChannelHandler handler)	Sets the channel handler for the channels.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface de.dytanic.cloudnet.driver.network.INetworkChannel

isActive, isWriteable

Methods inherited from interface de.dytanic.cloudnet.driver.network.protocol.IPacketSender

sendPacket, sendPacketSync, sendPacketSync

Constructor Detail

DefaultNetworkChannel

public DefaultNetworkChannel(IPacketListenerRegistry packetRegistry,
                             HostAndPort serverAddress,
                             HostAndPort clientAddress,
                             boolean clientProvidedChannel,
                             INetworkChannelHandler handler)

Method Detail

sendPacket

public void sendPacket(@NotNull
                       @NotNull IPacket... packets)

Description copied from interface: IPacketSender

Transport packet instances into the network to the receiver. The receiver will handle the packets if he knows the channel and has listeners for the channel

A packet are doesn't allow to be null All elements should be checked that be not null and send after that

Specified by:

sendPacket in interface IPacketSender

Parameters:

packets - the packets, which should transport into the network

sendQueryAsync

public de.dytanic.cloudnet.common.concurrent.ITask<IPacket> sendQueryAsync(@NotNull
                                                                           @NotNull IPacket packet)

Specified by:

sendQueryAsync in interface INetworkChannel

sendQuery

public IPacket sendQuery(@NotNull
                         @NotNull IPacket packet)

Specified by:

sendQuery in interface INetworkChannel

registerQueryResponseHandler

public de.dytanic.cloudnet.common.concurrent.ITask<IPacket> registerQueryResponseHandler(java.util.UUID uniqueId)

Specified by:

registerQueryResponseHandler in interface INetworkChannel

sendChunkedPacketQuery

public de.dytanic.cloudnet.common.concurrent.ITask<ChunkedQueryResponse> sendChunkedPacketQuery(@NotNull
                                                                                                @NotNull IPacket packet)

Specified by:

sendChunkedPacketQuery in interface INetworkChannel

sendChunkedPackets

public boolean sendChunkedPackets(@NotNull
                                  @NotNull java.util.UUID uniqueId,
                                  @NotNull
                                  @NotNull de.dytanic.cloudnet.common.document.gson.JsonDocument header,
                                  @NotNull
                                  @NotNull java.io.InputStream inputStream,
                                  int channel)
                           throws java.io.IOException

Specified by:

sendChunkedPackets in interface INetworkChannel

Throws:

java.io.IOException

sendChunkedPacketsResponse

public boolean sendChunkedPacketsResponse(@NotNull
                                          @NotNull java.util.UUID uniqueId,
                                          @NotNull
                                          @NotNull de.dytanic.cloudnet.common.document.gson.JsonDocument header,
                                          @NotNull
                                          @NotNull java.io.InputStream inputStream)
                                   throws java.io.IOException

Specified by:

sendChunkedPacketsResponse in interface INetworkChannel

Throws:

java.io.IOException

sendChunkedPackets

public boolean sendChunkedPackets(@NotNull
                                  @NotNull de.dytanic.cloudnet.common.document.gson.JsonDocument header,
                                  @NotNull
                                  @NotNull java.io.InputStream inputStream,
                                  int channel)
                           throws java.io.IOException

Specified by:

sendChunkedPackets in interface INetworkChannel

Throws:

java.io.IOException

getChannelId

public long getChannelId()

Description copied from interface: INetworkChannel

Returns the unique channelId. The Channel Id begins with 1 and ends with Long.MAX_VALUE

Specified by:

getChannelId in interface INetworkChannel

getPacketRegistry

public IPacketListenerRegistry getPacketRegistry()

Description copied from interface: INetworkChannel

Returns the own packet listener registry. The packetRegistry is a sub registry of the network component packet listener registry

Specified by:

getPacketRegistry in interface INetworkChannel

getServerAddress

public HostAndPort getServerAddress()

Description copied from interface: INetworkChannel

Returns the server address from this channel

Specified by:

getServerAddress in interface INetworkChannel

getClientAddress

public HostAndPort getClientAddress()

Description copied from interface: INetworkChannel

Returns the client address from this channel

Specified by:

getClientAddress in interface INetworkChannel

isClientProvidedChannel

public boolean isClientProvidedChannel()

Description copied from interface: INetworkChannel

Returns that, the channel based of the client site connection

Specified by:

isClientProvidedChannel in interface INetworkChannel

getHandler

public INetworkChannelHandler getHandler()

Description copied from interface: INetworkChannel

Returns the networkChannelHandler from this channel

Specified by:

getHandler in interface INetworkChannel

setHandler

public void setHandler(INetworkChannelHandler handler)

Description copied from interface: INetworkChannel

Sets the channel handler for the channels. That is important for the handling of receiving packets or channel closing and connect handler

Specified by:

setHandler in interface INetworkChannel

Parameters:

handler - the handler, that should handle this channel