View Source EchoPubSub.Producer.RingBuffer (EchoPubSub v0.2.3)

Pure helpers over the producer's fixed-size :array. Cursors only grow; a cursor maps to slot rem(cursor, capacity), so a write overwrites the message capacity positions behind it.

Summary

Types

cursor()
pending()
t()

Functions

capacity(buffer)

Number of messages the buffer holds.

new(size)

An empty buffer holding the last size messages.

pending(buffer, read_cursor, write_cursor)

What a node with read_cursor still needs: nothing, the messages up to write_cursor in order, or {:expired, missed} once the oldest missed were overwritten.

put(buffer, cursor, message)

Stores message at cursor, overwriting the slot's previous message.

Types

Link to this type

cursor()

View Source 
@type cursor() :: non_neg_integer()
Link to this type

pending()

View Source 
@type pending() :: :caught_up | {:expired, pos_integer()} | {:messages, [term()]}
Link to this type

t()

View Source 
@type t() :: :array.array()

Functions

Link to this function

capacity(buffer)

View Source 
@spec capacity(t()) :: pos_integer()

Number of messages the buffer holds.

Link to this function

new(size)

View Source 
@spec new(pos_integer()) :: t()

An empty buffer holding the last size messages.

Link to this function

pending(buffer, read_cursor, write_cursor)

View Source 
@spec pending(t(), cursor(), cursor()) :: pending()

What a node with read_cursor still needs: nothing, the messages up to write_cursor in order, or {:expired, missed} once the oldest missed were overwritten.

Link to this function

put(buffer, cursor, message)

View Source 
@spec put(t(), cursor(), term()) :: t()

Stores message at cursor, overwriting the slot's previous message.