Vdr.RedisStream.CommandFilter (veidrodelis v0.1.7)

Copy Markdown View Source

Defines a filter for processing Redis commands in replica before and after callback execution.

Filters can modify commands, add context, or skip commands entirely. The context map in ReplicaCommand can be used to pass data between pre_handle and post_handle.

Summary

Types

post_handle()
pre_handle()
t()

Functions

apply_post(filter, replica_commands, result)

Applies the filter to the list of replica commands. Used internally by the replica.

apply_pre(filter, replica_commands, filtered_commands \\ [])

Applies the filter to the list of replica commands. Used internally by the replica.

combine(outer_filter, inner_filter)

Combines two filters into a single filter.

identity_post_handle(replica_command, result)

Default post_handle that does nothing.

identity_pre_handle(replica_command)

Default pre_handle that passes the command through unchanged.

Types

post_handle()

@type post_handle() :: (Vdr.RedisStream.ReplicaCommand.t(), :ok | {:error, term()} ->
                    :ok)

pre_handle()

@type pre_handle() :: (Vdr.RedisStream.ReplicaCommand.t() ->
                   {:ok, Vdr.RedisStream.ReplicaCommand.t()} | :skip)

t()

@type t() :: %Vdr.RedisStream.CommandFilter{
  post_handle: post_handle(),
  pre_handle: pre_handle()
}

Functions

apply_post(filter, replica_commands, result)

Applies the filter to the list of replica commands. Used internally by the replica.

apply_pre(filter, replica_commands, filtered_commands \\ [])

Applies the filter to the list of replica commands. Used internally by the replica.

combine(outer_filter, inner_filter)

Combines two filters into a single filter.

The outer filter's pre_handle runs first, then the inner filter's pre_handle. Post-handles run in reverse order (inner first, then outer).

If either pre_handle returns :skip, the combined filter returns :skip.

identity_post_handle(replica_command, result)

Default post_handle that does nothing.

identity_pre_handle(replica_command)

Default pre_handle that passes the command through unchanged.