SDK
SDK C++ v1.x
1
C++C++ v1.x

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

This SDK has been deprecated because of stability issues. It is not advised to use it in a production environment.

Kuzzle class getters #

autoQueue #

Returns a boolean telling if queries are automatically queued during offline mode.

Arguments #

bool autoQueue() const noexcept;

autoReconnect #

Returns a boolean telling if it will automatically reconnect after a connection loss.

Arguments #

bool autoReconnect() const noexcept;

autoReplay #

Returns a boolean telling if it automatically replays queued requests on a reconnected event.

Arguments #

bool autoReplay() const noexcept;

autoResubscribe #

Returns a boolean telling if it automatically renews all subscriptions on a reconnected event.

Arguments #

bool autoResubscribe() const noexcept;

getProtocol #

Returns the protocol instance used internally to communicate with the Kuzzle server.

Arguments #

Protocol* getProtocol();

jwt #

Returns the JWT currently used to authenticate requests.

Arguments #

const std::string jwt() const noexcept;

queueMaxSize #

Returns the number of maximum requests kept during offline mode.

Arguments #

int queueMaxSize() const noexcept;

queueTTL #

Returns the time a queued request is kept during offline mode, in milliseconds.

Arguments #

int queueTTL() const noexcept;

replayInterval #

Returns the delay between each replayed requests.

Arguments #

int replayInterval() const noexcept;

reconnectionDelay #

Returns the time between each reconnection attempt, in milliseconds.

Arguments #

int reconnectionDelay() const noexcept;

volatiles #

Returns the JSON string representing volatile data sent with each request.

Arguments #

const std::string& volatiles() const noexcept;

Usage #

kuzzleio::WebSocket *ws = new kuzzleio::WebSocket("kuzzle");
kuzzleio::Kuzzle *kuzzle = new kuzzleio::Kuzzle(ws);
std::string jwt_token = kuzzle->jwt();
kuzzleio::Protocol *protocol = kuzzle->getProtocol();
int max_size = kuzzle->queueMaxSize();
int queue_ttl = kuzzle->queueTTL();
int replay_interval = kuzzle->replayInterval();
int reconnection_delay = kuzzle->reconnectionDelay();
std::string volatile_data = kuzzle->volatiles();
bool auto_queue = kuzzle->autoQueue();
bool auto_reconnect = kuzzle->autoReconnect();
bool auto_replay = kuzzle->autoReplay();
bool auto_resubscribe = kuzzle->autoResubscribe();
Edit this page on Github(opens new window)