Module luwak_get_stream

Function Index

close/1Closes a get stream.
recv/2Receive will block the calling process until either the next data block has been delivered, the stream ends, or until Timeout milliseconds have elapsed.
start/4Creates and returns a handle to a streaming get.

Function Details

close/1

close(X1) -> any()

Closes a get stream. Use this to stop the flow of messages from a get stream. It is not required that a completed stream have close called on it.

recv/2

recv(Stream::get_stream(), Timeout::int()) -> {binary(), int()} | eos | closed | {error, timeout}

Receive will block the calling process until either the next data block has been delivered, the stream ends, or until Timeout milliseconds have elapsed. Whichever occurs first. The data blocks are returned as a tuple with the data binary and its offset from the start of the file.

start/4

start(Riak::riak(), File::luwak_file(), Start::int(), Length::length()) -> get_stream()

Creates and returns a handle to a streaming get. Initiating this call will cause the requested datablock ranges to be delivered as a set of messages to the calling process.


Generated by EDoc, May 31 2010, 11:13:39.