PipeConsumer (Nuxeo 2021.70.4 API Documentation)

All Known Implementing Classes:

AbstractListenerPipeConsumer, AbstractPipeConsumer, LocalEventBundlePipeConsumer
```
public interface PipeConsumer<T>
```
SPI for a consumer of messages inside the EventBundlePipe

Since:

8.4

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`initConsumer(String name, Map<String,String> params)`	Initialize the Consumer when the `EventBundlePipe` is initialized
`boolean`	`receiveMessage(List<T> messages)`	Callback when a batch of messages is available
`void`	`shutdown()`	Shutdown the consumer when the `EventBundlePipe` is shutdown
`boolean`	`waitForCompletion(long timeoutMillis)`	Wait until consumer is done

- Method Detail
  - initConsumer
```
void initConsumer(String name,
                  Map<String,String> params)
```
    Initialize the Consumer when the EventBundlePipe is initialized
  - receiveMessage
```
boolean receiveMessage(List<T> messages)
```
    Callback when a batch of messages is available
  - shutdown
```
void shutdown()
       throws InterruptedException
```
    Shutdown the consumer when the EventBundlePipe is shutdown
    
    Throws:
    
    InterruptedException
  - waitForCompletion
```
boolean waitForCompletion(long timeoutMillis)
                   throws InterruptedException
```
    Wait until consumer is done
    
    Throws:
    
    InterruptedException