splinter_open() : Opens A Splinter Memory Store

When opening a store that has already been provisioned, the shortest code path is through splinter_open(). While all methods practically end with the store being opened, workflow dictates that certain attempts should fail, rather than blindly create. You should use splinter_open() when you're sure the store has already been provisioned by splinter_create(), and want a failure condition if it can't be found.

If you want to automatically fall-back to provisioning stores if they have not been created yet, use splinter_open_or_create() or splinter_create_or_open(), depending on your need.

Prototype & Rationale:

The function splinter_open() is prototyped in splinter.h as:

int splinter_open(const char *name_or_path);

When using persistent mode, name_or_path represents a physical file location. When using standard (in-memory) mode, name_or_path represents the name of the anonymous file handle (as seen via /dev/shm/).

Return Value:

splinter_open will return 0 on success, and -1 on failure. Does not set errno; it is either able to open and map the region or is not.

Example:

The following example attempts to open a memory store named debug_bus, and exits with a status of 127 if it can't.

#include "splinter.h"

int i = -1;

i = splinter_open("debug_bus");
if (i != 0) {
    exit(127);
}

CLI & Tooling Example Uses:

To see the splinter_open() in-use within the tools that ship with Splinter, see the following source files:

See Also:

The following functions are also relevant: splinter_create(), splinter_open_or_create(), splinter_create_or_open(), splinter_open_numa() and splinter_close().