Dispatcher (Zeebe Dispatcher 0.12.1 API)

java.lang.Object
- io.zeebe.util.sched.Actor
- - io.zeebe.dispatcher.Dispatcher

All Implemented Interfaces:

AutoCloseable
```
public class Dispatcher
extends Actor
implements AutoCloseable
```
Component for sending and receiving messages between different threads.

Field Summary

Fields
Modifier and Type	Field and Description
`protected String[]`	`defaultSubscriptionNames`
`protected boolean`	`isClosed`
`protected LogBufferAppender`	`logAppender`
`protected LogBuffer`	`logBuffer`
`protected int`	`logWindowLength`
`protected int`	`maxFrameLength`
`protected MetricsManager`	`metricsManager`
`protected int`	`mode`
`static int`	`MODE_PIPELINE`
`static int`	`MODE_PUB_SUB`
`protected String`	`name`
`protected int`	`partitionSize`
`protected AtomicPosition`	`publisherLimit`
`protected AtomicPosition`	`publisherPosition`
`protected Subscription[]`	`subscriptions`

Fields inherited from class io.zeebe.util.sched.Actor
actor

Constructor Summary

Constructors
Constructor and Description
`Dispatcher(LogBuffer logBuffer, LogBufferAppender logAppender, AtomicPosition publisherLimit, AtomicPosition publisherPosition, int logWindowLength, String[] subscriptionNames, int mode, String name, MetricsManager metricsManager)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`claim(ClaimedFragmentBatch batch, int fragmentCount, int batchLength)` Claim a batch of fragments on the buffer with the given length.
`long`	`claim(ClaimedFragment claim, int length)` Claim a fragment of the buffer with the given length.
`long`	`claim(ClaimedFragment claim, int length, int streamId)` Claim a fragment of the buffer with the given length and stream id.
`void`	`close()`
`ActorFuture<Void>`	`closeAsync()`
`void`	`closeSubscription(Subscription subscriptionToClose)` Close the given subscription.
`ActorFuture<Void>`	`closeSubscriptionAsync(Subscription subscriptionToClose)` Close the given subscription asynchronously.
`protected AtomicPosition`	`determineLimit(int subscriptionId)`
`protected void`	`doCloseSubscription(Subscription subscriptionToClose)`
`protected Subscription`	`doOpenSubscription(String subscriptionName, ActorCondition onConsumption)`
`protected void`	`ensureUniqueSubscriptionName(String subscriptionName)`
`protected Subscription`	`findSubscriptionByName(String subscriptionName)`
`LogBuffer`	`getLogBuffer()`
`int`	`getMaxFrameLength()`
`String`	`getName()`
`long`	`getPublisherLimit()`
`long`	`getPublisherPosition()`
`int`	`getSubscriberCount()`
`Subscription`	`getSubscription(String subscriptionName)`
`ActorFuture<Subscription>`	`getSubscriptionAsync(String subscriptionName)`
`boolean`	`isClosed()`
`protected Subscription`	`newSubscription(int subscriptionId, String subscriptionName, ActorCondition onConsumption)`
`long`	`offer(org.agrona.DirectBuffer msg)` Writes the given message to the buffer.
`long`	`offer(org.agrona.DirectBuffer msg, int streamId)` Writes the given message to the buffer with the given stream id.
`long`	`offer(org.agrona.DirectBuffer msg, int start, int length)` Writes the given part of the message to the buffer.
`long`	`offer(org.agrona.DirectBuffer msg, int start, int length, int streamId)` Writes the given part of the message to the buffer with the given stream id.
`protected void`	`onActorClosing()`
`protected void`	`onActorStarted()`
`protected void`	`openDefaultSubscriptions()`
`Subscription`	`openSubscription(String subscriptionName)` Creates a new subscription with the given name.
`ActorFuture<Subscription>`	`openSubscriptionAsync(String subscriptionName)` Creates a new subscription with the given name asynchronously.
`String`	`toString()`
`int`	`updatePublisherLimit()`
`protected long`	`updatePublisherPosition(int activePartitionId, int newOffset)`

Methods inherited from class io.zeebe.util.sched.Actor
onActorClosed, onActorCloseRequested, onActorStarting, wrap

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

- Field Detail
  - MODE_PUB_SUB
```
public static final int MODE_PUB_SUB
```
    See Also:
    
    Constant Field Values
  - MODE_PIPELINE
```
public static final int MODE_PIPELINE
```
    See Also:
    
    Constant Field Values
  - logBuffer
```
protected final LogBuffer logBuffer
```
  - logAppender
```
protected final LogBufferAppender logAppender
```
  - metricsManager
```
protected final MetricsManager metricsManager
```
  - publisherLimit
```
protected final AtomicPosition publisherLimit
```
  - publisherPosition
```
protected final AtomicPosition publisherPosition
```
  - defaultSubscriptionNames
```
protected final String[] defaultSubscriptionNames
```
  - subscriptions
```
protected Subscription[] subscriptions
```
  - maxFrameLength
```
protected final int maxFrameLength
```
  - partitionSize
```
protected final int partitionSize
```
  - logWindowLength
```
protected int logWindowLength
```
  - name
```
protected final String name
```
  - mode
```
protected final int mode
```
  - isClosed
```
protected volatile boolean isClosed
```
- Constructor Detail
  - Dispatcher
```
public Dispatcher(LogBuffer logBuffer,
                  LogBufferAppender logAppender,
                  AtomicPosition publisherLimit,
                  AtomicPosition publisherPosition,
                  int logWindowLength,
                  String[] subscriptionNames,
                  int mode,
                  String name,
                  MetricsManager metricsManager)
```
- Method Detail
  - getName
```
public String getName()
```
    Overrides:
    
    getName in class Actor
  - onActorStarted
```
protected void onActorStarted()
```
    Overrides:
    
    onActorStarted in class Actor
  - onActorClosing
```
protected void onActorClosing()
```
    Overrides:
    
    onActorClosing in class Actor
  - openDefaultSubscriptions
```
protected void openDefaultSubscriptions()
```
  - offer
```
public long offer(org.agrona.DirectBuffer msg)
```
    Writes the given message to the buffer. This can fail if the publisher limit or the buffer partition size is reached.
    
    Returns:
    
    the new publisher position if the message was written successfully. Otherwise, the return value is negative.
  - offer
```
public long offer(org.agrona.DirectBuffer msg,
                  int streamId)
```
    Writes the given message to the buffer with the given stream id. This can fail if the publisher limit or the buffer partition size is reached.
    
    Returns:
    
    the new publisher position if the message was written successfully. Otherwise, the return value is negative.
  - offer
```
public long offer(org.agrona.DirectBuffer msg,
                  int start,
                  int length)
```
    Writes the given part of the message to the buffer. This can fail if the publisher limit or the buffer partition size is reached.
    
    Returns:
    
    the new publisher position if the message was written successfully. Otherwise, the return value is negative.
  - offer
```
public long offer(org.agrona.DirectBuffer msg,
                  int start,
                  int length,
                  int streamId)
```
    Writes the given part of the message to the buffer with the given stream id. This can fail if the publisher limit or the buffer partition size is reached.
    
    Returns:
    
    the new publisher position if the message was written successfully. Otherwise, the return value is negative.
  - claim
```
public long claim(ClaimedFragment claim,
                  int length)
```
    Claim a fragment of the buffer with the given length. Use ClaimedFragment.getBuffer() to write the message and finish the operation using ClaimedFragment.commit() or ClaimedFragment.abort(). Note that the claim operation can fail if the publisher limit or the buffer partition size is reached.
    
    Returns:
    
    the new publisher position if the fragment was claimed successfully. Otherwise, the return value is negative.
  - claim
```
public long claim(ClaimedFragment claim,
                  int length,
                  int streamId)
```
    Claim a fragment of the buffer with the given length and stream id. Use ClaimedFragment.getBuffer() to write the message and finish the operation using ClaimedFragment.commit() or ClaimedFragment.abort(). Note that the claim operation can fail if the publisher limit or the buffer partition size is reached.
    
    Returns:
    
    the new publisher position if the fragment was claimed successfully. Otherwise, the return value is negative.
  - claim
```
public long claim(ClaimedFragmentBatch batch,
                  int fragmentCount,
                  int batchLength)
```
    Claim a batch of fragments on the buffer with the given length. Use #nextFragment(int, int) to add a new fragment to the batch. Write the fragment message using #getBuffer() and #getFragmentOffset() to get the buffer offset of this fragment. Complete the whole batch operation by calling either #commit() or #abort(). Note that the claim operation can fail if the publisher limit or the buffer partition size is reached.
    
    Returns:
    
    the new publisher position if the batch was claimed successfully. Otherwise, the return value is negative.
  - updatePublisherPosition
```
protected long updatePublisherPosition(int activePartitionId,
                                       int newOffset)
```
  - updatePublisherLimit
```
public int updatePublisherLimit()
```
  - openSubscription
```
public Subscription openSubscription(String subscriptionName)
```
    Creates a new subscription with the given name.
    
    Throws:
    
    IllegalStateException -
    if the dispatcher runs in pipeline-mode,
    if a subscription with this name already exists
  - openSubscriptionAsync
```
public ActorFuture<Subscription> openSubscriptionAsync(String subscriptionName)
```
    Creates a new subscription with the given name asynchronously. The operation fails if the dispatcher runs in pipeline-mode or a subscription with this name already exists.
  - getSubscriptionAsync
```
public ActorFuture<Subscription> getSubscriptionAsync(String subscriptionName)
```
  - getSubscription
```
public Subscription getSubscription(String subscriptionName)
```
  - doOpenSubscription
```
protected Subscription doOpenSubscription(String subscriptionName,
                                          ActorCondition onConsumption)
```
  - ensureUniqueSubscriptionName
```
protected void ensureUniqueSubscriptionName(String subscriptionName)
```
  - newSubscription
```
protected Subscription newSubscription(int subscriptionId,
                                       String subscriptionName,
                                       ActorCondition onConsumption)
```
  - determineLimit
```
protected AtomicPosition determineLimit(int subscriptionId)
```
  - closeSubscription
```
public void closeSubscription(Subscription subscriptionToClose)
```
    Close the given subscription.
    
    Throws:
    
    IllegalStateException - if the dispatcher runs in pipeline-mode.
  - closeSubscriptionAsync
```
public ActorFuture<Void> closeSubscriptionAsync(Subscription subscriptionToClose)
```
    Close the given subscription asynchronously. The operation fails if the dispatcher runs in pipeline-mode.
  - doCloseSubscription
```
protected void doCloseSubscription(Subscription subscriptionToClose)
```
  - findSubscriptionByName
```
protected Subscription findSubscriptionByName(String subscriptionName)
```
  - isClosed
```
public boolean isClosed()
```
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - closeAsync
```
public ActorFuture<Void> closeAsync()
```
  - getLogBuffer
```
public LogBuffer getLogBuffer()
```
  - getMaxFrameLength
```
public int getMaxFrameLength()
```
  - getPublisherPosition
```
public long getPublisherPosition()
```
  - getPublisherLimit
```
public long getPublisherLimit()
```
  - getSubscriberCount
```
public int getSubscriberCount()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Dispatcher

Field Summary

Fields inherited from class io.zeebe.util.sched.Actor

Constructor Summary

Method Summary

Methods inherited from class io.zeebe.util.sched.Actor

Methods inherited from class java.lang.Object

Field Detail

MODE_PUB_SUB

MODE_PIPELINE

logBuffer

logAppender

metricsManager

publisherLimit

publisherPosition

defaultSubscriptionNames

subscriptions

maxFrameLength

partitionSize

logWindowLength

name

mode

isClosed

Constructor Detail

Dispatcher

Method Detail

getName

onActorStarted

onActorClosing

openDefaultSubscriptions

offer

offer

offer

offer

claim

claim

claim

updatePublisherPosition

updatePublisherLimit

openSubscription

openSubscriptionAsync

getSubscriptionAsync

getSubscription

doOpenSubscription

ensureUniqueSubscriptionName

newSubscription

determineLimit

closeSubscription

closeSubscriptionAsync

doCloseSubscription

findSubscriptionByName

isClosed

close

closeAsync

getLogBuffer

getMaxFrameLength

getPublisherPosition

getPublisherLimit

getSubscriberCount

toString