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 static WaarpLogger	logger Internal Logger
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()
WaarpLock	getLock()
int	getSocketHashCode()
int	hashCode()
boolean	isShuttingDown()
boolean	isSSL()
int	nbLocalChannels()
void	remove(LocalChannelReference localChannel) Remove one LocalChanelReference
void	setHostId(String hostId)
void	shutdownAllLocalChannels() Shutdown All Local Channels associated with this NCR
String	toString()
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

logger

protected static final WaarpLogger logger

Internal Logger

isShuttingDown

protected volatile 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 boolean isSSL()

add

public void add(LocalChannelReference localChannel)
         throws OpenR66ProtocolRemoteShutdownException

Throws:

OpenR66ProtocolRemoteShutdownException

use

public void use()

To set the last time used

useIfUsed

public boolean useIfUsed()

To set the last time used when correct

Returns:

True if last time used is set

closeAndRemove

public void closeAndRemove(LocalChannelReference localChannel)

Remove one LocalChanelReference, closing it if necessary.

Parameters:

localChannel -

remove

public void remove(LocalChannelReference localChannel)

Remove one LocalChanelReference

Parameters:

localChannel -

shutdownAllLocalChannels

public void shutdownAllLocalChannels()

Shutdown All Local Channels associated with this NCR

nbLocalChannels

public int nbLocalChannels()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getSocketHashCode

public int getSocketHashCode()

Returns:

the hashcode for the global remote networkaddress

getAddressHashCode

public int getAddressHashCode()

Used for BlackList

Returns:

the hashcode for the address

checkLastTime

public 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 boolean isShuttingDown()

Returns:

the isShuttingDown

channel

public io.netty.channel.Channel channel()

Returns:

the channel

getHostId

public String getHostId()

Returns:

the hostId

setHostId

public void setHostId(String hostId)

Parameters:

hostId - the hostId to set

getLock

public WaarpLock getLock()

Returns:

the lock

getLastTimeUsed

public long getLastTimeUsed()

Returns:

the lastTimeUsed