View Javadoc
1   /*
2    * Copyright 2013 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    *   https://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  
17  package io.netty.channel;
18  
19  import io.netty.util.ReferenceCounted;
20  
21  import java.net.SocketAddress;
22  
23  /**
24   * A message that wraps another message with a sender address and a recipient address.
25   *
26   * @param <M> the type of the wrapped message
27   * @param <A> the type of the address
28   */
29  public interface AddressedEnvelope<M, A extends SocketAddress> extends ReferenceCounted {
30      /**
31       * Returns the message wrapped by this envelope message.
32       */
33      M content();
34  
35      /**
36       * Returns the address of the sender of this message.
37       */
38      A sender();
39  
40      /**
41       * Returns the address of the recipient of this message.
42       */
43      A recipient();
44  
45      @Override
46      AddressedEnvelope<M, A> retain();
47  
48      @Override
49      AddressedEnvelope<M, A> retain(int increment);
50  
51      @Override
52      AddressedEnvelope<M, A> touch();
53  
54      @Override
55      AddressedEnvelope<M, A> touch(Object hint);
56  }