org.apache.mina.handler.stream

Class StreamIoHandler

java.lang.Object

org.apache.mina.core.service.IoHandlerAdapter

org.apache.mina.handler.stream.StreamIoHandler

All Implemented Interfaces:

IoHandler

public abstract class StreamIoHandler
extends IoHandlerAdapter

A IoHandler that adapts asynchronous MINA events to stream I/O.

Please extend this class and implement processStreamIo(IoSession, InputStream, OutputStream) to execute your stream I/O logic; please note that you must forward the process request to other thread or thread pool.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	StreamIoHandler.StreamIoException

Field Summary

Fields

Modifier and Type	Field and Description
private static AttributeKey	KEY_IN
private static AttributeKey	KEY_OUT
private static org.slf4j.Logger	LOGGER
private int	readTimeout
private int	writeTimeout

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StreamIoHandler()

Method Summary

Modifier and Type	Method and Description
void	exceptionCaught(IoSession session, java.lang.Throwable cause) Forwards caught exceptions to input stream.
int	getReadTimeout() Returns read timeout in seconds.
int	getWriteTimeout() Returns write timeout in seconds.
void	messageReceived(IoSession session, java.lang.Object buf) Forwards read data to input stream.
protected abstract void	processStreamIo(IoSession session, java.io.InputStream in, java.io.OutputStream out) Implement this method to execute your stream I/O logic; please note that you must forward the process request to other thread or thread pool.
void	sessionClosed(IoSession session) Closes streams
void	sessionIdle(IoSession session, IdleStatus status) Handles read timeout.
void	sessionOpened(IoSession session) Initializes streams and timeout settings.
void	setReadTimeout(int readTimeout) Sets read timeout in seconds.
void	setWriteTimeout(int writeTimeout) Sets write timeout in seconds.

Methods inherited from class org.apache.mina.core.service.IoHandlerAdapter

inputClosed, messageSent, sessionCreated

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

KEY_IN

private static final AttributeKey KEY_IN

KEY_OUT

private static final AttributeKey KEY_OUT

readTimeout

private int readTimeout

writeTimeout

private int writeTimeout

Constructor Detail

StreamIoHandler

protected StreamIoHandler()

Method Detail

processStreamIo

protected abstract void processStreamIo(IoSession session,
                                        java.io.InputStream in,
                                        java.io.OutputStream out)

Implement this method to execute your stream I/O logic; please note that you must forward the process request to other thread or thread pool.

getReadTimeout

public int getReadTimeout()

Returns read timeout in seconds. The default value is 0 (disabled).

setReadTimeout

public void setReadTimeout(int readTimeout)

Sets read timeout in seconds. The default value is 0 (disabled).

getWriteTimeout

public int getWriteTimeout()

Returns write timeout in seconds. The default value is 0 (disabled).

setWriteTimeout

public void setWriteTimeout(int writeTimeout)

Sets write timeout in seconds. The default value is 0 (disabled).

sessionOpened

public void sessionOpened(IoSession session)

Initializes streams and timeout settings.

Specified by:

sessionOpened in interface IoHandler

Overrides:

sessionOpened in class IoHandlerAdapter

sessionClosed

public void sessionClosed(IoSession session)
                   throws java.lang.Exception

Closes streams

Specified by:

sessionClosed in interface IoHandler

Overrides:

sessionClosed in class IoHandlerAdapter

Throws:

java.lang.Exception

messageReceived

public void messageReceived(IoSession session,
                            java.lang.Object buf)

Forwards read data to input stream.

Specified by:

messageReceived in interface IoHandler

Overrides:

messageReceived in class IoHandlerAdapter

exceptionCaught

public void exceptionCaught(IoSession session,
                            java.lang.Throwable cause)

Forwards caught exceptions to input stream.

Specified by:

exceptionCaught in interface IoHandler

Overrides:

exceptionCaught in class IoHandlerAdapter

sessionIdle

public void sessionIdle(IoSession session,
                        IdleStatus status)

Handles read timeout.

Specified by:

sessionIdle in interface IoHandler

Overrides:

sessionIdle in class IoHandlerAdapter