org.apache.mina.core.session

Class AbstractIoSession.CloseAwareWriteQueue

java.lang.Object

org.apache.mina.core.session.AbstractIoSession.CloseAwareWriteQueue

All Implemented Interfaces:

WriteRequestQueue

Enclosing class:

AbstractIoSession

private class AbstractIoSession.CloseAwareWriteQueue
extends java.lang.Object
implements WriteRequestQueue

A queue which handles the CLOSE request. TODO : Check that when closing a session, all the pending requests are correctly sent.

Field Summary

Fields

Modifier and Type	Field and Description
private WriteRequestQueue	queue

Constructor Summary

Constructors

Constructor and Description
CloseAwareWriteQueue(WriteRequestQueue queue)

Method Summary

Modifier and Type	Method and Description
void	clear(IoSession session) Removes all the requests from this session's queue.
void	dispose(IoSession session) Disposes any releases associated with the specified session.
boolean	isEmpty(IoSession session) Tells if the WriteRequest queue is empty or not for a session
void	offer(IoSession session, WriteRequest e) Add a new WriteRequest to the session write's queue
WriteRequest	poll(IoSession session) Get the first request available in the queue for a session.
int	size() Returns the number of objects currently stored in the queue.

Methods inherited from class java.lang.Object

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

Field Detail

queue

private final WriteRequestQueue queue

Constructor Detail

CloseAwareWriteQueue

public CloseAwareWriteQueue(WriteRequestQueue queue)

Method Detail

poll

public WriteRequest poll(IoSession session)

Get the first request available in the queue for a session.

Specified by:

poll in interface WriteRequestQueue

Parameters:

session - The session

Returns:

The first available request, if any.

offer

public void offer(IoSession session,
                  WriteRequest e)

Add a new WriteRequest to the session write's queue

Specified by:

offer in interface WriteRequestQueue

Parameters:

session - The session

e - The writeRequest to add

isEmpty

public boolean isEmpty(IoSession session)

Tells if the WriteRequest queue is empty or not for a session

Specified by:

isEmpty in interface WriteRequestQueue

Parameters:

session - The session to check

Returns:

true if the writeRequest is empty

clear

public void clear(IoSession session)

Removes all the requests from this session's queue.

Specified by:

clear in interface WriteRequestQueue

Parameters:

session - The associated session

dispose

public void dispose(IoSession session)

Disposes any releases associated with the specified session. This method is invoked on disconnection.

Specified by:

dispose in interface WriteRequestQueue

Parameters:

session - The associated session

size

public int size()

Returns the number of objects currently stored in the queue.

Specified by:

size in interface WriteRequestQueue

Returns:

the size of the queue