Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 1234]

▼NPhants
▼NRedis
▼NParameterTypes
CBitfieldSubcommand	This class takes a factory method approach to generating subcommands that can be used with the BitField() method. Each of the four methods creates a subcommand object that corresponds to those of the Redis BITFIELD command.
CClientKillFilter	This class takes a factory method approach to generating filters that can be used with the ClientKill(IntegerSink, params ClientKillFilter[]) method, which supports multiple CLIENT KILL filters in one command.
CFieldValuePair	This is a simple class (treated as a struct) that holds a key/value pair. It is used by the HmSet() and Xadd() methods.
CGeoCoord	This is a simple class (treated as a struct) that holds the lat/long/member parameters used by the GeoAdd() method.
CGeoRadiusOptions
CKeyValuePair	This is a simple class (treated as a struct) that holds a key/value pair. It is used by the Mset() and MsetNx() methods.
CLimit	This is a simple class (treated as a struct) that holds an offset and a count. It is used by the ZrangeByLex() and ZrevRangeByLex() methods. It is also a parameter that can be set in the ZrangeByScoreOptions and SortOptions classes.
CRestoreOptions	Options class used by the Restore() method.
CScanOptions	Options class used by the Hscan(), Scan(), Sscan(), and Zscan() methods.
CSetOptions	Options class used by the Set() method.
CSortOptions	Options class used by the Sort() method(s).
CXclaimOptions	Options class used by the Xclaim() method.
CXgroupCreateOptions	Options class used by the XgroupCreate() method.
CXpendingOptions	Options class used by the Xpending() method.
CXReadGroupOptions	Options class used by the XreadGroup() method.
CXReadKeyIdPair	This is a simple class (treated as a struct) that holds a key/id pair. It is used by the Xread() and XreadGroup() methods.
CXReadOptions	Options class used by the Xread() method.
CZaddOptions	Options class used by the Zadd() and ZaddWithIncr() methods.
CZaddScoreMemberPair	This is a simple class (treated as a struct) that holds a score/member pair. It is used by the Zadd() and ZaddWithIncr() methods.
CZrangeByScoreOptions	Options class used by the ZrangeByScore() and ZrevRangeByScore() methods.
CZstoreOptions	Options class used by the ZinterStore() and ZunionStore() methods.
▼NParsers
CArrayParser	This interface defines methods that are called at the start and end of a RESP Array. Since Arrays can contain any RESP type (including other Arrays), this interface does not provide callbacks for the individual elements. The interfaces that do provide this are:
CBulkStringParser	This interface defines methods that are called when a RESP Bulk String is being parsed.
CErrorParser	This interface defines the method that is called when a RESP Error is parsed.
CIntegerParser	This interface defines the method that is called when a RESP Integer is parsed.
CRespParser	This interface serves as a sort of super interface, combining all types of Resp parsers. A class interested in implementing a full featured Resp Parser would implement this interface. This might be overkill for user code though (e.g. a callback handler that expects only an integer), so we have an à la carte menu of interfaces here.
CSimpleStringParser	This interface defines the method that is called when a RESP Simple String is parsed.
▼NSinkAdapters	Common callbacks for sink adapters.
CBulkStringArraySinkAdapter	An implementation of the ArraySink interface that is designed to handle RESP Arrays of Bulk Strings.
CBulkStringSinkAdapter	An implementation of the BulkStringSink interface that is designed to handle RESP Bulk Strings.
CIntegerArraySinkAdapter	An implementation of the ArraySink interface that is designed to handle RESP Arrays of Integers.
CIntegerSinkAdapter	An implementation of the IntegerSink interface that is designed to handle RESP Integers.
CSimpleStringSinkAdapter	An implementation of the SimpleStringSink interface that is designed to handle RESP Simple Strings.
▼NSinks	Data sinks; these interfaces define callbacks for each RESP data type. Any class that implements a given sink provides a way for CommandClient to return data corresponding to that sink type. Since any Redis command can return a RESP Error, an error callback is part of each sink type.
CArraySink	Sink interface used to support Redis commands that return Arrays. Since RESP Arrays can contain any data type (including other Arrays), this sink provides a callback for any and all RESP types.
CBulkStringSink	Sink interface used to support Redis commands that return Bulk Strings.
CIntegerSink	Sink interface used to support Redis commands that return Integer.
CSimpleStringSink	Sink interface used to support Redis commands that return Simple Strings.
▼NUtil
CBufferDescriptor	Basically just a dumb struct for storing buffer state, but defined as a class so we can pass around references to it.
CCommandClient	Redis has two modes of operation: a "command" mode, and a "pub/sub" mode. CommandClient implements the former, meaning users issue Redis commands and receive responses via callbacks. The methods of this class directly correspond to the Redis commands defined here.
CMessageParser	This class serves as a concrete implementation of the RespParser interface. It handles parsing of redis subscription methods. Since messages use a fixed format, state is tracked and everything is parsed into a specific structure.
CRedisClientBase	Serves as the base class for all Redis client implementations. Common socket connect/disconnect code lives here.
CResponseProcessor	The methods of this interface reflect the message types generated by Redis while it is in "pub/sub" mode.
CSubscriptionClient	Redis has two modes of operation: a "command" mode, and a "pub/sub" mode. SubscriptionClient implements the latter, meaning users subscribe to channels and wait to receive messages. See pubsub for more information about the Redis publisher/subscriber model.