org.apache.mina.filter.buffer

Class BufferedWriteFilter

java.lang.Object

org.apache.mina.core.filterchain.IoFilterAdapter

org.apache.mina.filter.buffer.BufferedWriteFilter

All Implemented Interfaces:

IoFilter

public final class BufferedWriteFilter
extends IoFilterAdapter

An IoFilter implementation used to buffer outgoing WriteRequest almost like what BufferedOutputStream does. Using this filter allows to be less dependent from network latency. It is also useful when a session is generating very small messages too frequently and consequently generating unnecessary traffic overhead. Please note that it should always be placed before the ProtocolCodecFilter as it only handles WriteRequest's carrying IoBuffer objects.

Since:

MINA 2.0.0-M2

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.mina.core.filterchain.IoFilter

IoFilter.NextFilter

Field Summary

Fields

Modifier and Type	Field and Description
private int	bufferSize The buffer size allocated for each new session's buffer.
private LazyInitializedCacheMap<IoSession,IoBuffer>	buffersMap The map that matches an IoSession and it's IoBuffer buffer.
static int	DEFAULT_BUFFER_SIZE Default buffer size value in bytes.
private org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
BufferedWriteFilter() Default constructor.
BufferedWriteFilter(int bufferSize) Constructor which sets buffer size to bufferSize.Uses a default instance of ConcurrentHashMap.
BufferedWriteFilter(int bufferSize, LazyInitializedCacheMap<IoSession,IoBuffer> buffersMap) Constructor which sets buffer size to bufferSize.

Method Summary

Modifier and Type	Method and Description
void	exceptionCaught(IoFilter.NextFilter nextFilter, IoSession session, java.lang.Throwable cause) Filters IoHandler.exceptionCaught(IoSession,Throwable) event.
void	filterWrite(IoFilter.NextFilter nextFilter, IoSession session, WriteRequest writeRequest) Filters IoSession.write(Object) method invocation.
void	flush(IoSession session) Flushes the buffered data.
private void	free(IoSession session) Internal method that actually frees the IoBuffer that contains the buffered data that has not been flushed.
int	getBufferSize() Returns buffer size.
private void	internalFlush(IoFilter.NextFilter nextFilter, IoSession session, IoBuffer buf) Internal method that actually flushes the buffered data.
void	sessionClosed(IoFilter.NextFilter nextFilter, IoSession session) Filters IoHandler.sessionClosed(IoSession) event.
void	setBufferSize(int bufferSize) Sets the buffer size but only for the newly created buffers.
private void	write(IoSession session, IoBuffer data) Writes an IoBuffer to the session's buffer.
private void	write(IoSession session, IoBuffer data, IoBuffer buf) Writes data IoBuffer to the buf IoBuffer which buffers write requests for the session until buffer is full or manually flushed.

Methods inherited from class org.apache.mina.core.filterchain.IoFilterAdapter

destroy, filterClose, init, inputClosed, messageReceived, messageSent, onPostAdd, onPostRemove, onPreAdd, onPreRemove, sessionCreated, sessionIdle, sessionOpened, toString

Methods inherited from class java.lang.Object

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

Field Detail

logger

private final org.slf4j.Logger logger

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

Default buffer size value in bytes.

See Also:

Constant Field Values

bufferSize

private int bufferSize

The buffer size allocated for each new session's buffer.

buffersMap

private final LazyInitializedCacheMap<IoSession,IoBuffer> buffersMap

The map that matches an IoSession and it's IoBuffer buffer.

Constructor Detail

BufferedWriteFilter

public BufferedWriteFilter()

Default constructor. Sets buffer size to DEFAULT_BUFFER_SIZE bytes. Uses a default instance of ConcurrentHashMap.

BufferedWriteFilter

public BufferedWriteFilter(int bufferSize)

Constructor which sets buffer size to bufferSize.Uses a default instance of ConcurrentHashMap.

Parameters:

bufferSize - the new buffer size

BufferedWriteFilter

public BufferedWriteFilter(int bufferSize,
                           LazyInitializedCacheMap<IoSession,IoBuffer> buffersMap)

Constructor which sets buffer size to bufferSize. If buffersMap is null then a default instance of ConcurrentHashMap is created else the provided instance is used.

Parameters:

bufferSize - the new buffer size

buffersMap - the map to use for storing each session buffer

Method Detail

getBufferSize

public int getBufferSize()

Returns buffer size.

setBufferSize

public void setBufferSize(int bufferSize)

Sets the buffer size but only for the newly created buffers.

Parameters:

bufferSize - the new buffer size

filterWrite

public void filterWrite(IoFilter.NextFilter nextFilter,
                        IoSession session,
                        WriteRequest writeRequest)
                 throws java.lang.Exception

Filters IoSession.write(Object) method invocation.

Specified by:

filterWrite in interface IoFilter

Overrides:

filterWrite in class IoFilterAdapter

Parameters:

nextFilter - the IoFilter.NextFilter for this filter. You can reuse this object until this filter is removed from the chain.

session - The IoSession which has to process this invocation

writeRequest - The WriteRequest to process

Throws:

java.lang.Exception - if writeRequest.message isn't an IoBuffer instance.

write

private void write(IoSession session,
                   IoBuffer data)

Writes an IoBuffer to the session's buffer.

Parameters:

session - the session to which a write is requested

data - the data to buffer

write

private void write(IoSession session,
                   IoBuffer data,
                   IoBuffer buf)

Writes data IoBuffer to the buf IoBuffer which buffers write requests for the session until buffer is full or manually flushed.

Parameters:

session - the session where buffer will be written

data - the data to buffer

buf - the buffer where data will be temporarily written

internalFlush

private void internalFlush(IoFilter.NextFilter nextFilter,
                           IoSession session,
                           IoBuffer buf)
                    throws java.lang.Exception

Internal method that actually flushes the buffered data.

Parameters:

nextFilter - the NextFilter of this filter

session - the session where buffer will be written

buf - the data to write

Throws:

java.lang.Exception - if a write operation fails

flush

public void flush(IoSession session)

Flushes the buffered data.

Parameters:

session - the session where buffer will be written

free

private void free(IoSession session)

Internal method that actually frees the IoBuffer that contains the buffered data that has not been flushed.

Parameters:

session - the session we operate on

exceptionCaught

public void exceptionCaught(IoFilter.NextFilter nextFilter,
                            IoSession session,
                            java.lang.Throwable cause)
                     throws java.lang.Exception

Filters IoHandler.exceptionCaught(IoSession,Throwable) event.

Specified by:

exceptionCaught in interface IoFilter

Overrides:

exceptionCaught in class IoFilterAdapter

Parameters:

nextFilter - the IoFilter.NextFilter for this filter. You can reuse this object until this filter is removed from the chain.

session - The IoSession which has received this event

cause - The exception that cause this event to be received

Throws:

java.lang.Exception

sessionClosed

public void sessionClosed(IoFilter.NextFilter nextFilter,
                          IoSession session)
                   throws java.lang.Exception

Filters IoHandler.sessionClosed(IoSession) event.

Specified by:

sessionClosed in interface IoFilter

Overrides:

sessionClosed in class IoFilterAdapter

Parameters:

nextFilter - the IoFilter.NextFilter for this filter. You can reuse this object until this filter is removed from the chain.

session - The IoSession which has received this event

Throws:

java.lang.Exception