netty5/transport/src/main/java/io/netty/channel/AddressedEnvelope.java
Trustin Lee 8837afddf8 Enable a user specify an arbitrary information with ReferenceCounted.touch()
- Related: #2163
- Add ResourceLeakHint to allow a user to provide a meaningful information about the leak when touching it
- DefaultChannelHandlerContext now implements ResourceLeakHint to tell where the message is going.
- Cleaner resource leak report by excluding noisy stack trace elements
2014-02-13 18:16:25 -08:00

57 lines
1.5 KiB
Java

/*
* Copyright 2013 The Netty Project
*
* The Netty Project licenses this file to you under the Apache License,
* version 2.0 (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
package io.netty.channel;
import io.netty.util.ReferenceCounted;
import java.net.SocketAddress;
/**
* A message that wraps another message with a sender address and a recipient address.
*
* @param <M> the type of the wrapped message
* @param <A> the type of the address
*/
public interface AddressedEnvelope<M, A extends SocketAddress> extends ReferenceCounted {
/**
* Returns the message wrapped by this envelope message.
*/
M content();
/**
* Returns the address of the sender of this message.
*/
A sender();
/**
* Returns the address of the recipient of this message.
*/
A recipient();
@Override
AddressedEnvelope<M, A> retain();
@Override
AddressedEnvelope<M, A> retain(int increment);
@Override
AddressedEnvelope<M, A> touch();
@Override
AddressedEnvelope<M, A> touch(Object hint);
}