org.apache.mina.core.session

Class DummySession

java.lang.Object

org.apache.mina.core.session.AbstractIoSession

org.apache.mina.core.session.DummySession

All Implemented Interfaces:

IoSession

Direct Known Subclasses:

ProtocolCodecSession

public class DummySession
extends AbstractIoSession

A dummy IoSession for unit-testing or non-network-use of the classes that depends on IoSession.

Overriding I/O request methods

All I/O request methods (i.e. AbstractIoSession.close(), AbstractIoSession.write(Object) are final and therefore cannot be overridden, but you can always add your custom IoFilter to the IoFilterChain to intercept any I/O events and requests.

Author:

Apache MINA Project

Field Summary

Fields inherited from class org.apache.mina.core.session.AbstractIoSession

CLOSE_REQUEST, MESSAGE_SENT_REQUEST

Constructor Summary

Constructors

Constructor and Description
DummySession() Creates a new instance.

Method Summary

Modifier and Type	Method and Description
IoSessionConfig	getConfig()
IoFilterChain	getFilterChain()
IoHandler	getHandler()
SocketAddress	getLocalAddress()
IoProcessor<IoSession>	getProcessor()
SocketAddress	getRemoteAddress()
IoService	getService()
TransportMetadata	getTransportMetadata()
void	setConfig(IoSessionConfig config) Sets the configuration of this session.
void	setHandler(IoHandler handler) Sets the IoHandler which handles this session.
void	setLocalAddress(SocketAddress localAddress) Sets the socket address of local machine which is associated with this session.
void	setRemoteAddress(SocketAddress remoteAddress) Sets the socket address of remote peer.
void	setScheduledWriteBytes(int byteCount) Set the number of scheduled write bytes
void	setScheduledWriteMessages(int messages) Set the number of scheduled write messages
void	setService(IoService service) Sets the IoService which provides I/O service to this session.
void	setTransportMetadata(TransportMetadata transportMetadata) Sets the TransportMetadata that this session runs on.
void	updateThroughput(boolean force) Update all statistical properties related with throughput.

Methods inherited from class org.apache.mina.core.session.AbstractIoSession

close, close, closeNow, closeOnFlush, containsAttribute, decreaseReadBufferSize, decreaseScheduledBytesAndMessages, destroy, equals, getAttachment, getAttribute, getAttribute, getAttributeKeys, getAttributeMap, getBothIdleCount, getCloseFuture, getCreationTime, getCurrentWriteMessage, getCurrentWriteRequest, getId, getIdleCount, getLastBothIdleTime, getLastIdleTime, getLastIoTime, getLastReaderIdleTime, getLastReadTime, getLastWriterIdleTime, getLastWriteTime, getReadBytes, getReadBytesThroughput, getReaderIdleCount, getReadMessages, getReadMessagesThroughput, getScheduledWriteBytes, getScheduledWriteMessages, getServiceAddress, getWriteRequestQueue, getWriterIdleCount, getWrittenBytes, getWrittenBytesThroughput, getWrittenMessages, getWrittenMessagesThroughput, hashCode, increaseIdleCount, increaseReadBufferSize, increaseReadBytes, increaseReadMessages, increaseScheduledWriteBytes, increaseScheduledWriteMessages, increaseWrittenBytes, increaseWrittenMessages, isActive, isBothIdle, isClosing, isConnected, isIdle, isReaderIdle, isReadSuspended, isScheduledForFlush, isSecured, isServer, isWriterIdle, isWriteSuspended, notifyIdleness, notifyIdleSession, offerClosedReadFuture, offerFailedReadFuture, offerReadFuture, read, removeAttribute, removeAttribute, replaceAttribute, resumeRead, resumeWrite, scheduledForFlush, setAttachment, setAttribute, setAttribute, setAttributeIfAbsent, setAttributeIfAbsent, setAttributeMap, setCurrentWriteRequest, setScheduledForFlush, setWriteRequestQueue, suspendRead, suspendWrite, toString, unscheduledForFlush, updateThroughput, write, write

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DummySession

public DummySession()

Creates a new instance.

Method Detail

getConfig

public IoSessionConfig getConfig()

Specified by:

getConfig in interface IoSession

Overrides:

getConfig in class AbstractIoSession

Returns:

the configuration of this session.

setConfig

public void setConfig(IoSessionConfig config)

Sets the configuration of this session.

Parameters:

config - the IoSessionConfig to set

getFilterChain

public IoFilterChain getFilterChain()

Returns:

the filter chain that only affects this session.

getHandler

public IoHandler getHandler()

Specified by:

getHandler in interface IoSession

Overrides:

getHandler in class AbstractIoSession

Returns:

the IoHandler which handles this session.

setHandler

public void setHandler(IoHandler handler)

Sets the IoHandler which handles this session.

Parameters:

handler - the IoHandler to set

getLocalAddress

public SocketAddress getLocalAddress()

Returns:

the socket address of local machine which is associated with this session.

getRemoteAddress

public SocketAddress getRemoteAddress()

Returns:

the socket address of remote peer.

setLocalAddress

public void setLocalAddress(SocketAddress localAddress)

Sets the socket address of local machine which is associated with this session.

Parameters:

localAddress - The socket address to set

setRemoteAddress

public void setRemoteAddress(SocketAddress remoteAddress)

Sets the socket address of remote peer.

Parameters:

remoteAddress - The socket address to set

getService

public IoService getService()

Specified by:

getService in interface IoSession

Overrides:

getService in class AbstractIoSession

Returns:

the IoService which provides I/O service to this session.

setService

public void setService(IoService service)

Sets the IoService which provides I/O service to this session.

Parameters:

service - The IoService to set

getProcessor

public final IoProcessor<IoSession> getProcessor()

Specified by:

getProcessor in class AbstractIoSession

Returns:

The associated IoProcessor for this session

getTransportMetadata

public TransportMetadata getTransportMetadata()

Returns:

the TransportMetadata that this session runs on.

setTransportMetadata

public void setTransportMetadata(TransportMetadata transportMetadata)

Sets the TransportMetadata that this session runs on.

Parameters:

transportMetadata - The TransportMetadata to set

setScheduledWriteBytes

public void setScheduledWriteBytes(int byteCount)

Set the number of scheduled write bytes

Overrides:

setScheduledWriteBytes in class AbstractIoSession

Parameters:

byteCount - The number of scheduled bytes for write

setScheduledWriteMessages

public void setScheduledWriteMessages(int messages)

Set the number of scheduled write messages

Overrides:

setScheduledWriteMessages in class AbstractIoSession

Parameters:

messages - The number of scheduled messages for write

updateThroughput

public void updateThroughput(boolean force)

Update all statistical properties related with throughput. By default this method returns silently without updating the throughput properties if they were calculated already within last calculation interval. If, however, force is specified as true, this method updates the throughput properties immediately.

Parameters:

force - the flag that forces the update of properties immediately if true