com.hazelcast.nio.tcp

Interface WriteHandler<F extends OutboundFrame>

Type Parameters:

F -

All Known Implementing Classes:

ClientWriteHandler, MemberWriteHandler, TextWriteHandler

public interface WriteHandler<F extends OutboundFrame>

Responsible for writing OutboundFrame to a ByteBuffer. Each SocketWriter will have its own WriteHandler instance. Therefor it doesn't need to be thread-safe. For more information about the WriteHandler (and handlers in generally), have a look at the ReadHandler.

See Also:

IOThreadingModel

Method Summary

Methods

Modifier and Type	Method and Description
boolean	onWrite(F frame, ByteBuffer dst) A callback to indicate that the Frame should be written to the destination ByteBuffer.

Method Detail

onWrite

boolean onWrite(F frame,
              ByteBuffer dst)
                throws Exception

A callback to indicate that the Frame should be written to the destination ByteBuffer. It could be that a Frame is too big to fit into the ByteBuffer in 1 go; in that case this call will be made for the same Frame multiple times until write returns true. It is up to the Frame to track where it needs to continue.

Parameters:

frame - the Frame to write

dst - the destination ByteBuffer

Returns:

true if the Frame is completely written

Throws:

Exception - if something fails while writing to ByteBuffer. When an exception is thrown, the TcpIpConnection is closed. There is no point continuing with a potentially corrupted stream.