Module shm

Source
Expand description

Defines operations to create readers and writers backed by a memory mapped channel.

Modules§

reader
writer

Functions§

shm_reader
Creates a kekbit reader associated to a memory mapped channel.
shm_writer
Creates a file backed memory mapped kekbit channel and a writer associate with it.
storage_path
Returns the path to the file associated with a channel inside a kekbit root folder.
try_shm_reader
Tries multiple times to create a kekbit reader associated to a memory mapped channel. This function will basically call shm_reader up to tries time unless it succeeds. Between two tries the function will spin/sleep for a about duration_millis/tries milliseconds so potentially could be blocking. This should be the preferred method to create a reader when you are willing to wait until the channel is available.