arbiter

KO | EN

gitlite — search

#hacktoberfest #ai #typescript #llm #golang #go #deep-learning #nodejs #windows #awesome #kubernetes #security #mcp #open-source

(★ 19)

Uniform access to the filesystem, HTTP, S3, GCS, Dropbox, etc.

arbiter Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Arbiter

Arbiter provides simple/fast/thread-safe C++ access to filesystem, HTTP, S3, and Dropbox resources in a uniform way.  It is designed to be extendible, so other resource types may also be abstracted.

## API sample

Full docs live [here](http://arbitercpp.com/classarbiter_1_1_arbiter.html).  The core API is intended to be as simple as possible.

```cpp
using namespace arbiter;

Arbiter a;

std::string fsPath, httpPath, s3Path;
std::string fsData, httpData, s3Data;
std::vector<std::string> fsGlob, s3Glob;

// Read and write data.
fsPath = "~/fs.txt";  // Tilde expansion is supported on both Unix and Windows.
a.put(fsPath, "Filesystem contents!");
fsData = a.get(fsPath);

httpPath = "http://some-server.com/http.txt";
a.put(httpPath, "HTTP contents!");
httpData = a.get(httpPath);

// S3 credentials can be inferred from the environment or well-known FS paths.
s3Path = "s3://some-bucket/s3.txt";
a.put(s3Path, "S3 contents!");
s3Data = a.get(s3Path);

// Resolve globbed directory paths.
fsGlob = a.resolve("~/data/*");
s3Glob = a.resolve("s3://some-bucket/some-dir/*");
```

Some drivers accept (or might require) explicit values for configuration.

Arbiter takes a `std::string` json argument.  Here is an example using `nlohmann::json` that is also used internally in Arbiter.

```cpp
#include <arbiter/util/json.hpp>
using namespace arbiter;

json config = {
    { "dropbox", {
        {"token", "My dropbox token"}
    }},
    {"s3", {
        {"region", "ap-southeast-2"},
        {"access", "My access key"},
        {"secret", "My secret key"}
    }}
};

std::string configStr = config.dump();
Arbiter a(configStr);

// Now dropbox and S3 paths are accessible.
auto data = a.get("dropbox://my-file.txt");
```

## Using Arbiter in your project

### Installation

Arbiter uses CMake for its build process.  To build and install, run from the top level:

```bash
mkdir build && cd build
cmake -G "<CMake generator type>" ..    # For example: cmake -G "Unix Makefiles" ..
make
make install
```

Then simply include the header in your project:

```cpp
#include <arbiter/arbiter.h>
```

...and link with the library with `-larbiter`.

### Amalgamation

The amalgamation method lets you integrate Arbiter into your project by adding a single source and a single header to your project.  Create the amalgamation by running from the top level:

`python amalgamate.py`

Then copy `dist/arbiter.hpp` and `dist/arbiter.cpp` into your project tree and include them in your build system like any other source files.  With this method you'll need to link the Curl [dependency](#dependencies) into your project manually.

Once the amalgamated files are integrated with your source tree, simply `#include "arbiter.hpp"` and get to work.

### Dependencies

Arbiter depends on [Curl](http://curl.haxx.se/libcurl/), which comes preinstalled on most UNIX-based machines.  To manually link (for amalgamated usage) on Unix-based operating systems, link with `-lcurl`.  Arbiter also works on Windows, but you'll have to obtain Curl yourself there.

Arbiter requires C++17.

arbiter

arbiter Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

arbiter

arbiter Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README