| Overview |  |
Methods for sending messages to the sink.
Sink messages are delivered as three record types:#pipe_result{}, #pipe_log{}, and #pipe_eoi{}.
sink_type() = raw | {fsm, Period::integer(), Timeout::timeout()}
| eoi/2 | Send an end-of-inputs message to the sink (used by fittings). |
| log/4 | Send a log message to the sink (used by worker processes and fittings). |
| result/4 | Send a result to the sink (used by worker processes). |
| valid_sink_type/1 | Validate the type of sink given in the execution options. |
eoi(Sink::riak_pipe:fitting(), Opts::list()) -> ok | {error, term()}
Send an end-of-inputs message to the sink (used by fittings).
The message is delivered as a #pipe_eoi{} record in the sink
process's mailbox.
log(From::term(), Sink::riak_pipe:fitting(), Msg::term(), Opts::list()) -> ok | {error, term()}
Send a log message to the sink (used by worker processes and
fittings). The message is delivered as a #pipe_log{} record
in the sink process's mailbox.
result(From::term(), Sink::riak_pipe:fitting(), Output::term(), Opts::riak_pipe:exec_opts()) -> ok | {error, term()}
Send a result to the sink (used by worker processes). The
result is delivered as a #pipe_result{} record in the sink
process's mailbox.
valid_sink_type(Opts::riak_pipe:exec_opts()) -> true | {false, term()}
Validate the type of sink given in the execution
options. Returns true if the type is valid, or {false, Type} if
invalid, where Type is what was found.
Generated by EDoc