| <!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.util.Map;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.Set;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.mina.core.IoUtil;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.mina.core.filterchain.DefaultIoFilterChainBuilder;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.mina.core.filterchain.IoFilterChain;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.mina.core.filterchain.IoFilterChainBuilder;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.mina.core.future.WriteFuture;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.mina.core.session.IoSession;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.mina.core.session.IoSessionConfig;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.mina.core.session.IoSessionDataStructureFactory;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span><a name="line.33"></a> |
| <span class="sourceLineNo">034</span>/**<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * Base interface for all {@link IoAcceptor}s and {@link IoConnector}s<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * that provide I/O service and manage {@link IoSession}s.<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> *<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * @author <a href="http://mina.apache.org">Apache MINA Project</a><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> */<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>public interface IoService {<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> /**<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * @return the {@link TransportMetadata} that this service runs on.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> */<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> TransportMetadata getTransportMetadata();<a name="line.44"></a> |
| <span class="sourceLineNo">045</span><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> /**<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * Adds an {@link IoServiceListener} that listens any events related with<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * this service.<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * <a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * @param listener The listener to add<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> */<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> void addListener(IoServiceListener listener);<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> /**<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * Removed an existing {@link IoServiceListener} that listens any events<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * related with this service.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * <a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * @param listener The listener to use<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> */<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> void removeListener(IoServiceListener listener);<a name="line.60"></a> |
| <span class="sourceLineNo">061</span><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> /**<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * @return <tt>true</tt> if and if only {@link #dispose()} method has<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * been called. Please note that this method will return <tt>true</tt><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * even after all the related resources are released.<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> */<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> boolean isDisposing();<a name="line.67"></a> |
| <span class="sourceLineNo">068</span><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> /**<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * @return <tt>true</tt> if and if only all resources of this processor<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * have been disposed.<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> */<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> boolean isDisposed();<a name="line.73"></a> |
| <span class="sourceLineNo">074</span><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> /**<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * Releases any resources allocated by this service. Please note that<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * this method might block as long as there are any sessions managed by<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * this service.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> */<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> void dispose();<a name="line.80"></a> |
| <span class="sourceLineNo">081</span><a name="line.81"></a> |
| <span class="sourceLineNo">082</span> /**<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * Releases any resources allocated by this service. Please note that<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * this method might block as long as there are any sessions managed by this service.<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> *<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * Warning : calling this method from a IoFutureListener with <code>awaitTermination</code> = true<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * will probably lead to a deadlock.<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> *<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * @param awaitTermination When true this method will block until the underlying ExecutorService is terminated<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> */<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> void dispose(boolean awaitTermination);<a name="line.91"></a> |
| <span class="sourceLineNo">092</span><a name="line.92"></a> |
| <span class="sourceLineNo">093</span> /**<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * @return the handler which will handle all connections managed by this service.<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> */<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> IoHandler getHandler();<a name="line.96"></a> |
| <span class="sourceLineNo">097</span><a name="line.97"></a> |
| <span class="sourceLineNo">098</span> /**<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * Sets the handler which will handle all connections managed by this service.<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * <a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * @param handler The IoHandler to use<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> */<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> void setHandler(IoHandler handler);<a name="line.103"></a> |
| <span class="sourceLineNo">104</span><a name="line.104"></a> |
| <span class="sourceLineNo">105</span> /**<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * @return the map of all sessions which are currently managed by this<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * service. The key of map is the {@link IoSession#getId() ID} of the<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * session. An empty collection if there's no session.<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> */<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> Map<Long, IoSession> getManagedSessions();<a name="line.110"></a> |
| <span class="sourceLineNo">111</span><a name="line.111"></a> |
| <span class="sourceLineNo">112</span> /**<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * @return the number of all sessions which are currently managed by this<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * service.<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> */<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> int getManagedSessionCount();<a name="line.116"></a> |
| <span class="sourceLineNo">117</span><a name="line.117"></a> |
| <span class="sourceLineNo">118</span> /**<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * @return the default configuration of the new {@link IoSession}s<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * created by this service.<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> */<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> IoSessionConfig getSessionConfig();<a name="line.122"></a> |
| <span class="sourceLineNo">123</span><a name="line.123"></a> |
| <span class="sourceLineNo">124</span> /**<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * @return the {@link IoFilterChainBuilder} which will build the<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * {@link IoFilterChain} of all {@link IoSession}s which is created<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * by this service.<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * The default value is an empty {@link DefaultIoFilterChainBuilder}.<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> */<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> IoFilterChainBuilder getFilterChainBuilder();<a name="line.130"></a> |
| <span class="sourceLineNo">131</span><a name="line.131"></a> |
| <span class="sourceLineNo">132</span> /**<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * Sets the {@link IoFilterChainBuilder} which will build the<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * {@link IoFilterChain} of all {@link IoSession}s which is created<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * by this service.<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * If you specify <tt>null</tt> this property will be set to<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * an empty {@link DefaultIoFilterChainBuilder}.<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * <a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * @param builder The filter chain builder to use<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> */<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> void setFilterChainBuilder(IoFilterChainBuilder builder);<a name="line.141"></a> |
| <span class="sourceLineNo">142</span><a name="line.142"></a> |
| <span class="sourceLineNo">143</span> /**<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * A shortcut for <tt>( ( DefaultIoFilterChainBuilder ) </tt>{@link #getFilterChainBuilder()}<tt> )</tt>.<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * Please note that the returned object is not a <b>real</b> {@link IoFilterChain}<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * but a {@link DefaultIoFilterChainBuilder}. Modifying the returned builder<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * won't affect the existing {@link IoSession}s at all, because<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> * {@link IoFilterChainBuilder}s affect only newly created {@link IoSession}s.<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> *<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * @return The filter chain in use<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * @throws IllegalStateException if the current {@link IoFilterChainBuilder} is<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * not a {@link DefaultIoFilterChainBuilder}<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> */<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> DefaultIoFilterChainBuilder getFilterChain();<a name="line.154"></a> |
| <span class="sourceLineNo">155</span><a name="line.155"></a> |
| <span class="sourceLineNo">156</span> /**<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * @return a value of whether or not this service is active<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> */<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> boolean isActive();<a name="line.159"></a> |
| <span class="sourceLineNo">160</span><a name="line.160"></a> |
| <span class="sourceLineNo">161</span> /**<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> * @return the time when this service was activated. It returns the last<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> * time when this service was activated if the service is not active now.<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> */<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> long getActivationTime();<a name="line.165"></a> |
| <span class="sourceLineNo">166</span><a name="line.166"></a> |
| <span class="sourceLineNo">167</span> /**<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> * Writes the specified {@code message} to all the {@link IoSession}s<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * managed by this service. This method is a convenience shortcut for<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * {@link IoUtil#broadcast(Object, Collection)}.<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> * <a name="line.171"></a> |
| <span class="sourceLineNo">172</span> * @param message the message to broadcast<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> * @return The set of WriteFuture associated to the message being broadcasted<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> */<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> Set<WriteFuture> broadcast(Object message);<a name="line.175"></a> |
| <span class="sourceLineNo">176</span><a name="line.176"></a> |
| <span class="sourceLineNo">177</span> /**<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * @return the {@link IoSessionDataStructureFactory} that provides<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> * related data structures for a new session created by this service.<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> */<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> IoSessionDataStructureFactory getSessionDataStructureFactory();<a name="line.181"></a> |
| <span class="sourceLineNo">182</span><a name="line.182"></a> |
| <span class="sourceLineNo">183</span> /**<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * Sets the {@link IoSessionDataStructureFactory} that provides<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * related data structures for a new session created by this service.<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> * <a name="line.186"></a> |
| <span class="sourceLineNo">187</span> * @param sessionDataStructureFactory The factory to use<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> */<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> void setSessionDataStructureFactory(IoSessionDataStructureFactory sessionDataStructureFactory);<a name="line.189"></a> |
| <span class="sourceLineNo">190</span><a name="line.190"></a> |
| <span class="sourceLineNo">191</span> /**<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> * @return The number of bytes scheduled to be written<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> */<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> int getScheduledWriteBytes();<a name="line.194"></a> |
| <span class="sourceLineNo">195</span><a name="line.195"></a> |
| <span class="sourceLineNo">196</span> /**<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> * @return The number of messages scheduled to be written<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> */<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> int getScheduledWriteMessages();<a name="line.199"></a> |
| <span class="sourceLineNo">200</span><a name="line.200"></a> |
| <span class="sourceLineNo">201</span> /**<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> * @return The statistics object for this service.<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> */<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> IoServiceStatistics getStatistics();<a name="line.204"></a> |
| <span class="sourceLineNo">205</span>}<a name="line.205"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
