API Overview

This page describes how to generally use any of the fluvie clients. Each client has some differences but these are the general rules about them.

For generated API Docs visit:

 

Connect to fluvio

The first thing you want to do to use a fluvio client is connect to the fluvio cluster.

 

Producer

Once you’ve got a connection handler, you will want to create a producer for a given topic.

 

Sending

When sending into a stream, the general send will take a key and a value. The key is optional. For clients which don’t have Option as a feature, this is simply an empty array.

Depending on the client, these can be string or an array of bytes.

 

Consumer

Similar to a producing, once you’ve got a connection, you’ll need to create a consumer for a given topic.

 

Streams

Once you’ve got a consumer, you can create a stream given an offset and listen for new items.

Most of our clients support idiomatic ways of iterating over the items in the stream:

This functionality has not been implemented for the java client yet.

 

Offsets

An offset is used when a stream is created to request the stream to start at N items from the beginning/end of the stream.

 

Records

Each item in a stream is a Record.

Our clients differ a little bit on this but a Record is a wrapper around array of bytes with accessor methods of key or value.

In the python, node and java clients, we have to-string convenience methods.