DispatcherBuilder (Zeebe Dispatcher 0.12.1 API)

java.lang.Object
- io.zeebe.dispatcher.DispatcherBuilder

public class DispatcherBuilder
extends Object

Builder for a Dispatcher

Field Summary

Fields
Modifier and Type	Field and Description
`protected ActorScheduler`	`actorScheduler`
`protected boolean`	`allocateInMemory`
`protected String`	`bufferFileName`
`protected int`	`bufferSize`
`protected org.agrona.concurrent.AtomicBuffer`	`countersBuffer`
`protected org.agrona.concurrent.status.CountersManager`	`countersManager`
`protected String`	`dispatcherName`
`protected int`	`frameMaxLength`
`protected int`	`initialPartitionId`
`protected int`	`mode`
`protected ByteBuffer`	`rawBuffer`
`protected String[]`	`subscriptionNames`

Constructor Summary

Constructors
Constructor and Description

DispatcherBuilder(String dispatcherName)

Constructors
Constructor and Description
`DispatcherBuilder(String dispatcherName)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DispatcherBuilder`	`actorScheduler(ActorScheduler actorScheduler)`
`DispatcherBuilder`	`allocateInBuffer(ByteBuffer rawBuffer)` Provide a raw buffer to place the dispatcher's logbuffer in.
`DispatcherBuilder`	`allocateInFile(String fileName)` Allocate the dispatcher's buffer in the provided file by mapping it into memory.
`DispatcherBuilder`	`bufferSize(ByteValue byteValue)` The number of bytes the buffer is be able to contain.
`Dispatcher`	`build()`
`DispatcherBuilder`	`frameMaxLength(int frameMaxLength)` The max length of the data section of a frame
`protected AllocatedBuffer`	`initAllocatedBuffer(int partitionSize)`
`DispatcherBuilder`	`initialPartitionId(int initialPartitionId)`
`DispatcherBuilder`	`modePipeline()` Pipeline-Mode: a subscription can only read a fragment / block if the previous subscription completes reading.
`DispatcherBuilder`	`modePubSub()` Publish-Subscribe-Mode (default): multiple subscriptions can read the same fragment / block concurrently in any order.
`DispatcherBuilder`	`name(String name)`
`DispatcherBuilder`	`subscriptions(String... subscriptionNames)` Predefined subscriptions which will be created on startup in the order as they are declared.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - allocateInMemory
```
protected boolean allocateInMemory
```
  - rawBuffer
```
protected ByteBuffer rawBuffer
```
  - bufferFileName
```
protected String bufferFileName
```
  - bufferSize
```
protected int bufferSize
```
  - frameMaxLength
```
protected int frameMaxLength
```
  - countersManager
```
protected org.agrona.concurrent.status.CountersManager countersManager
```
  - dispatcherName
```
protected String dispatcherName
```
  - countersBuffer
```
protected org.agrona.concurrent.AtomicBuffer countersBuffer
```
  - actorScheduler
```
protected ActorScheduler actorScheduler
```
  - subscriptionNames
```
protected String[] subscriptionNames
```
  - mode
```
protected int mode
```
  - initialPartitionId
```
protected int initialPartitionId
```
- Constructor Detail
  - DispatcherBuilder
```
public DispatcherBuilder(String dispatcherName)
```
- Method Detail
  - name
```
public DispatcherBuilder name(String name)
```
  - allocateInBuffer
```
public DispatcherBuilder allocateInBuffer(ByteBuffer rawBuffer)
```
    Provide a raw buffer to place the dispatcher's logbuffer in. The dispatcher will place the log buffer at the beginning of the provided buffer, disregarding position and it's limit. The provided buffer must be large enough to accommodate the dispatcher
    
    See Also:
    
    allocateInFile(String)
  - allocateInFile
```
public DispatcherBuilder allocateInFile(String fileName)
```
    Allocate the dispatcher's buffer in the provided file by mapping it into memory. The file must exist. The dispatcher will place it's buffer at the beginning of the file.
  - bufferSize
```
public DispatcherBuilder bufferSize(ByteValue byteValue)
```
    The number of bytes the buffer is be able to contain. Represents the size of the data section. Additional space will be allocated for the meta-data sections
  - actorScheduler
```
public DispatcherBuilder actorScheduler(ActorScheduler actorScheduler)
```
  - frameMaxLength
```
public DispatcherBuilder frameMaxLength(int frameMaxLength)
```
    The max length of the data section of a frame
  - initialPartitionId
```
public DispatcherBuilder initialPartitionId(int initialPartitionId)
```
  - subscriptions
```
public DispatcherBuilder subscriptions(String... subscriptionNames)
```
    Predefined subscriptions which will be created on startup in the order as they are declared.
  - modePubSub
```
public DispatcherBuilder modePubSub()
```
    Publish-Subscribe-Mode (default): multiple subscriptions can read the same fragment / block concurrently in any order.
    
    See Also:
    
    modePipeline()
  - modePipeline
```
public DispatcherBuilder modePipeline()
```
    Pipeline-Mode: a subscription can only read a fragment / block if the previous subscription completes reading. The subscriptions must be created on startup using the builder method subscriptions(String...) that defines the order.
    
    See Also:
    
    modePubSub()
  - build
```
public Dispatcher build()
```
  - initAllocatedBuffer
```
protected AllocatedBuffer initAllocatedBuffer(int partitionSize)
```

Class DispatcherBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

allocateInMemory

rawBuffer

bufferFileName

bufferSize

frameMaxLength

countersManager

dispatcherName

countersBuffer

actorScheduler

subscriptionNames

mode

initialPartitionId

Constructor Detail

DispatcherBuilder

Method Detail

name

allocateInBuffer

allocateInFile

bufferSize

actorScheduler

frameMaxLength

initialPartitionId

subscriptions

modePubSub

modePipeline

build

initAllocatedBuffer