org.apache.mina.integration.jmx

Interface IoSessionManagerMBean

Known Implementing Classes:
IoSessionManager

public interface IoSessionManagerMBean

MBean interface for the session manager, it's used for instrumenting IoSession

Method Summary

void
addFirstLoggingFilter()
add a logging filter at begining of the chain
void
addLastLoggingFilter()
add a logging filter at end of the chain
void
close()
close the session
long
getBothIdleTime()
read and write IDLE time
float
getByteReadThroughtput()
get the read bytes per second throughput works only if a stat collector is inspecting this session,
float
getByteWrittenThroughtput()
get the written bytes per second throughput works only if a stat collector is inspecting this session,
Date
getCreationTime()
when the session was created
String[]
getInstalledFilters()
get the list of filters installed in the filter chain
Date
getLastIoTime()
last time the session processed an IO
Date
getLastReadTime()
last time the session processed an read
Date
getLastWriteTime()
last time the session processed a write
float
getMessageReadThroughtput()
get the read messages per second throughput works only if a stat collector is inspecting this session, and only if a ProtocolDecoderFilter is used
float
getMessageWrittenThroughtput()
get the written messages per second throughput works only if a stat collector is inspecting this session, and only if a ProtocolDecoderFilter is used
long
getReadBytes()
bytes read from the beginning
long
getReadIdleTime()
read IDLE time
long
getReadMessages()
PDU decoded from the beginning.
long
getWriteIdleTime()
write IDLE time
long
getWrittenBytes()
bytes written from the beginning
long
getWrittenMessages()
PDU encoded from the beginning.
boolean
isConnected()
is the session is connected
void
removeFirstLoggingFilter()
remove the logging filter at begining of the chain
void
removeLastLoggingFilter()
remove the logging filter at end of the chain

Method Details

addFirstLoggingFilter

public void addFirstLoggingFilter()
add a logging filter at begining of the chain

addLastLoggingFilter

public void addLastLoggingFilter()
add a logging filter at end of the chain

close

public void close()
            throws InterruptedException
close the session

getBothIdleTime

public long getBothIdleTime()
read and write IDLE time
Returns:
idle time in milli-seconds

getByteReadThroughtput

public float getByteReadThroughtput()
get the read bytes per second throughput works only if a stat collector is inspecting this session,
Returns:
read bytes per seconds

getByteWrittenThroughtput

public float getByteWrittenThroughtput()
get the written bytes per second throughput works only if a stat collector is inspecting this session,
Returns:
written bytes per seconds

getCreationTime

public Date getCreationTime()
when the session was created
Returns:
the date of session creation

getInstalledFilters

public String[] getInstalledFilters()
get the list of filters installed in the filter chain
Returns:
array of filter names

getLastIoTime

public Date getLastIoTime()
last time the session processed an IO
Returns:
date of last IO

getLastReadTime

public Date getLastReadTime()
last time the session processed an read
Returns:
date of last read

getLastWriteTime

public Date getLastWriteTime()
last time the session processed a write
Returns:
date of last write

getMessageReadThroughtput

public float getMessageReadThroughtput()
get the read messages per second throughput works only if a stat collector is inspecting this session, and only if a ProtocolDecoderFilter is used
Returns:
read messages per seconds

getMessageWrittenThroughtput

public float getMessageWrittenThroughtput()
get the written messages per second throughput works only if a stat collector is inspecting this session, and only if a ProtocolDecoderFilter is used
Returns:
written messages per seconds

getReadBytes

public long getReadBytes()
bytes read from the beginning
Returns:
total of bytes read

getReadIdleTime

public long getReadIdleTime()
read IDLE time
Returns:
read idle time in milli-seconds

getReadMessages

public long getReadMessages()
PDU decoded from the beginning. Only revelent if a ProtocolCodecFilter is installed.
Returns:
Number of read messages

getWriteIdleTime

public long getWriteIdleTime()
write IDLE time
Returns:
write idle time in milli-seconds

getWrittenBytes

public long getWrittenBytes()
bytes written from the beginning
Returns:
total of bytes written

getWrittenMessages

public long getWrittenMessages()
PDU encoded from the beginning. Only revelent if a ProtocolCodecFilter is installed.
Returns:
Number of written messages

isConnected

public boolean isConnected()
is the session is connected
Returns:
connection status

removeFirstLoggingFilter

public void removeFirstLoggingFilter()
remove the logging filter at begining of the chain

removeLastLoggingFilter

public void removeLastLoggingFilter()
remove the logging filter at end of the chain