Interface SingleSessionIoHandler

  • All Known Implementing Classes:
    SingleSessionIoHandlerAdapter

    public interface SingleSessionIoHandler
    A session handler without an IoSession parameter for simplicity.

    A SingleSessionIoHandler is similar to an IoHandler with the notable difference that a SingleSessionIoHandler is used only by one session at a time. Thus, there is no IoSession parameter in the methods of this interface.

    Because events are passed to the session in order, it is possible to store conversational state as instance variables in this object.

    • Method Detail

      • sessionCreated

        void sessionCreated()
                     throws java.lang.Exception
        Invoked when the session is created. Initialize default socket parameters and user-defined attributes here.
        Throws:
        java.lang.Exception
        See Also:
        IoHandler.sessionCreated(IoSession)
      • sessionOpened

        void sessionOpened()
                    throws java.lang.Exception
        Invoked when the connection is opened. This method is not invoked if the transport type is UDP.
        Throws:
        java.lang.Exception
        See Also:
        IoHandler.sessionOpened(IoSession)
      • sessionClosed

        void sessionClosed()
                    throws java.lang.Exception
        Invoked when the connection is closed. This method is not invoked if the transport type is UDP.
        Throws:
        java.lang.Exception
        See Also:
        IoHandler.sessionClosed(IoSession)
      • sessionIdle

        void sessionIdle​(IdleStatus status)
                  throws java.lang.Exception
        Invoked when the connection is idle. Refer to IdleStatus. This method is not invoked if the transport type is UDP.
        Parameters:
        status - the type of idleness
        Throws:
        java.lang.Exception
        See Also:
        IoHandler.sessionIdle(IoSession, IdleStatus)
      • exceptionCaught

        void exceptionCaught​(java.lang.Throwable cause)
                      throws java.lang.Exception
        Invoked when any exception is thrown by user IoHandler implementation or by MINA. If cause is instanceof IOException, MINA will close the connection automatically.
        Parameters:
        cause - the caught exception
        Throws:
        java.lang.Exception
        See Also:
        IoHandler.exceptionCaught(IoSession, Throwable)
      • messageReceived

        void messageReceived​(java.lang.Object message)
                      throws java.lang.Exception
        Invoked when protocol message is received. Implement your protocol flow here.
        Parameters:
        message - the received message
        Throws:
        java.lang.Exception
        See Also:
        IoHandler.messageReceived(IoSession, Object)