QueueChannel (Spring Integration API)

java.lang.ObjectSE
- org.springframework.integration.context.IntegrationObjectSupport
- - org.springframework.integration.channel.AbstractMessageChannel
  - - org.springframework.integration.channel.AbstractPollableChannel
    - - org.springframework.integration.channel.QueueChannel

実装済みのインターフェース一覧:
Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, ExecutorChannelInterceptorAware, QueueChannelOperations, ExpressionCapable, IntegrationPattern, NamedComponent, IntegrationManagement, TrackableComponent, MessageChannel, PollableChannel, InterceptableChannel
既知の直属サブクラス
PriorityChannel, RendezvousChannel
```
public class QueueChannel
extends AbstractPollableChannel
implements QueueChannelOperations
```
メッセージチャネルの簡単な実装。各 Message は BlockingQueueSE に配置され、その容量は構築時に指定できます。容量は正の整数値でなければなりません。SynchronousQueueSE に基づく容量ゼロのバージョンの場合は、RendezvousChannel を検討してください。
作成者:
Mark Fisher, Oleg Zhurakousky, Gary Russell, Artem Bilan

ネストされたクラスの概要
- クラス org.springframework.integration.channel.AbstractMessageChannel から継承されたネストクラス / インターフェース
  AbstractMessageChannel.ChannelInterceptorList
- インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたネストクラス / インターフェース
  IntegrationManagement.ManagementOverrides

フィールド概要
フィールド
修飾子と型フィールドと説明
protected SemaphoreSE queueSemaphore
- クラス org.springframework.integration.channel.AbstractMessageChannel から継承されたフィールド
  interceptors, meters
- クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたフィールド
  EXPRESSION_PARSER, logger
- インターフェース org.springframework.messaging.MessageChannel から継承されたフィールド
  INDEFINITE_TIMEOUT
- インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたフィールド
  METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

フィールド
修飾子と型	フィールドと説明
`protected SemaphoreSE`	`queueSemaphore`

コンストラクター概要

コンストラクター
コンストラクターと説明
`QueueChannel()` 「無制限」のキュー容量を持つチャネルを作成します。
`QueueChannel(int capacity)` 指定されたキュー容量でチャネルを作成します。
`QueueChannel(QueueSE<Message<?>> queue)` 指定されたキューでチャネルを作成します。

方法の概要

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`ListSE<Message<?>>`	`clear()` このチャネルからすべての `Messages` を削除します。
`void`	`destroy()`
`protected Message<?>`	`doReceive(long timeout)` サブクラスはこのメソッドを実装する必要があります。
`protected boolean`	`doSend(Message<?> message, long timeout)` サブクラスはこのメソッドを実装する必要があります。
`int`	`getQueueSize()` このチャネルでキューに入れられた `Messages` の現在の数を取得します。
`int`	`getRemainingCapacity()` このチャネルの残りの容量を取得します。
`ListSE<Message<?>>`	`purge(MessageSelector selector)` 提供されたセレクターで受け入れられない `Messages` をすべて削除します。
`void`	`registerMetricsCaptor(MetricsCaptor metricsCaptor)` `MetricsCaptor` を注入する

クラス org.springframework.integration.channel.AbstractPollableChannel から継承されたメソッド
addInterceptor, addInterceptor, getIntegrationPatternType, hasExecutorInterceptors, receive, receive, removeInterceptor, removeInterceptor, setInterceptors

クラス org.springframework.integration.channel.AbstractMessageChannel から継承されたメソッド
getComponentType, getFullChannelName, getIChannelInterceptorList, getInterceptors, getMetricsCaptor, getOverrides, isLoggingEnabled, onInit, send, send, setDatatypes, setLoggingEnabled, setMessageConverter, setShouldTrack

クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたメソッド
afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, waitSE, waitSE, waitSE

インターフェース org.springframework.messaging.MessageChannel から継承されたメソッド
send, send

インターフェース org.springframework.messaging.support.InterceptableChannel から継承されたメソッド
getInterceptors

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたメソッド
getManagedName, getManagedType, getThisAs, setManagedName, setManagedType

インターフェース org.springframework.integration.support.context.NamedComponent から継承されたメソッド
getBeanName, getComponentName

- フィールドの詳細
  - queueSemaphore
```
protected final SemaphoreSE queueSemaphore
```
- コンストラクターの詳細
  - QueueChannel
```
public QueueChannel(QueueSE<Message<?>> queue)
```
    指定されたキューでチャネルを作成します。
    パラメーター:
    queue - 待ち行列。
  - QueueChannel
```
public QueueChannel(int capacity)
```
    指定されたキュー容量でチャネルを作成します。
    パラメーター:
    capacity - 容量。
  - QueueChannel
```
public QueueChannel()
```
    「無制限」のキュー容量を持つチャネルを作成します。実際の容量値は Integer.MAX_VALUESE です。制限のないキューは OutOfMemoryErrors につながる可能性があるため、制限のあるキューをお勧めします。
- メソッドの詳細
  - registerMetricsCaptor
```
public void registerMetricsCaptor(MetricsCaptor metricsCaptor)
```
    インターフェースからコピーされた説明: IntegrationManagement
    MetricsCaptor を注入する
    次で指定:
    インターフェース IntegrationManagement 内の registerMetricsCaptor
    オーバーライド:
    クラス AbstractMessageChannel の registerMetricsCaptor
    パラメーター:
    metricsCaptor - キャプター。
  - doSend
```
protected boolean doSend(Message<?> message,
                         long timeout)
```
    クラスからコピーされた説明: AbstractMessageChannel
    サブクラスはこのメソッドを実装する必要があります。負でないタイムアウトは、チャネルが容量に達した場合に待機する時間を示します（値が 0 の場合、成功の有無にかかわらずすぐに戻る必要があります）。負のタイムアウト値は、メッセージが受け入れられるか、ブロッキングスレッドが中断されるまでメソッドがブロックされることを示します。
    次で指定:
    クラス AbstractMessageChannel の doSend
    パラメーター:
    message - メッセージ。
    timeout - タイムアウト。
    戻り値:
    送信が成功した場合は true。
  - doReceive
```
@Nullable
protected Message<?> doReceive(long timeout)
```
    クラスからコピーされた説明: AbstractPollableChannel
    サブクラスはこのメソッドを実装する必要があります。負でないタイムアウトは、チャネルが空の場合に待機する時間を示します（値が 0 の場合、成功の有無にかかわらずすぐに戻る必要があります）。負のタイムアウト値は、メッセージが使用可能になるか、ブロッキングスレッドが中断されるまでメソッドがブロックされることを示します。
    次で指定:
    クラス AbstractPollableChannel の doReceive
    パラメーター:
    timeout - タイムアウト。
    戻り値:
    メッセージ、または null。
  - clear
```
public ListSE<Message<?>> clear()
```
    インターフェースからコピーされた説明: QueueChannelOperations
    このチャネルからすべての Messages を削除します。
    次で指定:
    インターフェース QueueChannelOperations 内の clear
    戻り値:
    削除されたメッセージ。
  - purge
```
public ListSE<Message<?>> purge(@Nullable
                              MessageSelector selector)
```
    インターフェースからコピーされた説明: QueueChannelOperations
    提供されたセレクターで受け入れられない Messages をすべて削除します。
    次で指定:
    インターフェース QueueChannelOperations 内の purge
    パラメーター:
    selector - メッセージセレクター。
    戻り値:
    パージされたメッセージのリスト。
  - getQueueSize
```
public int getQueueSize()
```
    インターフェースからコピーされた説明: QueueChannelOperations
    このチャネルでキューに入れられた Messages の現在の数を取得します。
    次で指定:
    インターフェース QueueChannelOperations 内の getQueueSize
    戻り値:
    このチャネルでキューに入れられた Messages の現在の数。
  - getRemainingCapacity
```
public int getRemainingCapacity()
```
    インターフェースからコピーされた説明: QueueChannelOperations
    このチャネルの残りの容量を取得します。
    次で指定:
    インターフェース QueueChannelOperations 内の getRemainingCapacity
    戻り値:
    このチャネルの残りの容量。
  - destroy
```
public void destroy()
```
    次で指定:
    インターフェース DisposableBean 内の destroy
    次で指定:
    インターフェース IntegrationManagement 内の destroy
    オーバーライド:
    クラス AbstractMessageChannel の destroy

クラス QueueChannel

ネストされたクラスの概要

クラス org.springframework.integration.channel.AbstractMessageChannel から継承されたネストクラス / インターフェース

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたネストクラス / インターフェース

フィールド概要

クラス org.springframework.integration.channel.AbstractMessageChannel から継承されたフィールド

クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたフィールド

インターフェース org.springframework.messaging.MessageChannel から継承されたフィールド

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたフィールド

コンストラクター概要

方法の概要

クラス org.springframework.integration.channel.AbstractPollableChannel から継承されたメソッド

クラス org.springframework.integration.channel.AbstractMessageChannel から継承されたメソッド

クラス org.springframework.integration.context.IntegrationObjectSupport から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

インターフェース org.springframework.messaging.MessageChannel から継承されたメソッド

インターフェース org.springframework.messaging.support.InterceptableChannel から継承されたメソッド

インターフェース org.springframework.integration.support.management.IntegrationManagement から継承されたメソッド

インターフェース org.springframework.integration.support.context.NamedComponent から継承されたメソッド

フィールドの詳細

queueSemaphore

コンストラクターの詳細

QueueChannel

QueueChannel

QueueChannel

メソッドの詳細

registerMetricsCaptor

doSend

doReceive

clear

purge

getQueueSize

getRemainingCapacity

destroy