View Javadoc

1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License.
18   *
19   */
20  package org.apache.mina.core.service;
21  
22  import java.util.EventListener;
23  
24  import org.apache.mina.core.session.IdleStatus;
25  import org.apache.mina.core.session.IoSession;
26  
27  /**
28   * Listens to events related to an {@link IoService}.
29   *
30   * @author The Apache MINA Project (dev@mina.apache.org)
31   * @version $Rev: 671827 $, $Date: 2008-06-26 10:49:48 +0200 (jeu, 26 jun 2008) $
32   */
33  public interface IoServiceListener extends EventListener {
34      /**
35       * Invoked when a new service is activated by an {@link IoService}.
36       *
37       * @param service the {@link IoService}
38       */
39      void serviceActivated(IoService service) throws Exception;
40      
41      /**
42       * Invoked when a service is idle.
43       */
44      void serviceIdle(IoService service, IdleStatus idleStatus) throws Exception;
45  
46      /**
47       * Invoked when a service is deactivated by an {@link IoService}.
48       *
49       * @param service the {@link IoService}
50       */
51      void serviceDeactivated(IoService service) throws Exception;
52  
53      /**
54       * Invoked when a new session is created by an {@link IoService}.
55       *
56       * @param session the new session
57       */
58      void sessionCreated(IoSession session) throws Exception;
59  
60      /**
61       * Invoked when a session is being destroyed by an {@link IoService}.
62       *
63       * @param session the session to be destroyed
64       */
65      void sessionDestroyed(IoSession session) throws Exception;
66  }