EventRouter.RoutingContext (Elara Event Sourcing)

All Superinterfaces:

AutoCloseable

Enclosing interface:

EventRouter
```
public static interface EventRouter.RoutingContext
extends AutoCloseable
```
Context object returned by EventRouter.routingEvent() allowing for zero copy encoding of events directly into the event log buffer. Routing contexts are typically used inside a try-resource block; see EventRouter documentation for usage example.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`abort()` Aborts routing of the event -- identical to `close()`; ignored if the routing context is already `closed`.
`MutableDirectBuffer`	`buffer()` Returns the buffer to encode the event directly into the event log.
`default void`	`close()` Aborts routing of the event -- identical to `abort()`; ignored if the routing context is already `closed`.
`int`	`index()`
`boolean`	`isClosed()` Returns true if this routing context has already been closed through either of `route(int)`, `abort()` or `close()`.
`void`	`route(int length)` Completes event encoding and routes the event; the event will be applied to the application context but it cannot be polled from the event log yet (starting the next event or completion of command will make the event available for polling).

- Method Detail
  - index
```
int index()
```
    Returns:
    
    index of the event currently being routed
  - buffer
```
MutableDirectBuffer buffer()
```
    Returns the buffer to encode the event directly into the event log.
    
    Returns:
    
    the buffer for coding of event data directly into the event log
    
    Throws:
    
    IllegalStateException - if this routing context has already been closed
  - route
```
void route(int length)
```
    Completes event encoding and routes the event; the event will be applied to the application context but it cannot be polled from the event log yet (starting the next event or completion of command will make the event available for polling).
    
    Parameters:
    
    length - the encoding length for the routed event
    
    Throws:
    
    IllegalArgumentException - if length is negative
    
    IllegalStateException - if this routing context has already been closed
  - abort
```
void abort()
```
    Aborts routing of the event -- identical to close(); ignored if the routing context is already closed.
  - isClosed
```
boolean isClosed()
```
    Returns true if this routing context has already been closed through either of route(int), abort() or close().
    
    Returns:
    
    true if this routing context is closed (event routed or routing aborted)
  - close
```
default void close()
```
    Aborts routing of the event -- identical to abort(); ignored if the routing context is already closed.
    
    Specified by:
    
    close in interface AutoCloseable

Interface EventRouter.RoutingContext

Method Summary

Method Detail

index

buffer

route

abort

isClosed

close