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.handler.demux;
21  
22  import org.apache.mina.common.IoSession;
23  
24  /**
25   * A handler interface that {@link DemuxingIoHandler} forwards
26   * <code>messageReceived</code> events to.  You have to register your
27   * handler with the type of message you want to get notified using
28   * {@link DemuxingIoHandler#addMessageHandler(Class, MessageHandler)}.
29   * 
30   * @author The Apache Directory Project (mina-dev@directory.apache.org)
31   * @version $Rev: 555855 $, $Date: 2007-07-13 12:19:00 +0900 (금, 13  7월 2007) $
32   */
33  public interface MessageHandler {
34      /**
35       * A {@link MessageHandler} that does nothing.  This is usefule when
36       * you want to ignore messages of the specific type silently.
37       */
38      static MessageHandler NOOP = new MessageHandler() {
39          public void messageReceived(IoSession session, Object message) {
40          }
41      };
42  
43      /**
44       * Invoked when the specific type of message is received from the
45       * specified <code>session</code>.
46       */
47      void messageReceived(IoSession session, Object message) throws Exception;
48  }