reactor.alloc.spec

Class RingBufferAllocatorSpec<T extends Recyclable>

java.lang.Object

reactor.alloc.spec.RingBufferAllocatorSpec<T>

All Implemented Interfaces:

Supplier<RingBufferAllocator<T>>

public class RingBufferAllocatorSpec<T extends Recyclable>
extends java.lang.Object
implements Supplier<RingBufferAllocator<T>>

Helper class for creating a RingBufferAllocator. Provides an easy way to specify the EventFactory, EventHandler, and ExceptionHandler via Reactor abstractions of Supplier and Consumer.

Since:

1.1

Constructor Summary

Constructors

Constructor and Description
RingBufferAllocatorSpec()

Method Summary

Modifier and Type	Method and Description
RingBufferAllocatorSpec<T>	allocator(Supplier<T> allocator) The Supplier to provide the RingBuffer with the reusable objects that are being pooled.
RingBufferAllocatorSpec<T>	errorHandler(Consumer<java.lang.Throwable> errorHandler) The Consumer to be invoked when an error occurs.
RingBufferAllocatorSpec<T>	eventHandler(Consumer<Reference<T>> eventHandler) The Consumer to be invoked with a sequence ID is published.
RingBufferAllocatorSpec<T>	eventThreads(int eventThreads) Specify the number of threads the underlying RingBuffer will use.
RingBufferAllocatorSpec<T>	executor(java.util.concurrent.ExecutorService executor) The ExecutorService to use inside the RingBuffer.
RingBufferAllocator<T>	get() Get an object.
RingBufferAllocatorSpec<T>	name(java.lang.String name) Name of the RingBufferAllocator.
RingBufferAllocatorSpec<T>	producerType(com.lmax.disruptor.dsl.ProducerType producerType) Specify single or multi-threaded producer.
RingBufferAllocatorSpec<T>	ringSize(int ringSize) Size of the RingBuffer ring.
RingBufferAllocatorSpec<T>	waitStrategy(com.lmax.disruptor.WaitStrategy waitStrategy) Specify the WaitStrategy to use (defaults to BlockingWaitStrategy).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RingBufferAllocatorSpec

public RingBufferAllocatorSpec()

Method Detail

name

public RingBufferAllocatorSpec<T> name(java.lang.String name)

Name of the RingBufferAllocator.

Parameters:

name -

Returns:

this

ringSize

public RingBufferAllocatorSpec<T> ringSize(int ringSize)

Size of the RingBuffer ring.

Parameters:

ringSize -

Returns:

this

eventThreads

public RingBufferAllocatorSpec<T> eventThreads(int eventThreads)

Specify the number of threads the underlying RingBuffer will use.

Parameters:

eventThreads - number of threads for event handlers

Returns:

this

allocator

public RingBufferAllocatorSpec<T> allocator(Supplier<T> allocator)

The Supplier to provide the RingBuffer with the reusable objects that are being pooled.

Parameters:

allocator -

Returns:

this

eventHandler

public RingBufferAllocatorSpec<T> eventHandler(Consumer<Reference<T>> eventHandler)

The Consumer to be invoked with a sequence ID is published.

Parameters:

eventHandler -

Returns:

this

errorHandler

public RingBufferAllocatorSpec<T> errorHandler(Consumer<java.lang.Throwable> errorHandler)

The Consumer to be invoked when an error occurs.

Parameters:

errorHandler -

Returns:

this

producerType

public RingBufferAllocatorSpec<T> producerType(com.lmax.disruptor.dsl.ProducerType producerType)

Specify single or multi-threaded producer.

Parameters:

producerType -

Returns:

this

waitStrategy

public RingBufferAllocatorSpec<T> waitStrategy(com.lmax.disruptor.WaitStrategy waitStrategy)

Specify the WaitStrategy to use (defaults to BlockingWaitStrategy).

Parameters:

waitStrategy -

Returns:

this

executor

public RingBufferAllocatorSpec<T> executor(java.util.concurrent.ExecutorService executor)

The ExecutorService to use inside the RingBuffer.

Parameters:

executor -

Returns:

this

get

public RingBufferAllocator<T> get()

Description copied from interface: Supplier

Get an object.

Specified by:

get in interface Supplier<RingBufferAllocator<T extends Recyclable>>

Returns:

An object.