com.hazelcast.nio.tcp

Interface SocketWriter

All Known Implementing Classes:

NonBlockingSocketWriter, SpinningSocketWriter

public interface SocketWriter

Each TcpIpConnection has a SocketWriter and it writes OutboundFrame instances to the socket. Copying the Frame instances to the byte-buffer is done using the WriteHandler. Each TcpIpConnection has its own SocketWriter instance. Before Hazelcast 3.6 the name of this interface was WriteHandler.

See Also:

SocketReader, ReadHandler, IOThreadingModel

Method Summary

Methods

Modifier and Type	Method and Description
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.
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.

Method Detail

totalFramesPending

int totalFramesPending()

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

Returns:

total number of pending packets.

getLastWriteTimeMillis

long getLastWriteTimeMillis()

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.

Returns:

the last time something was written to the socket.

offer

void offer(OutboundFrame frame)

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.

Parameters:

frame - the Frame to write.

getWriteHandler

WriteHandler getWriteHandler()

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

Returns:

the WriteHandler

setProtocol

void setProtocol(String protocol)

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

Parameters:

protocol - the protocol

start

void start()

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

See Also:

shutdown()

shutdown

void shutdown()

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

See Also:

start()