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.netty5.channel;
18
19 import io.netty5.util.ReferenceCounted;
20 import io.netty5.util.Resource;
21
22 import java.net.SocketAddress;
23
24 /**
25 * A message that wraps another message with a sender address and a recipient address.
26 *
27 * @implNote AddressedEnvelope implementors likely also implement either {@link ReferenceCounted}
28 * or {@link Resource}. Users should be mindful to release or close any address envelopes if
29 * that's the case.
30 *
31 * @param <M> the type of the wrapped message
32 * @param <A> the type of the address
33 */
34 public interface AddressedEnvelope<M, A extends SocketAddress> {
35 /**
36 * Returns the message wrapped by this envelope message.
37 */
38 M content();
39
40 /**
41 * Returns the address of the sender of this message.
42 */
43 A sender();
44
45 /**
46 * Returns the address of the recipient of this message.
47 */
48 A recipient();
49 }