View Javadoc

1   /*
2    *   @(#) $Id: MessageHandler.java 210062 2005-07-11 03:52:38Z trustin $
3    *
4    *   Copyright 2004 The Apache Software Foundation
5    *
6    *   Licensed under the Apache License, Version 2.0 (the "License");
7    *   you may not use this file except in compliance with the License.
8    *   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, software
13   *   distributed under the License is distributed on an "AS IS" BASIS,
14   *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   *   See the License for the specific language governing permissions and
16   *   limitations under the License.
17   *
18   */
19  package org.apache.mina.protocol.handler;
20  
21  import org.apache.mina.protocol.ProtocolSession;
22  
23  /***
24   * A handler interface that {@link DemuxingProtocolHandler} forwards
25   * <code>messageReceived</code> events to.  You have to register your
26   * handler with the type of message you want to get notified using
27   * {@link DemuxingProtocolHandler#registerMessageType(Class, MessageHandler)}.
28   * 
29   * @author The Apache Directory Project
30   * @version $Rev: 210062 $, $Date: 2005-07-11 12:52:38 +0900 $
31   */
32  public interface MessageHandler
33  {
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      {
40          public void messageReceived( ProtocolSession session, Object message )
41          {
42          }
43      };
44      
45      /***
46       * Invoked when the specific type of message is received from the
47       * specified <code>session</code>.
48       */
49      void messageReceived( ProtocolSession session, Object message );
50  }