DataBuffer

v0.6.0

DataBuffer v0.6.0 DataBuffer behaviour View Source

Defines a data buffer.

Link to this section Summary

Types

t()

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

dump(buffer, timeout \\ 5000)

Dumps data from the provided buffer - bypassing the flush operation.

flush(buffer, timeout \\ 5000)

Performs a flush operation on the provided buffer.

info(buffer, timeout \\ 5000)

Returns the details of each partition within the provided buffer.

insert(buffer, data, timeout \\ 5000)

Inserts data into the provided buffer.

size(buffer, timeout \\ 5000)

Returns the current size of the provided buffer.

start_link(buffer, opts)

Starts the data buffer as a supervisor process.

sync_flush(buffer, timeout \\ 5000)

Syncronously flushes the provided buffer - returning the results.

Callbacks

handle_flush(arg1, meta)

Link to this section Types

Link to this type

t()

View Source

Specs

t() :: module()

Link to this section Functions

Link to this function

child_spec(init_arg)

View Source

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

dump(buffer, timeout \\ 5000)

View Source

Specs

dump(buffer :: t(), timeout()) :: [any()]

Dumps data from the provided buffer - bypassing the flush operation.

Link to this function

flush(buffer, timeout \\ 5000)

View Source

Specs

flush(buffer :: t(), timeout()) :: :ok

Performs a flush operation on the provided buffer.

Link to this function

info(buffer, timeout \\ 5000)

View Source

Specs

info(buffer :: t(), timeout()) :: [map()]

Returns the details of each partition within the provided buffer.

Link to this function

insert(buffer, data, timeout \\ 5000)

View Source

Specs

insert(buffer :: t(), data :: any(), timeout()) :: :ok

Inserts data into the provided buffer.

Link to this function

size(buffer, timeout \\ 5000)

View Source

Specs

size(buffer :: t(), timeout()) :: integer()

Returns the current size of the provided buffer.

Link to this function

start_link(buffer, opts)

View Source

Specs

start_link(
  buffer :: t(),
  keyword()
) :: Supervisor.on_start()

Starts the data buffer as a supervisor process.

Link to this function

sync_flush(buffer, timeout \\ 5000)

View Source

Specs

sync_flush(buffer :: t(), timeout()) :: [any()]

Syncronously flushes the provided buffer - returning the results.

Link to this section Callbacks

Link to this callback

handle_flush(arg1, meta)

View Source

Specs

handle_flush(Enumerable.t(), meta :: any()) :: any()