com.gigaspaces.lrmi.nio

Class Writer

java.lang.Object

com.gigaspaces.lrmi.nio.Writer

All Implemented Interfaces:

IChannelWriter

public class Writer
extends Object
implements IChannelWriter

A Writer is capable of writing Request Packets and Reply Packets to a Socket Channel. An NIO Client Peer uses an instance of a Writer to write Request Packets while an NIO Server uses an instance of a Writer to write Reply Packets.

Since:

4.0

Author:

Igor Goldenberg

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Writer.ChannelEntryContext
static class	Writer.Context
static class	Writer.SystemResponseContext

Constructor Summary

Constructors

Constructor and Description
Writer(SocketChannel sockChannel, int slowConsumerThroughput, int slowConsumerLatency, int slowConsumerRetries, IWriteInterestManager writeInterestManager)
Writer(SocketChannel sockChannel, IWriteInterestManager writeInterestManager)

Method Summary

Modifier and Type	Method and Description
void	closeContext()
SocketAddress	getEndPointAddress()
long	getGeneratedTraffic()
static LongAdder	getGeneratedTrafficCounter()
static LongAdder	getPendingWritesCounter()
boolean	isBlocking()
boolean	isOpen()
protected void	noneBlockingWrite(Writer.Context ctx)
void	onWriteEvent() Called from WriteSelectorThread to complete pending write requests.
void	resetContext()
void	setFilterManager(IOFilterManager filterManager)
void	setWriteInterestManager(IWriteInterestManager writeInterestManager) Do not call this method unless the last write was completed.
void	writeBytesToChannelBlocking(ByteBuffer dataBuffer)
void	writeBytesToChannelNoneBlocking(Writer.Context ctx, boolean restoreReadInterest)
void	writeProtocolValidationHeader()
void	writeReply(ReplyPacket packet)
void	writeReply(ReplyPacket packet, boolean reuseBuffer)
void	writeReply(ReplyPacket packet, boolean reuseBuffer, Writer.Context ctx)
void	writeRequest(RequestPacket packet)
void	writeRequest(RequestPacket packet, boolean reuseBuffer)
void	writeRequest(RequestPacket packet, boolean reuseBuffer, Writer.Context ctx)

Methods inherited from class java.lang.Object

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

Constructor Detail

Writer

public Writer(SocketChannel sockChannel,
              IWriteInterestManager writeInterestManager)

Writer

public Writer(SocketChannel sockChannel,
              int slowConsumerThroughput,
              int slowConsumerLatency,
              int slowConsumerRetries,
              IWriteInterestManager writeInterestManager)

Method Detail

getGeneratedTrafficCounter

public static LongAdder getGeneratedTrafficCounter()

getPendingWritesCounter

public static LongAdder getPendingWritesCounter()

setWriteInterestManager

public void setWriteInterestManager(IWriteInterestManager writeInterestManager)

Do not call this method unless the last write was completed. Otherwise you may have concurrency issues, this is because _writeInterestManager is used from the selector thread as well as from the user thread (you in this case) After the last write was completed the selector thread will not use _writeInterestManager until write is performed.

getEndPointAddress

public SocketAddress getEndPointAddress()

Returns:

the endpoint of the connected SocketChannel.

writeRequest

public void writeRequest(RequestPacket packet,
                         boolean reuseBuffer,
                         Writer.Context ctx)
                  throws IOException,
                         IOFilterException

Throws:

IOException

IOFilterException

writeRequest

public void writeRequest(RequestPacket packet,
                         boolean reuseBuffer)
                  throws IOException,
                         IOFilterException

Throws:

IOException

IOFilterException

writeRequest

public void writeRequest(RequestPacket packet)
                  throws IOException,
                         IOFilterException

Throws:

IOException

IOFilterException

writeReply

public void writeReply(ReplyPacket packet,
                       boolean reuseBuffer,
                       Writer.Context ctx)
                throws IOException,
                       IOFilterException

Throws:

IOException

IOFilterException

writeReply

public void writeReply(ReplyPacket packet,
                       boolean reuseBuffer)
                throws IOException,
                       IOFilterException

Throws:

IOException

IOFilterException

writeReply

public void writeReply(ReplyPacket packet)
                throws IOException,
                       IOFilterException

Throws:

IOException

IOFilterException

isOpen

public boolean isOpen()

setFilterManager

public void setFilterManager(IOFilterManager filterManager)

Specified by:

setFilterManager in interface IChannelWriter

isBlocking

public boolean isBlocking()

Specified by:

isBlocking in interface IChannelWriter

writeBytesToChannelNoneBlocking

public void writeBytesToChannelNoneBlocking(Writer.Context ctx,
                                            boolean restoreReadInterest)
                                     throws IOException

Specified by:

writeBytesToChannelNoneBlocking in interface IChannelWriter

Throws:

IOException

noneBlockingWrite

protected void noneBlockingWrite(Writer.Context ctx)
                          throws IOException

Throws:

IOException

writeBytesToChannelBlocking

public void writeBytesToChannelBlocking(ByteBuffer dataBuffer)
                                 throws IOException,
                                        ClosedChannelException,
                                        SlowConsumerException

Specified by:

writeBytesToChannelBlocking in interface IChannelWriter

Throws:

IOException

ClosedChannelException

SlowConsumerException

onWriteEvent

public void onWriteEvent()
                  throws IOException

Called from WriteSelectorThread to complete pending write requests. This is synchronized to ensure mutual exclusion with writeBytesToChannelNoneBlocking method

Throws:

IOException

See Also:

noneBlockingWrite(com.gigaspaces.lrmi.nio.Writer.Context)

closeContext

public void closeContext()

resetContext

public void resetContext()

getGeneratedTraffic

public long getGeneratedTraffic()

writeProtocolValidationHeader

public void writeProtocolValidationHeader()
                                   throws IOException

Throws:

IOException