org.apache.mina.common.support

Class BaseIoSession

java.lang.Object

org.apache.mina.common.support.BaseIoSession

All Implemented Interfaces:

IoSession

Direct Known Subclasses:

VmPipeSessionImpl

public abstract class BaseIoSession
extends Object
implements IoSession

Base implementation of IoSession.

Version:

$Rev: 592279 $, $Date: 2007-11-06 13:59:46 +0900 (Tue, 06 Nov 2007) $

Author:

The Apache Directory Project (mina-dev@directory.apache.org)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseIoSession()

Method Summary

Modifier and Type	Method and Description
CloseFuture	close() Closes this session immediately.
protected void	close0() Implement this method to perform real close operation.
boolean	containsAttribute(String key) Returns true if this session contains the attribute with the specified key.
Object	getAttachment() Returns an attachment of this session.
Object	getAttribute(String key) Returns the value of user-defined attribute of this session.
Set<String>	getAttributeKeys() Returns the set of keys of all user-defined attributes.
CloseFuture	getCloseFuture() Returns the CloseFuture of this session.
long	getCreationTime() Returns the time in millis when this session is created.
int	getIdleCount(IdleStatus status) Returns the number of the fired continuous sessionIdle events for the specified IdleStatus.
int	getIdleTime(IdleStatus status) Returns idle time for the specified type of idleness in seconds.
long	getIdleTimeInMillis(IdleStatus status) Returns idle time for the specified type of idleness in milliseconds.
long	getLastIdleTime(IdleStatus status) Returns the time in millis when the last sessionIdle event is fired for the specified IdleStatus.
long	getLastIoTime() Returns the time in millis when I/O occurred lastly.
long	getLastReadTime() Returns the time in millis when read operation occurred lastly.
long	getLastWriteTime() Returns the time in millis when write operation occurred lastly.
long	getReadBytes() Returns the total number of bytes which were read from this session.
long	getReadMessages() Returns the total number of messages which were read and decoded from this session.
int	getScheduledWriteBytes() Returns the number of bytes which are scheduled to be written to this session.
int	getScheduledWriteRequests() Returns the number of write requests which are scheduled to be written to this session.
TrafficMask	getTrafficMask() Returns the current TrafficMask of this session.
int	getWriteTimeout() Returns write timeout in seconds.
long	getWriteTimeoutInMillis() Returns write timeout in milliseconds.
long	getWrittenBytes() Returns the total number of bytes which were written to this session.
long	getWrittenMessages() Returns the total number of messages which were written and encoded by this session.
long	getWrittenWriteRequests() Returns the total number of write requests which were written to this session.
void	increaseIdleCount(IdleStatus status)
void	increaseReadBytes(int increment)
void	increaseReadMessages()
void	increaseScheduledWriteBytes(int increment)
void	increaseScheduledWriteRequests()
void	increaseWrittenBytes(int increment)
void	increaseWrittenMessages()
boolean	isClosing() Returns true if and only if this session is being closed (but not disconnected yet) or is closed.
boolean	isConnected() Returns true if this session is connected with remote peer.
boolean	isIdle(IdleStatus status) Returns true if this session is idle for the specified IdleStatus.
boolean	isScheduledForFlush()
Object	removeAttribute(String key) Removes a user-defined attribute with the specified key.
void	resumeRead() A shortcut method for IoSession.setTrafficMask(TrafficMask) that resumes read operations for this session.
void	resumeWrite() A shortcut method for IoSession.setTrafficMask(TrafficMask) that resumes write operations for this session.
Object	setAttachment(Object attachment) Sets an attachment of this session.
Object	setAttribute(String key) Sets a user defined attribute without a value.
Object	setAttribute(String key, Object value) Sets a user-defined attribute.
void	setIdleTime(IdleStatus status, int idleTime) Sets idle time for the specified type of idleness in seconds.
boolean	setScheduledForFlush(boolean flag)
void	setTrafficMask(TrafficMask trafficMask) Sets the TrafficMask of this session which will result the parent IoService to start to control the traffic of this session immediately.
void	setWriteTimeout(int writeTimeout) Sets write timeout in seconds.
void	suspendRead() A shortcut method for IoSession.setTrafficMask(TrafficMask) that suspends read operations for this session.
void	suspendWrite() A shortcut method for IoSession.setTrafficMask(TrafficMask) that suspends write operations for this session.
String	toString()
protected abstract void	updateTrafficMask() Signals the IoService that the TrafficMask of this session has been changed.
WriteFuture	write(Object message) Writes the specified message to remote peer.
WriteFuture	write(Object message, SocketAddress remoteAddress)
protected void	write0(IoFilter.WriteRequest writeRequest) Implement this method to perform real write operation with the specified writeRequest.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.mina.common.IoSession

getConfig, getFilterChain, getHandler, getLocalAddress, getRemoteAddress, getService, getServiceAddress, getServiceConfig, getTransportType

Constructor Detail

BaseIoSession

protected BaseIoSession()

Method Detail

isConnected

public boolean isConnected()

Description copied from interface: IoSession

Returns true if this session is connected with remote peer.

Specified by:

isConnected in interface IoSession

isClosing

public boolean isClosing()

Description copied from interface: IoSession

Returns true if and only if this session is being closed (but not disconnected yet) or is closed.

Specified by:

isClosing in interface IoSession

getCloseFuture

public CloseFuture getCloseFuture()

Description copied from interface: IoSession

Returns the CloseFuture of this session. This method returns the same instance whenever user calls it.

Specified by:

getCloseFuture in interface IoSession

isScheduledForFlush

public boolean isScheduledForFlush()

setScheduledForFlush

public boolean setScheduledForFlush(boolean flag)

close

public CloseFuture close()

Description copied from interface: IoSession

Closes this session immediately. This operation is asynthronous. Wait for the returned CloseFuture if you want to wait for the session actually closed.

Specified by:

close in interface IoSession

close0

protected void close0()

Implement this method to perform real close operation. By default, this method is implemented to set the future to 'closed' immediately.

write

public WriteFuture write(Object message)

Description copied from interface: IoSession

Writes the specified message to remote peer. This operation is asynchronous; IoHandler.messageSent(IoSession, Object) will be invoked when the message is actually sent to remote peer. You can also wait for the returned WriteFuture if you want to wait for the message actually written.

Specified by:

write in interface IoSession

write

public WriteFuture write(Object message,
                         SocketAddress remoteAddress)

write0

protected void write0(IoFilter.WriteRequest writeRequest)

Implement this method to perform real write operation with the specified writeRequest. By default, this method is implemented to set the future to 'not written' immediately.

Parameters:

writeRequest - Write request to make

getAttachment

public Object getAttachment()

Description copied from interface: IoSession

Returns an attachment of this session. This method is identical with getAttribute( "" ).

Specified by:

getAttachment in interface IoSession

setAttachment

public Object setAttachment(Object attachment)

Description copied from interface: IoSession

Sets an attachment of this session. This method is identical with setAttribute( "", attachment ).

Specified by:

setAttachment in interface IoSession

Returns:

Old attachment. null if it is new.

getAttribute

public Object getAttribute(String key)

Description copied from interface: IoSession

Returns the value of user-defined attribute of this session.

Specified by:

getAttribute in interface IoSession

Parameters:

key - the key of the attribute

Returns:

null if there is no attribute with the specified key

setAttribute

public Object setAttribute(String key,
                           Object value)

Description copied from interface: IoSession

Sets a user-defined attribute.

Specified by:

setAttribute in interface IoSession

Parameters:

key - the key of the attribute

value - the value of the attribute

Returns:

The old value of the attribute. null if it is new.

setAttribute

public Object setAttribute(String key)

Description copied from interface: IoSession

Sets a user defined attribute without a value. This is useful when you just want to put a 'mark' attribute. Its value is set to Boolean.TRUE.

Specified by:

setAttribute in interface IoSession

Parameters:

key - the key of the attribute

Returns:

The old value of the attribute. null if it is new.

removeAttribute

public Object removeAttribute(String key)

Description copied from interface: IoSession

Removes a user-defined attribute with the specified key.

Specified by:

removeAttribute in interface IoSession

Returns:

The old value of the attribute. null if not found.

containsAttribute

public boolean containsAttribute(String key)

Description copied from interface: IoSession

Returns true if this session contains the attribute with the specified key.

Specified by:

containsAttribute in interface IoSession

getAttributeKeys

public Set<String> getAttributeKeys()

Description copied from interface: IoSession

Returns the set of keys of all user-defined attributes.

Specified by:

getAttributeKeys in interface IoSession

getIdleTime

public int getIdleTime(IdleStatus status)

Description copied from interface: IoSession

Returns idle time for the specified type of idleness in seconds.

Specified by:

getIdleTime in interface IoSession

getIdleTimeInMillis

public long getIdleTimeInMillis(IdleStatus status)

Description copied from interface: IoSession

Returns idle time for the specified type of idleness in milliseconds.

Specified by:

getIdleTimeInMillis in interface IoSession

setIdleTime

public void setIdleTime(IdleStatus status,
                        int idleTime)

Description copied from interface: IoSession

Sets idle time for the specified type of idleness in seconds.

Specified by:

setIdleTime in interface IoSession

getWriteTimeout

public int getWriteTimeout()

Description copied from interface: IoSession

Returns write timeout in seconds.

Specified by:

getWriteTimeout in interface IoSession

getWriteTimeoutInMillis

public long getWriteTimeoutInMillis()

Description copied from interface: IoSession

Returns write timeout in milliseconds.

Specified by:

getWriteTimeoutInMillis in interface IoSession

setWriteTimeout

public void setWriteTimeout(int writeTimeout)

Description copied from interface: IoSession

Sets write timeout in seconds.

Specified by:

setWriteTimeout in interface IoSession

getTrafficMask

public TrafficMask getTrafficMask()

Description copied from interface: IoSession

Returns the current TrafficMask of this session.

Specified by:

getTrafficMask in interface IoSession

setTrafficMask

public void setTrafficMask(TrafficMask trafficMask)

Description copied from interface: IoSession

Sets the TrafficMask of this session which will result the parent IoService to start to control the traffic of this session immediately.

Specified by:

setTrafficMask in interface IoSession

suspendRead

public void suspendRead()

Description copied from interface: IoSession

A shortcut method for IoSession.setTrafficMask(TrafficMask) that suspends read operations for this session.

Specified by:

suspendRead in interface IoSession

suspendWrite

public void suspendWrite()

Description copied from interface: IoSession

A shortcut method for IoSession.setTrafficMask(TrafficMask) that suspends write operations for this session.

Specified by:

suspendWrite in interface IoSession

resumeRead

public void resumeRead()

Description copied from interface: IoSession

A shortcut method for IoSession.setTrafficMask(TrafficMask) that resumes read operations for this session.

Specified by:

resumeRead in interface IoSession

resumeWrite

public void resumeWrite()

Description copied from interface: IoSession

A shortcut method for IoSession.setTrafficMask(TrafficMask) that resumes write operations for this session.

Specified by:

resumeWrite in interface IoSession

updateTrafficMask

protected abstract void updateTrafficMask()

Signals the IoService that the TrafficMask of this session has been changed.

getReadBytes

public long getReadBytes()

Description copied from interface: IoSession

Returns the total number of bytes which were read from this session.

Specified by:

getReadBytes in interface IoSession

getWrittenBytes

public long getWrittenBytes()

Description copied from interface: IoSession

Returns the total number of bytes which were written to this session.

Specified by:

getWrittenBytes in interface IoSession

getWrittenWriteRequests

public long getWrittenWriteRequests()

Description copied from interface: IoSession

Returns the total number of write requests which were written to this session.

Specified by:

getWrittenWriteRequests in interface IoSession

getReadMessages

public long getReadMessages()

Description copied from interface: IoSession

Returns the total number of messages which were read and decoded from this session.

Specified by:

getReadMessages in interface IoSession

getWrittenMessages

public long getWrittenMessages()

Description copied from interface: IoSession

Returns the total number of messages which were written and encoded by this session.

Specified by:

getWrittenMessages in interface IoSession

getScheduledWriteBytes

public int getScheduledWriteBytes()

Description copied from interface: IoSession

Returns the number of bytes which are scheduled to be written to this session.

Specified by:

getScheduledWriteBytes in interface IoSession

getScheduledWriteRequests

public int getScheduledWriteRequests()

Description copied from interface: IoSession

Returns the number of write requests which are scheduled to be written to this session.

Specified by:

getScheduledWriteRequests in interface IoSession

increaseReadBytes

public void increaseReadBytes(int increment)

increaseWrittenBytes

public void increaseWrittenBytes(int increment)

increaseReadMessages

public void increaseReadMessages()

increaseWrittenMessages

public void increaseWrittenMessages()

increaseScheduledWriteBytes

public void increaseScheduledWriteBytes(int increment)

increaseScheduledWriteRequests

public void increaseScheduledWriteRequests()

getCreationTime

public long getCreationTime()

Description copied from interface: IoSession

Returns the time in millis when this session is created.

Specified by:

getCreationTime in interface IoSession

getLastIoTime

public long getLastIoTime()

Description copied from interface: IoSession

Returns the time in millis when I/O occurred lastly.

Specified by:

getLastIoTime in interface IoSession

getLastReadTime

public long getLastReadTime()

Description copied from interface: IoSession

Returns the time in millis when read operation occurred lastly.

Specified by:

getLastReadTime in interface IoSession

getLastWriteTime

public long getLastWriteTime()

Description copied from interface: IoSession

Returns the time in millis when write operation occurred lastly.

Specified by:

getLastWriteTime in interface IoSession

isIdle

public boolean isIdle(IdleStatus status)

Description copied from interface: IoSession

Returns true if this session is idle for the specified IdleStatus.

Specified by:

isIdle in interface IoSession

getIdleCount

public int getIdleCount(IdleStatus status)

Description copied from interface: IoSession

Returns the number of the fired continuous sessionIdle events for the specified IdleStatus.

If sessionIdle event is fired first after some time after I/O, idleCount becomes 1. idleCount resets to 0 if any I/O occurs again, otherwise it increases to 2 and so on if sessionIdle event is fired again without any I/O between two (or more) sessionIdle events.

Specified by:

getIdleCount in interface IoSession

getLastIdleTime

public long getLastIdleTime(IdleStatus status)

Description copied from interface: IoSession

Returns the time in millis when the last sessionIdle event is fired for the specified IdleStatus.

Specified by:

getLastIdleTime in interface IoSession

increaseIdleCount

public void increaseIdleCount(IdleStatus status)

toString

public String toString()

Overrides:

toString in class Object