| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> *<a name="line.18"></a> |
| <span class="sourceLineNo">019</span> */<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>package org.apache.mina.core.service;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span><a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.mina.core.session.IdleStatus;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.mina.core.session.IoSession;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span><a name="line.26"></a> |
| <span class="sourceLineNo">027</span>/**<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * Handles all I/O events fired by MINA.<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> *<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * @author <a href="http://mina.apache.org">Apache MINA Project</a><a name="line.30"></a> |
| <span class="sourceLineNo">031</span> *<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * @see IoHandlerAdapter<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> */<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>public interface IoHandler {<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> /**<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * Invoked from an I/O processor thread when a new connection has been created.<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * Because this method is supposed to be called from the same thread that<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * handles I/O of multiple sessions, please implement this method to perform<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * tasks that consumes minimal amount of time such as socket parameter<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * and user-defined session attribute initialization.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * <a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * @param session The session being created<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * @throws Exception If we get an exception while processing the create event<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> */<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> void sessionCreated(IoSession session) throws Exception;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> /**<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * Invoked when a connection has been opened. This method is invoked after<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * {@link #sessionCreated(IoSession)}. The biggest difference from<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * {@link #sessionCreated(IoSession)} is that it's invoked from other thread<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * than an I/O processor thread once thread model is configured properly.<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * <a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * @param session The session being opened<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * @throws Exception If we get an exception while processing the open event<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> */<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> void sessionOpened(IoSession session) throws Exception;<a name="line.56"></a> |
| <span class="sourceLineNo">057</span><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> /**<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * Invoked when a connection is closed.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * <a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * @param session The session being closed<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * @throws Exception If we get an exception while processing the close event<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> */<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> void sessionClosed(IoSession session) throws Exception;<a name="line.64"></a> |
| <span class="sourceLineNo">065</span><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> /**<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * Invoked with the related {@link IdleStatus} when a connection becomes idle.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * This method is not invoked if the transport type is UDP; it's a known bug,<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * and will be fixed in 2.0.<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * <a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * @param session The idling session <a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * @param status The session's status<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * @throws Exception If we get an exception while processing the idle event<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> */<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> void sessionIdle(IoSession session, IdleStatus status) throws Exception;<a name="line.75"></a> |
| <span class="sourceLineNo">076</span><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> /**<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * Invoked when any exception is thrown by user {@link IoHandler}<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * implementation or by MINA. If <code>cause</code> is an instance of<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * {@link IOException}, MINA will close the connection automatically.<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * <a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * @param session The session for which we have got an exception<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * @param cause The exception that has been caught<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * @throws Exception If we get an exception while processing the caught exception<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> */<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> void exceptionCaught(IoSession session, Throwable cause) throws Exception;<a name="line.86"></a> |
| <span class="sourceLineNo">087</span><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> /**<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * Invoked when a message is received.<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * <a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * @param session The session that is receiving a message<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * @param message The received message<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * @throws Exception If we get an exception while processing the received message<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> */<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> void messageReceived(IoSession session, Object message) throws Exception;<a name="line.95"></a> |
| <span class="sourceLineNo">096</span><a name="line.96"></a> |
| <span class="sourceLineNo">097</span> /**<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * Invoked when a message written by {@link IoSession#write(Object)} is<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * sent out.<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * <a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * @param session The session that has sent a full message<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * @param message The sent message<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * @throws Exception If we get an exception while processing the sent message <a name="line.103"></a> |
| <span class="sourceLineNo">104</span> */<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> void messageSent(IoSession session, Object message) throws Exception;<a name="line.105"></a> |
| <span class="sourceLineNo">106</span><a name="line.106"></a> |
| <span class="sourceLineNo">107</span> /**<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * Handle the closure of an half-duplex TCP channel<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * <a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * @param session The session which input is being closed<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * @throws Exception If we get an exception while closing the input<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> */<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> void inputClosed(IoSession session) throws Exception;<a name="line.113"></a> |
| <span class="sourceLineNo">114</span>}<a name="line.114"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
