com.hazelcast.nio.tcp.spinning

Class SpinningSocketWriter

java.lang.Object

com.hazelcast.nio.tcp.spinning.AbstractHandler

com.hazelcast.nio.tcp.spinning.SpinningSocketWriter

All Implemented Interfaces:

SocketWriter

public class SpinningSocketWriter
extends AbstractHandler
implements SocketWriter

Field Summary

Fields

Modifier and Type	Field and Description
Queue<OutboundFrame>	urgentWriteQueue
Queue<OutboundFrame>	writeQueue

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

connection, connectionManager, ioService

Constructor Summary

Constructors

Constructor and Description
SpinningSocketWriter(TcpIpConnection connection, MetricsRegistry metricsRegistry, ILogger logger)

Method Summary

Methods

Modifier and Type	Method and Description
long	bytesPending()
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	offer(OutboundFrame frame) Offers a Frame to be written to the socket.
long	priorityBytesPending()
void	setProtocol(String protocol) Sets the protocol this SocketWriter should use.
void	shutdown() Shuts down this SocketWriter.
void	start() Starts this SocketWriter.
int	totalFramesPending() Returns the total number of packets (urgent and non normal priority) pending to be written to the socket.
void	write()

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

onFailure

Methods inherited from class java.lang.Object

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

Field Detail

writeQueue

public final Queue<OutboundFrame> writeQueue

urgentWriteQueue

public final Queue<OutboundFrame> urgentWriteQueue

Constructor Detail

SpinningSocketWriter

public SpinningSocketWriter(TcpIpConnection connection,
                    MetricsRegistry metricsRegistry,
                    ILogger logger)

Method Detail

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.

bytesPending

public long bytesPending()

priorityBytesPending

public long priorityBytesPending()

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

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

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

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

write

public void write()
           throws Exception

Throws:

Exception