Arduino-Redis
A Redis library for Arduino.
Classes | Enumerations
Redis.h File Reference
#include "Arduino.h"
#include "Client.h"
#include <vector>
Include dependency graph for Redis.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  Redis
 

Enumerations

enum  RedisReturnValue { RedisSuccess = 0, RedisNotConnectedFailure = 1, RedisAuthFailure = 2 }
 
enum  RedisSubscribeResult {
  RedisSubscribeBadCallback = -255, RedisSubscribeSetupFailure, RedisSubscribeServerDisconnected, RedisSubscribeOtherError,
  RedisSubscribeSuccess = 0
}
 
enum  RedisMessageError { RedisMessageBadResponseType = -255, RedisMessageTruncatedResponse, RedisMessageUnknownType }
 
enum  XtrimCompareType { XtrimCompareExact = '=', XtrimCompareAtLeast = '~' }
 

Enumeration Type Documentation

◆ RedisMessageError

A value of this type will be passed as the second argument ot Redis::RedisMsgErrorCallback, if called

Enumerator
RedisMessageBadResponseType 

The underlying Redis type detected in the message is not of the type expected.

RedisMessageTruncatedResponse 

The message response was truncated early.

RedisMessageUnknownType 

An unknown error occurred.

Definition at line 60 of file Redis.h.

◆ RedisReturnValue

The return value from from Redis::authenticate()

Enumerator
RedisSuccess 
RedisNotConnectedFailure 

Authenticate attempted before the connection has been established.

RedisAuthFailure 

The authentication credentials used are not valid.

Definition at line 36 of file Redis.h.

◆ RedisSubscribeResult

The return value from Redis::startSubscribing(). See examples/Subscribe.ino for usage demo.

Enumerator
RedisSubscribeBadCallback 

One of the callback parameters given is invalid.

RedisSubscribeSetupFailure 

Setting up for subscription mode failed.

RedisSubscribeServerDisconnected 

The remote end disconnected, retry may be available.

RedisSubscribeOtherError 

An unknown error occurred.

RedisSubscribeSuccess 

Definition at line 46 of file Redis.h.

◆ XtrimCompareType

A value of this type will be passed as argument of xtrim to specify if it will be an exact trimming or nearly exact trimming

Enumerator
XtrimCompareExact 
XtrimCompareAtLeast 

Definition at line 73 of file Redis.h.