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.service.executor;
21  
22  import org.apache.mina.api.IoHandler;
23  import org.apache.mina.api.IoSession;
24  
25  /**
26   * A {@link IoHandler} event to be submitted to an {@link IoHandlerExecutor}.
27   * 
28   * Use the visitor pattern for implementing different behaviour for different events : <a
29   * href="http://en.wikipedia.org/wiki/Visitor_pattern">visitor pattern"</a>
30   * 
31   * @author <a href="http://mina.apache.org">Apache MINA Project</a>
32   */
33  public interface Event {
34  
35      /**
36       * The session of this event.
37       * 
38       * @return the session (cannot be null)
39       */
40      IoSession getSession();
41  
42      /**
43       * Call the visitor method for this kind of event.
44       * 
45       * @param visitor the vistor to call
46       */
47      void visit(EventVisitor visitor);
48  }