com.hazelcast.internal.networking

Class AbstractChannel

java.lang.Object

com.hazelcast.internal.networking.AbstractChannel

All Implemented Interfaces:

Channel, Closeable, AutoCloseable

Direct Known Subclasses:

NioChannel

public abstract class AbstractChannel
extends Object
implements Channel

An abstract Channel implementation. This class is a pure implementation detail, the fact that it exposes some functionality like access to the socket channel is because the current Channel implementations need the SocketChannel.

Field Summary

Fields

Modifier and Type	Field and Description
protected ILogger	logger
protected SocketChannel	socketChannel

Constructor Summary

Constructors

Constructor and Description
AbstractChannel(SocketChannel socketChannel, boolean clientMode)

Method Summary

Modifier and Type	Method and Description
void	addCloseListener(ChannelCloseListener listener) Adds a ChannelCloseListener.
ConcurrentMap	attributeMap() Returns the attribute map.
void	close() Closes the Channel.
protected void	close0() Template method that is called when the Channel is closed.
void	connect(InetSocketAddress address, int timeoutMillis) Connects the channel.
boolean	isClientMode() Checks if this side is the Channel is in client mode or server mode.
boolean	isClosed() Checks if this Channel is closed.
SocketAddress	localSocketAddress()
protected void	notifyCloseListeners()
protected void	onConnect() Template method that can be implemented when the connect(InetSocketAddress, int) has completed.
SocketAddress	remoteSocketAddress()
Socket	socket()
SocketChannel	socketChannel()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hazelcast.internal.networking.Channel

inboundPipeline, lastReadTimeMillis, lastWriteTimeMillis, options, outboundPipeline, start, write

Field Detail

socketChannel

protected final SocketChannel socketChannel

logger

protected final ILogger logger

Constructor Detail

AbstractChannel

public AbstractChannel(SocketChannel socketChannel,
                       boolean clientMode)

Method Detail

isClientMode

public boolean isClientMode()

Description copied from interface: Channel

Checks if this side is the Channel is in client mode or server mode. A channel is in client-mode if it initiated the connection, and in server-mode if it was the one accepting the connection. Client mode isn't related to Hazelcast clients (although a Hazelcast client will always have clientMode=true). A connection from one member to another member can also have clientMode=true if that member connected to the other member. One of the reasons this property is valuable is for protocol/handshaking so that it is clear distinction between the side that initiated the connection, or accepted the connection. This method is thread-safe.

Specified by:

isClientMode in interface Channel

Returns:

true if this channel is in client-mode, false when in server-mode.

See Also:

SSLEngine.getUseClientMode()

attributeMap

public ConcurrentMap attributeMap()

Description copied from interface: Channel

Returns the attribute map. Attribute map can be used to store data into a socket. For example to find the Connection for a Channel, one can store the Connection in this channel using some well known key.

Specified by:

attributeMap in interface Channel

Returns:

the attribute map.

socket

public Socket socket()

Specified by:

socket in interface Channel

See Also:

This method will be removed from the interface. Only an explicit cast to NioChannel will expose the Socket. It is very important that the socket isn't closed directly; but one goes through the {@link #close()} method so that interal administration of the channel is in sync with that of the socket.

socketChannel

public SocketChannel socketChannel()

remoteSocketAddress

public SocketAddress remoteSocketAddress()

Specified by:

remoteSocketAddress in interface Channel

Returns:

the remote address. Returned value could be null.

localSocketAddress

public SocketAddress localSocketAddress()

Specified by:

localSocketAddress in interface Channel

Returns:

the local address. Returned value could be null

connect

public void connect(InetSocketAddress address,
                    int timeoutMillis)
             throws IOException

Description copied from interface: Channel

Connects the channel. This call should only be made once and is not threadsafe. This call blocks until:

1. the connect succeeds
2. the connect fails
3. if there is a timeout.

In case of failure, channel is closed automatically and exception is thrown to user.

Specified by:

connect in interface Channel

Parameters:

address - the address to connect to.

timeoutMillis - the timeout in millis, or 0 if waiting indefinitely.

Throws:

IOException - if connecting fails.

onConnect

protected void onConnect()

Template method that can be implemented when the connect(InetSocketAddress, int) has completed.

isClosed

public boolean isClosed()

Description copied from interface: Channel

Checks if this Channel is closed. This method is very cheap to make.

Specified by:

isClosed in interface Channel

Returns:

true if closed, false otherwise.

close

public void close()
           throws IOException

Description copied from interface: Channel

Closes the Channel. This method is thread-safe. This method can safely be called from an IO thread. Close-listeners will not be executed on an IO thread. When the channel already is closed, the call is ignored.

Specified by:

close in interface Channel

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

close0

protected void close0()
               throws IOException

Template method that is called when the Channel is closed. It will be called only once.

Throws:

IOException

addCloseListener

public void addCloseListener(ChannelCloseListener listener)

Description copied from interface: Channel

Adds a ChannelCloseListener. This method is thread-safe.

Specified by:

addCloseListener in interface Channel

Parameters:

listener - the listener to register.

notifyCloseListeners

protected final void notifyCloseListeners()