## Uses of Interface
com.hazelcast.jet.function.ConsumerEx

- Packages that use ConsumerEx
  Package | Description
  --- | ---
  com.hazelcast.jet.core.processor | Contains static utility classes with factories of Jet processors.
  com.hazelcast.jet.function | Serializable and exception-declaring variants of functional interfaces from `java.util.function`.
  com.hazelcast.jet.pipeline | The Pipeline API is Jet's high-level API to build and execute distributed computation jobs.
  com.hazelcast.jet.pipeline.test | This package contains various mock sources to help with pipeline testing and development.

- - ### Uses of ConsumerEx in com.hazelcast.jet.core.processor

    Methods in com.hazelcast.jet.core.processor with parameters of type ConsumerEx
    Modifier and Type | Method and Description
    --- | ---
    `static <C,T,S> ProcessorMetaSupplier` | SourceProcessors.`convenientSourceP(FunctionEx<? super Processor.Context,? extends C> createFn, BiConsumerEx<? super C,? super SourceBuilder.SourceBuffer<T>> fillBufferFn, FunctionEx<? super C,? extends S> createSnapshotFn, BiConsumerEx<? super C,? super List<S>> restoreSnapshotFn, ConsumerEx<? super C> destroyFn, int preferredLocalParallelism, boolean isBatch)` Returns a supplier of processors for a source that the user can create using the `SourceBuilder`.
    `static <C,T,S> ProcessorMetaSupplier` | SourceProcessors.`convenientTimestampedSourceP(FunctionEx<? super Processor.Context,? extends C> createFn, BiConsumerEx<? super C,? super SourceBuilder.TimestampedSourceBuffer<T>> fillBufferFn, EventTimePolicy<? super T> eventTimePolicy, FunctionEx<? super C,? extends S> createSnapshotFn, BiConsumerEx<? super C,? super List<S>> restoreSnapshotFn, ConsumerEx<? super C> destroyFn, int preferredLocalParallelism)` Returns a supplier of processors for a source that the user can create using the `SourceBuilder`.
    `static <T> ProcessorMetaSupplier` | SourceProcessors.`streamJmsQueueP(SupplierEx<? extends javax.jms.Connection> newConnectionFn, FunctionEx<? super javax.jms.Connection,? extends javax.jms.Session> newSessionFn, FunctionEx<? super javax.jms.Session,? extends javax.jms.MessageConsumer> consumerFn, ConsumerEx<? super javax.jms.Session> flushFn, FunctionEx<? super javax.jms.Message,? extends T> projectionFn, EventTimePolicy<? super T> eventTimePolicy)` Returns a supplier of processors for `Sources.jmsQueueBuilder(com.hazelcast.jet.function.SupplierEx<? extends javax.jms.ConnectionFactory>)`.
    `static <T> ProcessorMetaSupplier` | SourceProcessors.`streamJmsTopicP(SupplierEx<? extends javax.jms.Connection> newConnectionFn, FunctionEx<? super javax.jms.Connection,? extends javax.jms.Session> newSessionFn, FunctionEx<? super javax.jms.Session,? extends javax.jms.MessageConsumer> consumerFn, ConsumerEx<? super javax.jms.Session> flushFn, FunctionEx<? super javax.jms.Message,? extends T> projectionFn, EventTimePolicy<? super T> eventTimePolicy)` Returns a supplier of processors for `Sources.jmsTopicBuilder(com.hazelcast.jet.function.SupplierEx<? extends javax.jms.ConnectionFactory>)`.
    `static <W,T> SupplierEx<Processor>` | SinkProcessors.`writeBufferedP(FunctionEx<? super Processor.Context,? extends W> createFn, BiConsumerEx<? super W,? super T> onReceiveFn, ConsumerEx<? super W> flushFn)` Shortcut for `SinkProcessors.writeBufferedP(FunctionEx, BiConsumerEx, ConsumerEx, ConsumerEx)` with a no-op `destroyFn`.
    `static <W,T> SupplierEx<Processor>` | SinkProcessors.`writeBufferedP(FunctionEx<? super Processor.Context,? extends W> createFn, BiConsumerEx<? super W,? super T> onReceiveFn, ConsumerEx<? super W> flushFn, ConsumerEx<? super W> destroyFn)` Returns a supplier of processors for a vertex that drains all the items from the inbox to an internal writer object and then does a flush.
    `static <W,T> SupplierEx<Processor>` | SinkProcessors.`writeBufferedP(FunctionEx<? super Processor.Context,? extends W> createFn, BiConsumerEx<? super W,? super T> onReceiveFn, ConsumerEx<? super W> flushFn, ConsumerEx<? super W> destroyFn)` Returns a supplier of processors for a vertex that drains all the items from the inbox to an internal writer object and then does a flush.
    `static <T> ProcessorMetaSupplier` | SinkProcessors.`writeJmsQueueP(SupplierEx<? extends javax.jms.Connection> newConnectionFn, FunctionEx<? super javax.jms.Connection,? extends javax.jms.Session> newSessionFn, BiFunctionEx<? super javax.jms.Session,? super T,? extends javax.jms.Message> messageFn, BiConsumerEx<? super javax.jms.MessageProducer,? super javax.jms.Message> sendFn, ConsumerEx<? super javax.jms.Session> flushFn, String name)` Returns a supplier of processors for `Sinks.jmsQueueBuilder(com.hazelcast.jet.function.SupplierEx<javax.jms.ConnectionFactory>)`.
    `static <T> ProcessorMetaSupplier` | SinkProcessors.`writeJmsTopicP(SupplierEx<? extends javax.jms.Connection> newConnectionFn, FunctionEx<? super javax.jms.Connection,? extends javax.jms.Session> newSessionFn, BiFunctionEx<? super javax.jms.Session,? super T,? extends javax.jms.Message> messageFn, BiConsumerEx<? super javax.jms.MessageProducer,? super javax.jms.Message> sendFn, ConsumerEx<? super javax.jms.Session> flushFn, String name)` Returns a supplier of processors for `Sinks.jmsTopicBuilder(com.hazelcast.jet.function.SupplierEx<javax.jms.ConnectionFactory>)`.

  - ### Uses of ConsumerEx in com.hazelcast.jet.function

    Methods in com.hazelcast.jet.function that return ConsumerEx
    Modifier and Type | Method and Description
    --- | ---
    `default ConsumerEx<T>` | ConsumerEx.`andThen(ConsumerEx<? super T> after)` `Serializable` variant of `java.util.function.Consumer#andThen(Consumer)`.
    `static <T> ConsumerEx<T>` | ConsumerEx.`noop()` Returns a consumer that does nothing.

    Methods in com.hazelcast.jet.function with parameters of type ConsumerEx
    Modifier and Type | Method and Description
    --- | ---
    `default ConsumerEx<T>` | ConsumerEx.`andThen(ConsumerEx<? super T> after)` `Serializable` variant of `java.util.function.Consumer#andThen(Consumer)`.

  - ### Uses of ConsumerEx in com.hazelcast.jet.pipeline

    Methods in com.hazelcast.jet.pipeline that return ConsumerEx
    Modifier and Type | Method and Description
    --- | ---
    `ConsumerEx<? super C>` | ContextFactory.`destroyFn()` Returns the destroy-function.

    Methods in com.hazelcast.jet.pipeline with parameters of type ConsumerEx
    Modifier and Type | Method and Description
    --- | ---
    `SourceBuilder.Batch<T>` | SourceBuilder.Batch.`destroyFn(ConsumerEx<? super C> destroyFn)`
    `SourceBuilder.Stream<T>` | SourceBuilder.Stream.`destroyFn(ConsumerEx<? super C> pDestroyFn)`
    `SourceBuilder.TimestampedStream<T>` | SourceBuilder.TimestampedStream.`destroyFn(ConsumerEx<? super C> pDestroyFn)`
    `SinkBuilder<W,T>` | SinkBuilder.`destroyFn(ConsumerEx<? super W> destroyFn)` Sets the function that will destroy the writer and perform any cleanup.
    `JmsSourceBuilder` | JmsSourceBuilder.`flushFn(ConsumerEx<? super javax.jms.Session> flushFn)` Sets the function which commits the session after consuming each message.
    `SinkBuilder<W,T>` | SinkBuilder.`flushFn(ConsumerEx<? super W> flushFn)` Sets the function that implements the sink's flushing behavior.
    `JmsSinkBuilder<T>` | JmsSinkBuilder.`flushFn(ConsumerEx<javax.jms.Session> flushFn)` Sets the function which flushes the session after a batch of messages is sent.
    `ContextFactory<C>` | ContextFactory.`withDestroyFn(ConsumerEx<? super C> destroyFn)` Returns a copy of this `ContextFactory` with the destroy-function replaced with the given function.

  - ### Uses of ConsumerEx in com.hazelcast.jet.pipeline.test

    Methods in com.hazelcast.jet.pipeline.test with parameters of type ConsumerEx
    Modifier and Type | Method and Description
    --- | ---
    `static <T> FunctionEx<BatchStage<T>,BatchStage<T>>` | Assertions.`assertCollected(ConsumerEx<? super List<T>> assertFn)` Collects all the received items in a list and once the upstream stage is completed it executes the assertion supplied by `assertFn`.
    `static <T> Sink<T>` | AssertionSinks.`assertCollected(ConsumerEx<? super List<T>> assertFn)` Collects all the received items in a list and once the upstream stage is completed it executes the assertion supplied by `assertFn`.
    `static <T> FunctionEx<StreamStage<T>,StreamStage<T>>` | Assertions.`assertCollectedEventually(int timeout, ConsumerEx<? super List<T>> assertFn)` Collects all the received items into a list and runs the `assertFn` every time a new item is received.
    `static <T> Sink<T>` | AssertionSinks.`assertCollectedEventually(int timeoutSeconds, ConsumerEx<? super List<T>> assertFn)` Collects all the received items into a list and runs the `assertFn` every time a new item is received.
    `AssertionSinkBuilder<S,T>` | AssertionSinkBuilder.`completeFn(ConsumerEx<? super S> completeFn)` Sets the function that will be called after all the upstream stages have completed and all the items were received.
    `AssertionSinkBuilder<S,T>` | AssertionSinkBuilder.`timerFn(ConsumerEx<? super S> timerFn)` Sets the function that will be called periodically.

Copyright © 2020. All rights reserved.