Module riak_core_vnode

Behaviours: gen_fsm.

This module defines the riak_core_vnode behaviour.
Required callback functions: init/1, handle_command/3, handle_coverage/4, handle_exit/3, handoff_starting/2, handoff_cancelled/1, handoff_finished/2, handle_handoff_command/3, handle_handoff_data/2, encode_handoff_item/2, is_empty/1, terminate/2, delete/1.

Data Types

partition()

partition() = chash:index_as_int()

pool_opt()

pool_opt() = {pool, WorkerModule::module(), PoolSize::pos_integer(), WorkerArgs::[term()]}

sender()

sender() = {sender_type(), reference() | tuple(), pid()} | {server, undefined, undefined} | {fsm, undefined, pid()} | ignore

sender_type()

sender_type() = fsm | server | raw

vnode_opt()

vnode_opt() = pool_opt()

Function Index

active/2
active/3
code_change/4
core_status/1
get_mod_index/1
get_modstate/1Reveal the underlying module state for testing.
handle_event/3
handle_info/3
handle_sync_event/4
handoff_error/3
init/1
monitor/1Set up a monitor for the pid named by a sender() vnode argument.
reply/2Send a reply to a vnode request.
send_command/2
send_command_after/2
set_forwarding/2
start_link/3
start_link/4
started/2
started/3
terminate/3
trigger_delete/1
trigger_handoff/2
trigger_handoff/3
wait_for_init/1

Function Details

active/2

active(Riak_coverage_req_v1, State) -> any()

active/3

active(Event, From, State) -> any()

code_change/4

code_change(OldVsn, StateName, State, Extra) -> any()

core_status/1

core_status(VNode) -> any()

get_mod_index/1

get_mod_index(VNode) -> any()

get_modstate/1

get_modstate(Pid::pid()) -> {atom(), #state{index = partition(), mod = module(), modstate = term(), forward = node() | [{integer(), node()}], handoff_target = none | {integer(), node()}, handoff_pid = pid(), handoff_type = riak_core_handoff_manager:ho_type(), pool_pid = pid() | undefined, pool_config = tuple() | undefined, manager_event_timer = reference(), inactivity_timeout = non_neg_integer()}}

Reveal the underlying module state for testing

handle_event/3

handle_event(R, StateName, State) -> any()

handle_info/3

handle_info(Info, StateName, State) -> any()

handle_sync_event/4

handle_sync_event(X1, From, StateName, State) -> any()

handoff_error/3

handoff_error(Vnode, Err, Reason) -> any()

init/1

init(X1) -> any()

monitor/1

monitor(Sender::sender()) -> Monitor::reference()

Set up a monitor for the pid named by a sender() vnode argument. If Sender was the atom ignore, this function sets up a monitor on self() in order to return a valid (if useless) monitor reference.

reply/2

reply(X1::sender(), Reply::term()) -> any()

Send a reply to a vnode request. If the Ref is undefined just send the reply for compatibility with pre-0.12 requestors. If Ref is defined, send it along with the reply. NOTE: We *always* send the reply using unreliable delivery.

send_command/2

send_command(Pid, Request) -> any()

send_command_after/2

send_command_after(Time::integer(), Request::term()) -> reference()

set_forwarding/2

set_forwarding(VNode, ForwardTo) -> any()

start_link/3

start_link(Mod, Index, Forward) -> any()

start_link/4

start_link(Mod, Index, InitialInactivityTimeout, Forward) -> any()

started/2

started(X1, State) -> any()

started/3

started(X1, From, State) -> any()

terminate/3

terminate(Reason, StateName, State) -> any()

trigger_delete/1

trigger_delete(VNode) -> any()

trigger_handoff/2

trigger_handoff(VNode, TargetNode) -> any()

trigger_handoff/3

trigger_handoff(VNode, TargetIdx, TargetNode) -> any()

wait_for_init/1

wait_for_init(Vnode) -> any()


Generated by EDoc