com.hazelcast.nio.tcp.nonblocking

Class NonBlockingSocketWriter

java.lang.Object

com.hazelcast.nio.tcp.nonblocking.AbstractHandler

com.hazelcast.nio.tcp.nonblocking.NonBlockingSocketWriter

All Implemented Interfaces:

MigratableHandler, SelectionHandler, SocketWriter, Runnable

public final class NonBlockingSocketWriter
extends AbstractHandler
implements Runnable, SocketWriter

The writing side of the TcpIpConnection.

Field Summary

Fields inherited from class com.hazelcast.nio.tcp.nonblocking.AbstractHandler

connection, connectionManager, ioService, ioThread, logger, selectionKey, selector, socketChannel

Method Summary

Methods

Modifier and Type	Method and Description
long	bytesPending()
long	getEventCount() Get number of events recorded by the current handler.
long	getLastWriteTimeMillis() Returns the last Clock.currentTimeMillis() that a write to the socket completed.
WriteHandler	getWriteHandler() Gets the WriteHandler that belongs to this SocketWriter.
void	handle() Called when there are bytes available for reading, or space available to write.
void	offer(OutboundFrame frame) Offers a Frame to be written to the socket.
long	priorityBytesPending()
void	requestMigration(NonBlockingIOThread newOwner) Requests the MigratableHandler to move to the new NonBlockingIOThread.
void	run()
void	setProtocol(String protocol) Sets the protocol this SocketWriter should use.
void	shutdown() Shuts down this SocketWriter.
void	start() Starts this SocketWriter.
String	toString()
int	totalFramesPending() Returns the total number of packets (urgent and non normal priority) pending to be written to the socket.

Methods inherited from class com.hazelcast.nio.tcp.nonblocking.AbstractHandler

getOwner, getSelectionKey, onFailure

Methods inherited from class java.lang.Object

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

Method Detail

totalFramesPending

public int totalFramesPending()

Description copied from interface: SocketWriter

Returns the total number of packets (urgent and non normal priority) pending to be written to the socket.

Specified by:

totalFramesPending in interface SocketWriter

Returns:

total number of pending packets.

getLastWriteTimeMillis

public long getLastWriteTimeMillis()

Description copied from interface: SocketWriter

Returns the last Clock.currentTimeMillis() that a write to the socket completed. Writing to the socket doesn't mean that data has been send or received; it means that data was written to the SocketChannel. It could very well be that this data is stuck somewhere in an io-buffer.

Specified by:

getLastWriteTimeMillis in interface SocketWriter

Returns:

the last time something was written to the socket.

getWriteHandler

public WriteHandler getWriteHandler()

Description copied from interface: SocketWriter

Gets the WriteHandler that belongs to this SocketWriter. This method exists for the TextReadHandler, but probably should be deleted.

Specified by:

getWriteHandler in interface SocketWriter

Returns:

the WriteHandler

bytesPending

public long bytesPending()

priorityBytesPending

public long priorityBytesPending()

setProtocol

public void setProtocol(String protocol)

Description copied from interface: SocketWriter

Sets the protocol this SocketWriter should use. This should be called only once at the beginning of the connection. See Protocols

Specified by:

setProtocol in interface SocketWriter

Parameters:

protocol - the protocol

offer

public void offer(OutboundFrame frame)

Description copied from interface: SocketWriter

Offers a Frame to be written to the socket. No guarantees are made that the frame is going to be written or received by the other side. todo: the name offer is misleading since it doesn't return a boolean.

Specified by:

offer in interface SocketWriter

Parameters:

frame - the Frame to write.

getEventCount

public long getEventCount()

Description copied from interface: MigratableHandler

Get number of events recorded by the current handler. It can be used to calculate whether this handler should be migrated to a different NonBlockingIOThread

Specified by:

getEventCount in interface MigratableHandler

Returns:

total number of events recorded by this handler

handle

public void handle()
            throws Exception

Description copied from interface: SelectionHandler

Called when there are bytes available for reading, or space available to write. Any exception that leads to a termination of the connection like an IOException should not be handled in the handle method but should be propagated. The reason behind this is that the handle logic already is complicated enough and by pulling it out the flow will be easier to understand.

Specified by:

handle in interface SelectionHandler

Throws:

Exception

run

public void run()

Specified by:

run in interface Runnable

shutdown

public void shutdown()

Description copied from interface: SocketWriter

Shuts down this SocketWriter. This method can be called from an arbitrary thread.

Specified by:

shutdown in interface SocketWriter

See Also:

SocketWriter.start()

start

public void start()

Description copied from interface: SocketWriter

Starts this SocketWriter. This method can be called from an arbitrary thread.

Specified by:

start in interface SocketWriter

See Also:

SocketWriter.shutdown()

requestMigration

public void requestMigration(NonBlockingIOThread newOwner)

Description copied from interface: MigratableHandler

Requests the MigratableHandler to move to the new NonBlockingIOThread. This call will not wait for the migration to complete. This method can be called by any thread, and will probably be called by the IOBalancer. Call is ignored when handler is moving to the same NonBlockingIOThread.

Specified by:

requestMigration in interface MigratableHandler

Parameters:

newOwner - the NonBlockingIOThread that is going to own this MigratableHandler

toString

public String toString()

Overrides:

toString in class Object