25 lines
1.2 KiB
Java
25 lines
1.2 KiB
Java
|
package io.netty.buffer.b2;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This interface encapsulates the ownership of an {@link Rc}, and exposes a method that may be used to transfer this
|
||
|
|
* ownership to the specified recipient thread.
|
||
|
|
*
|
||
|
|
* @param <T> The concrete type of {@link Rc} that is owned.
|
||
|
|
*/
|
||
|
|
@SuppressWarnings("InterfaceMayBeAnnotatedFunctional")
|
||
|
|
public interface Owned<T extends Rc<T>> {
|
||
|
|
/**
|
||
|
|
* Transfer the ownership of the owned Rc, to the given recipient thread. The owned Rc is invalidated but without
|
||
|
|
* disposing of its internal state. Then a new Rc with the given owner is produced in its stead.
|
||
|
|
* <p>
|
||
|
|
* This method is called by {@link Send} implementations. These implementations will ensure that the transfer of
|
||
|
|
* ownership (the calling of this method) happens-before the new owner begins accessing the new object. This ensures
|
||
|
|
* that the new Rc is safely published to the new owners.
|
||
|
|
*
|
||
|
|
* @param recipient The new owner of the state represented by this Rc.
|
||
|
|
* @param drop The drop object that knows how to dispose of the state represented by this Rc.
|
||
|
|
* @return A new Rc instance that is exactly the same as this Rc, except it has the new owner.
|
||
|
|
*/
|
||
|
|
T transferOwnership(Thread recipient, Drop<T> drop);
|
||
|
|
}
|