43 lines
1.7 KiB
Java
43 lines
1.7 KiB
Java
/*
|
|
* Copyright 2020 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:
|
|
*
|
|
* https://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.buffer.api;
|
|
|
|
/**
|
|
* A Send object is a temporary holder of an {@link Rc}, used for transferring the ownership of the Rc from one thread
|
|
* to another.
|
|
* <p>
|
|
* Prior to the Send being created, the originating Rc is invalidated, to prevent access while it is being sent. This
|
|
* means it cannot be accessed, closed, or disposed of, while it is in-flight. Once the Rc is {@linkplain #receive()
|
|
* received}, the new ownership is established.
|
|
* <p>
|
|
* Care must be taken to ensure that the Rc is always received by some thread. Failure to do so can result in a resource
|
|
* leak.
|
|
*
|
|
* @param <T>
|
|
*/
|
|
public interface Send<T extends Rc<T>> {
|
|
/**
|
|
* Receive the {@link Rc} instance being sent, and bind its ownership to the calling thread. The invalidation of the
|
|
* sent Rc in the sending thread happens-before the return of this method.
|
|
* <p>
|
|
* This method can only be called once, and will throw otherwise.
|
|
*
|
|
* @return The sent Rc instance.
|
|
* @throws IllegalStateException If this method is called more than once.
|
|
*/
|
|
T receive();
|
|
}
|