com.hazelcast.internal.networking

Class AbstractChannel

java.lang.Object

com.hazelcast.internal.networking.AbstractChannel

All Implemented Interfaces:

Channel, Closeable, AutoCloseable

Direct Known Subclasses:

NioChannel, SpinningChannel

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 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.
void	closeInbound() Closes inbound.
void	closeOutbound() Closes outbound.
SocketAddress	getLocalSocketAddress()
SocketAddress	getRemoteSocketAddress()
boolean	isClientMode() Checks if this side is the Channel is in client mode or server mode.
boolean	isClosed() Checks if this Channel is closed.
protected void	onClose() Template method that is called when the socket channel closed.
int	read(ByteBuffer dst) This method will be removed from the Channel in the near future.
Socket	socket()
SocketChannel	socketChannel()
int	write(ByteBuffer src) This method will be removed from the Channel in the near future.

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

flush, lastReadTimeMillis, lastWriteTimeMillis, write

Field Detail

socketChannel

protected final SocketChannel socketChannel

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. 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.

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()

getRemoteSocketAddress

public SocketAddress getRemoteSocketAddress()

Specified by:

getRemoteSocketAddress in interface Channel

Returns:

the remote address. Returned value could be null.

getLocalSocketAddress

public SocketAddress getLocalSocketAddress()

Specified by:

getLocalSocketAddress in interface Channel

Returns:

the local address. Returned value could be null

read

public int read(ByteBuffer dst)
         throws IOException

Description copied from interface: Channel

This method will be removed from the Channel in the near future.

Specified by:

read in interface Channel

Throws:

IOException

See Also:

SocketChannel.read(ByteBuffer)

write

public int write(ByteBuffer src)
          throws IOException

Description copied from interface: Channel

This method will be removed from the Channel in the near future.

Specified by:

write in interface Channel

Throws:

IOException

See Also:

SocketChannel.write(ByteBuffer)

closeInbound

public void closeInbound()
                  throws IOException

Description copied from interface: Channel

Closes inbound.

Not thread safe. Should be called in channel reader thread.

Method will be removed once the TLS integration doesn't rely on subclassing this channel.

Specified by:

closeInbound in interface Channel

Throws:

IOException

closeOutbound

public void closeOutbound()
                   throws IOException

Description copied from interface: Channel

Closes outbound.

Not thread safe. Should be called in channel writer thread.

Method will be removed once the TLS integration doesn't rely on subclassing this channel.

Specified by:

closeOutbound in interface Channel

Throws:

IOException

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. 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

onClose

protected void onClose()
                throws IOException

Template method that is called when the socket channel closed. It is called before the socketChannel is closed.

It will be called only once.

Throws:

IOException

addCloseListener

public void addCloseListener(ChannelCloseListener listener)

Description copied from interface: Channel

Adds a ChannelCloseListener.

Specified by:

addCloseListener in interface Channel

Parameters:

listener - the listener to register.