TaskMailboxImpl (Flink : Streaming Java 1.16.0 API)

java.lang.Object
- org.apache.flink.streaming.runtime.tasks.mailbox.TaskMailboxImpl

所有已实现的接口:

TaskMailbox
```
@ThreadSafe
public class TaskMailboxImpl
extends Object
implements TaskMailbox
```
Implementation of TaskMailbox in a BlockingQueue fashion and tailored towards our use case with multiple writers and single reader.

嵌套类概要
- 从接口继承的嵌套类/接口 org.apache.flink.streaming.runtime.tasks.mailbox.TaskMailbox
  TaskMailbox.MailboxClosedException, TaskMailbox.State

字段概要
- 从接口继承的字段 org.apache.flink.streaming.runtime.tasks.mailbox.TaskMailbox
  MAX_PRIORITY, MIN_PRIORITY

构造器概要

构造器
构造器和说明

TaskMailboxImpl()

TaskMailboxImpl(Thread taskMailboxThread)

构造器
构造器和说明
`TaskMailboxImpl()`
`TaskMailboxImpl(Thread taskMailboxThread)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`List<Mail>`	`close()` Close the mailbox.
`boolean`	`createBatch()` Creates a batch of mails that can be taken with `TaskMailbox.tryTakeFromBatch()`.
`List<Mail>`	`drain()` Drains the mailbox and returns all mails that were still enqueued.
`TaskMailbox.State`	`getState()` Returns the current state of the mailbox as defined by the lifecycle enum `TaskMailbox.State`.
`boolean`	`hasMail()` Returns `true` if the mailbox contains mail.
`boolean`	`isMailboxThread()` Check if the current thread is the mailbox thread.
`void`	`put(Mail mail)` Enqueues the given mail to the mailbox and blocks until there is capacity for a successful put.
`void`	`putFirst(Mail mail)` Adds the given action to the head of the mailbox.
`void`	`quiesce()` Quiesce the mailbox.
`void`	`runExclusively(Runnable runnable)` Runs the given code exclusively on this mailbox.
`int`	`size()` Returns the current number of mails in this mailbox.
`Mail`	`take(int priority)` This method returns the oldest mail from the mailbox (head of queue) or blocks until a mail is available.
`Optional<Mail>`	`tryTake(int priority)` Returns an optional with either the oldest mail from the mailbox (head of queue) if the mailbox is not empty or an empty optional otherwise.
`Optional<Mail>`	`tryTakeFromBatch()` Returns an optional with either the oldest mail from the batch (head of queue) if the batch is not empty or an empty optional otherwise.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - TaskMailboxImpl
```
public TaskMailboxImpl(@Nonnull
                       Thread taskMailboxThread)
```
  - TaskMailboxImpl
```
@VisibleForTesting
public TaskMailboxImpl()
```
- 方法详细资料
  - isMailboxThread
```
public boolean isMailboxThread()
```
    从接口复制的说明: TaskMailbox
    
    Check if the current thread is the mailbox thread.
    Read operations will fail if they are called from another thread.
    
    指定者:
    
    isMailboxThread 在接口中 TaskMailbox
    
    返回:
    
    only true if called from the mailbox thread.
  - hasMail
```
public boolean hasMail()
```
    从接口复制的说明: TaskMailbox
    
    Returns true if the mailbox contains mail.
    Must be called from the mailbox thread (TaskMailbox.isMailboxThread().
    
    指定者:
    
    hasMail 在接口中 TaskMailbox
  - size
```
public int size()
```
    从接口复制的说明: TaskMailbox
    
    Returns the current number of mails in this mailbox. (This includes mails in the batch not processed yet.)
    
    指定者:
    
    size 在接口中 TaskMailbox
    
    返回:
    
    number of mails in the mailbox.
  - tryTake
```
public Optional<Mail> tryTake(int priority)
```
    从接口复制的说明: TaskMailbox
    
    Returns an optional with either the oldest mail from the mailbox (head of queue) if the mailbox is not empty or an empty optional otherwise.
    Must be called from the mailbox thread (TaskMailbox.isMailboxThread().
    
    指定者:
    
    tryTake 在接口中 TaskMailbox
    
    返回:
    
    an optional with either the oldest mail from the mailbox (head of queue) if the mailbox is not empty or an empty optional otherwise.
  - take
```
@Nonnull
public Mail take(int priority)
                   throws InterruptedException,
                          IllegalStateException
```
    从接口复制的说明: TaskMailbox
    
    This method returns the oldest mail from the mailbox (head of queue) or blocks until a mail is available.
    Must be called from the mailbox thread (TaskMailbox.isMailboxThread().
    
    指定者:
    
    take 在接口中 TaskMailbox
    
    返回:
    
    the oldest mail from the mailbox (head of queue).
    
    抛出:
    
    InterruptedException - on interruption.
    
    IllegalStateException - if mailbox is already closed.
  - createBatch
```
public boolean createBatch()
```
    从接口复制的说明: TaskMailbox
    
    Creates a batch of mails that can be taken with TaskMailbox.tryTakeFromBatch(). The batch does not affect TaskMailbox.tryTake(int) and TaskMailbox.take(int); that is, they return the same mails even if no batch had been created.
    The default batch is empty. Thus, this method must be invoked once before TaskMailbox.tryTakeFromBatch().
    If a batch is not completely consumed by TaskMailbox.tryTakeFromBatch(), its elements are carried over to the new batch.
    Must be called from the mailbox thread (TaskMailbox.isMailboxThread().
    
    指定者:
    
    createBatch 在接口中 TaskMailbox
    
    返回:
    
    true if there is at least one element in the batch; that is, if there is any mail at all at the time of the invocation.
  - tryTakeFromBatch
```
public Optional<Mail> tryTakeFromBatch()
```
    从接口复制的说明: TaskMailbox
    
    Returns an optional with either the oldest mail from the batch (head of queue) if the batch is not empty or an empty optional otherwise.
    Must be called from the mailbox thread (TaskMailbox.isMailboxThread().
    Note that there is no blocking takeFromBatch as batches can only be created and consumed from the mailbox thread.
    
    指定者:
    
    tryTakeFromBatch 在接口中 TaskMailbox
    
    返回:
    
    an optional with either the oldest mail from the batch (head of queue) if the batch is not empty or an empty optional otherwise.
  - put
```
public void put(@Nonnull
                Mail mail)
```
    从接口复制的说明: TaskMailbox
    
    Enqueues the given mail to the mailbox and blocks until there is capacity for a successful put.
    Mails can be added from any thread.
    
    指定者:
    
    put 在接口中 TaskMailbox
    
    参数:
    
    mail - the mail to enqueue.
  - putFirst
```
public void putFirst(@Nonnull
                     Mail mail)
```
    从接口复制的说明: TaskMailbox
    
    Adds the given action to the head of the mailbox.
    Mails can be added from any thread.
    
    指定者:
    
    putFirst 在接口中 TaskMailbox
    
    参数:
    
    mail - the mail to enqueue.
  - drain
```
public List<Mail> drain()
```
    从接口复制的说明: TaskMailbox
    
    Drains the mailbox and returns all mails that were still enqueued.
    
    指定者:
    
    drain 在接口中 TaskMailbox
    
    返回:
    
    list with all mails that where enqueued in the mailbox.
  - quiesce
```
public void quiesce()
```
    从接口复制的说明: TaskMailbox
    
    Quiesce the mailbox. In this state, the mailbox supports only take operations and all pending and future put operations will throw TaskMailbox.MailboxClosedException.
    
    指定者:
    
    quiesce 在接口中 TaskMailbox
  - close
```
@Nonnull
public List<Mail> close()
```
    从接口复制的说明: TaskMailbox
    
    Close the mailbox. In this state, all pending and future put operations and all pending and future take operations will throw TaskMailbox.MailboxClosedException. Returns all mails that were still enqueued.
    
    指定者:
    
    close 在接口中 TaskMailbox
    
    返回:
    
    list with all mails that where enqueued in the mailbox at the time of closing.
  - getState
```
@Nonnull
public TaskMailbox.State getState()
```
    从接口复制的说明: TaskMailbox
    
    Returns the current state of the mailbox as defined by the lifecycle enum TaskMailbox.State.
    
    指定者:
    
    getState 在接口中 TaskMailbox
    
    返回:
    
    the current state of the mailbox.
  - runExclusively
```
public void runExclusively(Runnable runnable)
```
    从接口复制的说明: TaskMailbox
    
    Runs the given code exclusively on this mailbox. No synchronized operations can be run concurrently to the given runnable (e.g., TaskMailbox.put(Mail) or modifying lifecycle methods).
    Use this methods when you want to atomically execute code that uses different methods (e.g., check for state and then put message if open).
    
    指定者:
    
    runExclusively 在接口中 TaskMailbox
    
    参数:
    
    runnable - the runnable to execute

类 TaskMailboxImpl

嵌套类概要

从接口继承的嵌套类/接口 org.apache.flink.streaming.runtime.tasks.mailbox.TaskMailbox

字段概要

从接口继承的字段 org.apache.flink.streaming.runtime.tasks.mailbox.TaskMailbox

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

TaskMailboxImpl

TaskMailboxImpl

方法详细资料

isMailboxThread

hasMail

size

tryTake

take

createBatch

tryTakeFromBatch

put

putFirst

drain

quiesce

close

getState

runExclusively