View Javadoc

1   /*
2    * Copyright 2012 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package org.jboss.netty.channel;
17  
18  import java.net.SocketAddress;
19  
20  /**
21   * A {@link ChannelEvent} which represents the transmission or reception of a
22   * message.  It can mean the notification of a received message or the request
23   * for writing a message, depending on whether it is an upstream event or a
24   * downstream event respectively.  Please refer to the {@link ChannelEvent}
25   * documentation to find out what an upstream event and a downstream event are
26   * and what fundamental differences they have.
27   */
28  public interface MessageEvent extends ChannelEvent {
29  
30      /**
31       * Returns the message.
32       */
33      Object getMessage();
34  
35      /**
36       * Returns the remote address of the message.
37       */
38      SocketAddress getRemoteAddress();
39  }