org.waarp.openr66.protocol.networkhandler

Class NetworkChannelReference

java.lang.Object

org.waarp.openr66.protocol.networkhandler.NetworkChannelReference

public class NetworkChannelReference
extends Object

NetworkChannelReference object to keep Network channel open while some local channels are attached to it.

Field Summary

Fields

Modifier and Type	Field and Description
protected io.netty.channel.Channel	channel Network Channel
protected ClientNetworkChannels	clientNetworkChannels ClientNetworkChannels object that contains this NetworkChannelReference
protected boolean	isShuttingDown Does this Network Channel is in shutdown
protected WaarpLock	lock Associated lock
protected SocketAddress	networkAddress Remote network address (when valid)

Constructor Summary

Constructors

Constructor and Description
NetworkChannelReference(io.netty.channel.Channel networkChannel, WaarpLock lock, boolean isSSL)
NetworkChannelReference(SocketAddress address, WaarpLock lock, boolean isSSL)

Method Summary

Modifier and Type	Method and Description
void	add(LocalChannelReference localChannel)
io.netty.channel.Channel	channel()
long	checkLastTime(long delay) Check if the last time used is ok with a delay applied to the current time (timeout)
void	closeAndRemove(LocalChannelReference localChannel) Remove one LocalChanelReference, closing it if necessary.
boolean	equals(Object obj)
int	getAddressHashCode() Used for BlackList
String	getHostId()
long	getLastTimeUsed()
int	getSocketHashCode()
int	hashCode()
boolean	isLastLocalChannelActive(LocalChannelReference localChannelReference)
boolean	isShuttingDown()
boolean	isSomeLocalChannelsActive()
boolean	isSSL()
void	lockNetwork()
int	nbLocalChannels()
void	remove(LocalChannelReference localChannel) Remove one LocalChanelReference
void	setHostId(String hostId)
void	shutdownAllLocalChannels() Shutdown All Local Channels associated with this NCR
long	shutdownAllowed()
String	toString()
void	unlockNetwork()
void	use() To set the last time used
boolean	useIfUsed() To set the last time used when correct

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

isShuttingDown

protected boolean isShuttingDown

Does this Network Channel is in shutdown

channel

protected final io.netty.channel.Channel channel

Network Channel

networkAddress

protected final SocketAddress networkAddress

Remote network address (when valid)

clientNetworkChannels

protected ClientNetworkChannels clientNetworkChannels

ClientNetworkChannels object that contains this NetworkChannelReference

lock

protected final WaarpLock lock

Associated lock

Constructor Detail

NetworkChannelReference

public NetworkChannelReference(io.netty.channel.Channel networkChannel,
                               WaarpLock lock,
                               boolean isSSL)

NetworkChannelReference

public NetworkChannelReference(SocketAddress address,
                               WaarpLock lock,
                               boolean isSSL)

Method Detail

isSSL

public final boolean isSSL()

add

public final void add(LocalChannelReference localChannel)
               throws OpenR66ProtocolRemoteShutdownException

Throws:

OpenR66ProtocolRemoteShutdownException

use

public final void use()

To set the last time used

useIfUsed

public final boolean useIfUsed()

To set the last time used when correct

Returns:

True if last time used is set

closeAndRemove

public final void closeAndRemove(LocalChannelReference localChannel)

Remove one LocalChanelReference, closing it if necessary.

Parameters:

localChannel -

remove

public final void remove(LocalChannelReference localChannel)

Remove one LocalChanelReference

Parameters:

localChannel -

shutdownAllLocalChannels

public final void shutdownAllLocalChannels()

Shutdown All Local Channels associated with this NCR

isLastLocalChannelActive

public final boolean isLastLocalChannelActive(LocalChannelReference localChannelReference)

Parameters:

localChannelReference - the localChannelReference to be closed

Returns:

True if the localChannelReference is the only one still active or there is no more LCR

shutdownAllowed

public final long shutdownAllowed()

Returns:

-1 if not allowed, 0 if allowed, else time in ms before ready to recheck

lockNetwork

public final void lockNetwork()

unlockNetwork

public final void unlockNetwork()

nbLocalChannels

public final int nbLocalChannels()

isSomeLocalChannelsActive

public final boolean isSomeLocalChannelsActive()

Returns:

True if at least one LocalChannel is not yet finished (OK or Error)

toString

public final String toString()

Overrides:

toString in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

getSocketHashCode

public final int getSocketHashCode()

Returns:

the hashcode for the global remote networkaddress

getAddressHashCode

public final int getAddressHashCode()

Used for BlackList

Returns:

the hashcode for the address

checkLastTime

public final long checkLastTime(long delay)

Check if the last time used is ok with a delay applied to the current time (timeout)

Parameters:

delay -

Returns:

<= 0 if OK, else > 0 (should send a KeepAlive or wait that time in ms)

isShuttingDown

public final boolean isShuttingDown()

Returns:

the isShuttingDown

channel

public final io.netty.channel.Channel channel()

Returns:

the channel

getHostId

public final String getHostId()

Returns:

the hostId

setHostId

public final void setHostId(String hostId)

Parameters:

hostId - the hostId to set

getLastTimeUsed

public final long getLastTimeUsed()

Returns:

the lastTimeUsed