NettyShuffleEnvironment (Flink : Runtime 1.15.0 API)

java.lang.Object
- org.apache.flink.runtime.io.network.NettyShuffleEnvironment

所有已实现的接口:

AutoCloseable, ShuffleEnvironment<ResultPartition,SingleInputGate>
```
public class NettyShuffleEnvironment
extends Object
implements ShuffleEnvironment<ResultPartition,SingleInputGate>
```
The implementation of ShuffleEnvironment based on netty network communication, local memory and disk files. The network environment contains the data structures that keep track of all intermediate results and shuffle data exchanges.

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`void`	`close()` Tries to shut down all network I/O components.
`List<SingleInputGate>`	`createInputGates(ShuffleIOOwnerContext ownerContext, PartitionProducerStateProvider partitionProducerStateProvider, List<InputGateDeploymentDescriptor> inputGateDeploymentDescriptors)` Factory method for the `InputGates` to consume result partitions.
`List<ResultPartition>`	`createResultPartitionWriters(ShuffleIOOwnerContext ownerContext, List<ResultPartitionDeploymentDescriptor> resultPartitionDeploymentDescriptors)` Factory method for the `ResultPartitionWriters` to produce result partitions.
`ShuffleIOOwnerContext`	`createShuffleIOOwnerContext(String ownerName, ExecutionAttemptID executionAttemptID, org.apache.flink.metrics.MetricGroup parentGroup)` Create a context of the shuffle input/output owner used to create partitions or gates belonging to the owner.
`BatchShuffleReadBufferPool`	`getBatchShuffleReadBufferPool()`
`ExecutorService`	`getBatchShuffleReadIOExecutor()`
`NettyShuffleEnvironmentConfiguration`	`getConfiguration()`
`ConnectionManager`	`getConnectionManager()`
`Optional<InputGate>`	`getInputGate(InputGateID id)`
`NetworkBufferPool`	`getNetworkBufferPool()`
`Collection<ResultPartitionID>`	`getPartitionsOccupyingLocalResources()` Report unreleased partitions.
`ResultPartitionManager`	`getResultPartitionManager()`
`boolean`	`isClosed()`
`void`	`registerLegacyNetworkMetrics(org.apache.flink.metrics.MetricGroup metricGroup, ResultPartitionWriter[] producedPartitions, InputGate[] inputGates)` 已过时。 should be removed in future
`void`	`releasePartitionsLocally(Collection<ResultPartitionID> partitionIds)` Release local resources occupied by the given partitions.
`int`	`start()` Start the internal related services before using the shuffle service environment.
`boolean`	`updatePartitionInfo(ExecutionAttemptID consumerID, PartitionInfo partitionInfo)` Update a gate with the newly available partition information, previously unknown.

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

- 方法详细资料
  - getResultPartitionManager
```
@VisibleForTesting
public ResultPartitionManager getResultPartitionManager()
```
  - getConnectionManager
```
@VisibleForTesting
public ConnectionManager getConnectionManager()
```
  - getNetworkBufferPool
```
@VisibleForTesting
public NetworkBufferPool getNetworkBufferPool()
```
  - getBatchShuffleReadBufferPool
```
@VisibleForTesting
public BatchShuffleReadBufferPool getBatchShuffleReadBufferPool()
```
  - getBatchShuffleReadIOExecutor
```
@VisibleForTesting
public ExecutorService getBatchShuffleReadIOExecutor()
```
  - getConfiguration
```
@VisibleForTesting
public NettyShuffleEnvironmentConfiguration getConfiguration()
```
  - getInputGate
```
@VisibleForTesting
public Optional<InputGate> getInputGate(InputGateID id)
```
  - releasePartitionsLocally
```
public void releasePartitionsLocally(Collection<ResultPartitionID> partitionIds)
```
    从接口复制的说明: ShuffleEnvironment
    
    Release local resources occupied by the given partitions.
    This is called for partitions which occupy resources locally (can be checked by ShuffleDescriptor.storesLocalResourcesOn()).
    
    指定者:
    
    releasePartitionsLocally 在接口中 ShuffleEnvironment<ResultPartition,SingleInputGate>
    
    参数:
    
    partitionIds - identifying the partitions to be released
  - getPartitionsOccupyingLocalResources
```
public Collection<ResultPartitionID> getPartitionsOccupyingLocalResources()
```
    Report unreleased partitions.
    
    指定者:
    
    getPartitionsOccupyingLocalResources 在接口中 ShuffleEnvironment<ResultPartition,SingleInputGate>
    
    返回:
    
    collection of partitions which still occupy some resources locally on this task executor and have been not released yet.
  - createShuffleIOOwnerContext
```
public ShuffleIOOwnerContext createShuffleIOOwnerContext(String ownerName,
                                                         ExecutionAttemptID executionAttemptID,
                                                         org.apache.flink.metrics.MetricGroup parentGroup)
```
    从接口复制的说明: ShuffleEnvironment
    
    Create a context of the shuffle input/output owner used to create partitions or gates belonging to the owner.
    This method has to be called only once to avoid duplicated internal metric group registration.
    
    指定者:
    
    createShuffleIOOwnerContext 在接口中 ShuffleEnvironment<ResultPartition,SingleInputGate>
    
    参数:
    
    ownerName - the owner name, used for logs
    
    executionAttemptID - execution attempt id of the producer or consumer
    
    parentGroup - parent of shuffle specific metric group
    
    返回:
    
    context of the shuffle input/output owner used to create partitions or gates belonging to the owner
  - createResultPartitionWriters
```
public List<ResultPartition> createResultPartitionWriters(ShuffleIOOwnerContext ownerContext,
                                                          List<ResultPartitionDeploymentDescriptor> resultPartitionDeploymentDescriptors)
```
    从接口复制的说明: ShuffleEnvironment
    
    Factory method for the ResultPartitionWriters to produce result partitions.
    The order of the ResultPartitionWriters in the returned collection should be the same as the iteration order of the passed resultPartitionDeploymentDescriptors.
    
    指定者:
    
    createResultPartitionWriters 在接口中 ShuffleEnvironment<ResultPartition,SingleInputGate>
    
    参数:
    
    ownerContext - the owner context relevant for partition creation
    
    resultPartitionDeploymentDescriptors - descriptors of the partition, produced by the owner
    
    返回:
    
    list of the ResultPartitionWriters
  - createInputGates
```
public List<SingleInputGate> createInputGates(ShuffleIOOwnerContext ownerContext,
                                              PartitionProducerStateProvider partitionProducerStateProvider,
                                              List<InputGateDeploymentDescriptor> inputGateDeploymentDescriptors)
```
    从接口复制的说明: ShuffleEnvironment
    
    Factory method for the InputGates to consume result partitions.
    The order of the InputGates in the returned collection should be the same as the iteration order of the passed inputGateDeploymentDescriptors.
    
    指定者:
    
    createInputGates 在接口中 ShuffleEnvironment<ResultPartition,SingleInputGate>
    
    参数:
    
    ownerContext - the owner context relevant for gate creation
    
    partitionProducerStateProvider - producer state provider to query whether the producer is ready for consumption
    
    inputGateDeploymentDescriptors - descriptors of the input gates to consume
    
    返回:
    
    list of the InputGates
  - registerLegacyNetworkMetrics
```
@Deprecated
public void registerLegacyNetworkMetrics(org.apache.flink.metrics.MetricGroup metricGroup,
                                                     ResultPartitionWriter[] producedPartitions,
                                                     InputGate[] inputGates)
```
    已过时。 should be removed in future
    
    Registers legacy network metric groups before shuffle service refactoring.
    Registers legacy metric groups if shuffle service implementation is original default one.
  - updatePartitionInfo
```
public boolean updatePartitionInfo(ExecutionAttemptID consumerID,
                                   PartitionInfo partitionInfo)
                            throws IOException,
                                   InterruptedException
```
    从接口复制的说明: ShuffleEnvironment
    
    Update a gate with the newly available partition information, previously unknown.
    
    指定者:
    
    updatePartitionInfo 在接口中 ShuffleEnvironment<ResultPartition,SingleInputGate>
    
    参数:
    
    consumerID - execution id to distinguish gates with the same id from the different consumer executions
    
    partitionInfo - information needed to consume the updated partition, e.g. network location
    
    返回:
    
    true if the partition has been updated or false if the partition is not available anymore.
    
    抛出:
    
    IOException - IO problem by the update
    
    InterruptedException - potentially blocking operation was interrupted
  - start
```
public int start()
          throws IOException
```
    从接口复制的说明: ShuffleEnvironment
    
    Start the internal related services before using the shuffle service environment.
    
    指定者:
    
    start 在接口中 ShuffleEnvironment<ResultPartition,SingleInputGate>
    
    返回:
    
    a port to connect for the shuffle data exchange, -1 if only local connection is possible.
    
    抛出:
    
    IOException
  - close
```
public void close()
```
    Tries to shut down all network I/O components.
    
    指定者:
    
    close 在接口中 AutoCloseable
  - isClosed
```
public boolean isClosed()
```

类 NettyShuffleEnvironment

方法概要

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

方法详细资料

getResultPartitionManager

getConnectionManager

getNetworkBufferPool

getBatchShuffleReadBufferPool

getBatchShuffleReadIOExecutor

getConfiguration

getInputGate

releasePartitionsLocally

getPartitionsOccupyingLocalResources

createShuffleIOOwnerContext

createResultPartitionWriters

createInputGates

registerLegacyNetworkMetrics

updatePartitionInfo

start

close

isClosed