Inheritance diagram for CommandClient:

Collaboration diagram for CommandClient:

Public Member Functions
	CommandClient (string hostname, int port, int recvBufferLen, int sendBufferLen)

void	Auth (SimpleStringSink sink, string password)

void	Echo (BulkStringSink sink, string message)

void	Ping (BulkStringSink sink, string message)

void	Ping (SimpleStringSink sink)

void	Quit (SimpleStringSink sink)

void	Select (SimpleStringSink sink, int index)

void	SwapDb (SimpleStringSink sink, int indexOne, int indexTwo)

void	GeoAdd (IntegerSink sink, string key, params GeoCoord[] geoCoords)

void	GeoAdd (IntegerSink sink, string key, string longitude, string latitude, string member)

void	GeoDist (BulkStringSink sink, string key, string member1, string member2, GeoUnit unit)

void	GeoDist (BulkStringSink sink, string key, string member1, string member2)

void	GeoHash (ArraySink sink, string key, params string[] members)

void	GeoPos (ArraySink sink, string key, params string[] members)

void	GeoRadius (ArraySink sink, string key, string longitude, string latitude, string radius, GeoUnit unit, GeoFlags flags, GeoRadiusOptions options=null)

void	GeoRadius (IntegerSink sink, string key, string longitude, string latitude, string radius, GeoUnit unit, string storeKey, string storeDistKey, GeoRadiusOptions options=null)

void	GeoRadiusByMember (ArraySink sink, string key, string member, string radius, GeoUnit unit, GeoFlags flags, GeoRadiusOptions options=null)

void	GeoRadiusByMember (IntegerSink sink, string key, string member, string radius, GeoUnit unit, string storeKey, string storeDistKey, GeoRadiusOptions options=null)

void	Hdel (IntegerSink sink, string key, params string[] fields)

void	Hexists (IntegerSink sink, string key, string field)

void	Hget (BulkStringSink sink, string key, string field)

void	HgetAll (ArraySink sink, string key)

void	HincrBy (IntegerSink sink, string key, string field, long increment)

void	HincrByFloat (BulkStringSink sink, string key, string field, float increment)

void	Hkeys (ArraySink sink, string key)

void	Hlen (IntegerSink sink, string key)

void	HmGet (ArraySink sink, string key, params string[] fields)

void	HmSet (SimpleStringSink sink, string key, params FieldValuePair[] pairs)

void	Hscan (ArraySink sink, string key, ulong cursor, ScanOptions options)

void	Hscan (ArraySink sink, string key, ulong cursor)

void	Hset (IntegerSink sink, string key, string field, string value)

void	HsetNx (IntegerSink sink, string key, string field, string value)

void	HstrLen (IntegerSink sink, string key, string field)

void	Hvals (ArraySink sink, string key)

void	Pfadd (IntegerSink sink, string key, params string[] elements)

void	Pfcount (IntegerSink sink, params string[] keys)

void	Pfmerge (SimpleStringSink sink, string destkey, params string[] sourcekey)

void	Del (IntegerSink sink, params string[] keys)

void	Dump (BulkStringSink sink, string key)

void	Exists (IntegerSink sink, params string[] keys)

void	Expire (IntegerSink sink, string key, int seconds)

void	ExpireAt (IntegerSink sink, string key, int timestamp)

void	Keys (ArraySink sink, string pattern)

void	Migrate (SimpleStringSink sink, string host, int port, string key, int destDb, int timeout)

void	Migrate (SimpleStringSink sink, string host, int port, int destDb, int timeout, bool copy, bool replace, params string[] keys)

void	Move (IntegerSink sink, string key, int db)

void	Persist (IntegerSink sink, string key)

void	Pexpire (IntegerSink sink, string key, int milliseconds)

void	PexpireAt (IntegerSink sink, string key, int timestamp)

void	Pttl (IntegerSink sink, string key)

void	RandomKey (BulkStringSink sink)

void	Rename (SimpleStringSink sink, string key, string newkey)

void	RenameNx (IntegerSink sink, string key, string newkey)

void	Restore (SimpleStringSink sink, string key, int ttl, string serializedValue, RestoreOptions options)

void	Scan (ArraySink sink, ulong cursor, ScanOptions options)

void	Sort (ArraySink sink, string key, SortOptions options)

void	Sort (IntegerSink sink, string key, SortOptions options, string storeKey)

void	Touch (IntegerSink sink, params string[] keys)

void	Ttl (IntegerSink sink, string key)

void	Type (SimpleStringSink sink, string key)

void	Unlink (IntegerSink sink, params string[] keys)

void	Wait (IntegerSink sink, int numReplicas, int timeout)

void	Blpop (ArraySink sink, int timeout, params string[] keys)

void	Brpop (ArraySink sink, int timeout, params string[] keys)

void	BrpopLpush (BulkStringSink sink, string source, string destination, int timeout)

void	Lindex (BulkStringSink sink, string key, int index)

void	Linsert (IntegerSink sink, string key, PivotType pivotType, string pivot, string value)

void	Llen (IntegerSink sink, string key)

void	Lpop (BulkStringSink sink, string key)

void	Lpush (IntegerSink sink, string key, params string[] values)

void	Lpushx (IntegerSink sink, string key, string value)

void	Lrange (ArraySink sink, string key, int start, int stop)

void	Lrem (IntegerSink sink, string key, int count, string value)

void	Lset (SimpleStringSink sink, string key, int index, string value)

void	Ltrim (SimpleStringSink sink, string key, int start, int stop)

void	Rpop (BulkStringSink sink, string key)

void	RpopLpush (BulkStringSink sink, string source, string destination)

void	Rpush (IntegerSink sink, string key, params string[] values)

void	Rpushx (IntegerSink sink, string key, string value)

void	Publish (IntegerSink sink, string channel, string message)

void	PubsubChannels (ArraySink sink, string pattern)

void	PubsubChannels (ArraySink sink)

void	PubsubNumSub (ArraySink sink, params string[] channels)

void	PubsubNumPat (IntegerSink sink)

void	Eval (ArraySink sink, string script, string[] keys, params string[] argv)

void	EvalSha (ArraySink sink, string sha1, string[] keys, params string[] argv)

void	ScriptDebug (SimpleStringSink sink, DebugState debugState)

void	ScriptExists (ArraySink sink, params string[] digests)

void	ScriptFlush (SimpleStringSink sink)

void	ScriptKill (SimpleStringSink sink)

void	ScriptLoad (BulkStringSink sink, string script)

void	Bgrewriteaof (SimpleStringSink sink)

void	Bgsave (SimpleStringSink sink)

void	ClientGetname (BulkStringSink sink)

void	ClientId (IntegerSink sink)

void	ClientKill (SimpleStringSink sink, string ip, int port)

void	ClientKill (IntegerSink sink, params ClientKillFilter[] filters)

void	ClientList (BulkStringSink sink)

void	ClientList (BulkStringSink sink, ClientListClassType type)

void	ClientPause (SimpleStringSink sink, int timeout)

void	ClientSetName (SimpleStringSink sink, string name)

void	ClientUnblock (IntegerSink sink, long clientId, ClientUnblockOption option)

void	ClientUnblock (IntegerSink sink, long clientId)

void	Command (ArraySink sink)

void	CommandCount (IntegerSink sink)

void	CommandGetkeys (ArraySink sink, params string[] args)

void	CommandInfo (ArraySink sink, params string[] commandNames)

void	ConfigGet (ArraySink sink, string parameter)

void	ConfigResetStat (SimpleStringSink sink)

void	ConfigRewrite (SimpleStringSink sink)

void	ConfigSet (SimpleStringSink sink, string parameter, string value)

void	DbSize (IntegerSink sink)

void	FlushAll (SimpleStringSink sink, bool async)

void	FlushDb (SimpleStringSink sink, bool async)

void	Info (BulkStringSink sink, string section=null)

void	LastSave (IntegerSink sink)

void	MemoryDoctor (BulkStringSink sink)

void	MemoryHelp (ArraySink sink)

void	MemoryMallocStats (BulkStringSink sink)

void	MemoryPurge (SimpleStringSink sink)

void	MemoryStats (ArraySink sink)

void	MemoryUsage (IntegerSink sink, string key, int count)

void	MemoryUsage (IntegerSink sink, string key)

void	ReplicaOf (SimpleStringSink sink, string host, string port)

void	Role (ArraySink sink)

void	Save (SimpleStringSink sink)

void	Shutdown (SimpleStringSink sink)

void	Shutdown (SimpleStringSink sink, ShutdownOption option)

void	SlaveOf (SimpleStringSink sink, string host, string port)

void	SlowLogGet (ArraySink sink, int count)

void	SlowLogGet (ArraySink sink)

void	SlowLogLen (IntegerSink sink)

void	SlowLogReset (SimpleStringSink sink)

void	Time (ArraySink sink)

void	Sadd (IntegerSink sink, string key, params string[] members)

void	Scard (IntegerSink sink, string key)

void	Sdiff (ArraySink sink, params string[] keys)

void	SdiffStore (IntegerSink sink, string destination, params string[] keys)

void	Sinter (ArraySink sink, params string[] keys)

void	SinterStore (IntegerSink sink, string destination, params string[] keys)

void	SisMember (IntegerSink sink, string key, string member)

void	Smembers (ArraySink sink, string key)

void	Smove (IntegerSink sink, string source, string destination, string member)

void	Spop (BulkStringSink sink, string key)

void	Spop (BulkStringSink sink, string key, int count)

void	SrandMember (BulkStringSink sink, string key)

void	SrandMember (BulkStringSink sink, string key, int count)

void	Srem (IntegerSink sink, string key, params string[] members)

void	Sscan (ArraySink sink, string key, ulong cursor, ScanOptions options)

void	Sunion (ArraySink sink, params string[] keys)

void	SunionStore (IntegerSink sink, string destination, params string[] keys)

void	BzpopMax (ArraySink sink, int timeout, params string[] keys)

void	BzpopMin (ArraySink sink, int timeout, params string[] keys)

void	Zadd (IntegerSink sink, string key, ZaddOptions options, params ZaddScoreMemberPair[] pairs)

void	ZaddWithIncr (BulkStringSink sink, string key, ZaddOptions options, ZaddScoreMemberPair pair)

void	Zcard (IntegerSink sink, string key)

void	Zcount (IntegerSink sink, string key, string min, string max)

void	ZincrBy (BulkStringSink sink, string key, double increment, string member)

void	ZinterStore (IntegerSink sink, string destination, ZstoreOptions options, params string[] keys)

void	ZlexCount (IntegerSink sink, string key, string min, string max)

void	ZpopMax (ArraySink sink, string key, int count=1)

void	ZpopMin (ArraySink sink, string key, int count=1)

void	Zrange (ArraySink sink, string key, int start, int stop, bool withScores=false)

void	ZrangeByLex (ArraySink sink, string key, string min, string max, Limit limit=null)

void	ZrangeByScore (ArraySink sink, string key, string min, string max, ZrangeByScoreOptions options)

void	Zrank (ArraySink sink, string key, string member)

void	Zrem (IntegerSink sink, string key, params string[] members)

void	ZremRangeByLex (IntegerSink sink, string key, string min, string max)

void	ZremRangeByRank (IntegerSink sink, string key, int start, int stop)

void	ZremRangeByScore (IntegerSink sink, string key, string min, string max)

void	ZrevRange (ArraySink sink, string key, int start, int stop, bool withScores)

void	ZrevRangeByLex (ArraySink sink, string key, string min, string max, Limit limit=null)

void	ZrevRangeByScore (ArraySink sink, string key, string min, string max, ZrangeByScoreOptions options)

void	ZrevRank (ArraySink sink, string key, string member)

void	Zscan (ArraySink sink, string key, ulong cursor, ScanOptions options)

void	Zscore (BulkStringSink sink, string key, string member)

void	ZunionStore (IntegerSink sink, string destination, ZstoreOptions options, params string[] keys)

void	Xack (IntegerSink sink, string key, string group, params string[] ids)

void	Xadd (BulkStringSink sink, string key, string id, params FieldValuePair[] pairs)

void	Xclaim (ArraySink sink, string key, string group, string consumer, int minIdleTime, XclaimOptions options, params string[] ids)

void	Xdel (IntegerSink sink, string key, params string[] ids)

void	XgroupCreate (SimpleStringSink sink, string key, string groupname, XgroupCreateOptions options)

void	XgroupSetid (SimpleStringSink sink, string key, string groupname, string id=null)

void	XgroupDestroy (IntegerSink sink, string key, string groupname)

void	XgroupDelConsumer (IntegerSink sink, string key, string groupname, string consumername)

void	XgroupHelp (ArraySink sink)

void	XinfoConsumers (ArraySink sink, string key, string groupname)

void	XinfoGroups (ArraySink sink, string key)

void	XinfoStream (ArraySink sink, string key)

void	XinfoHelp (ArraySink sink)

void	Xlen (IntegerSink sink, string key)

void	Xpending (ArraySink sink, string key, string group, XpendingOptions options=null)

void	Xrange (ArraySink sink, string key, string start, string end, int count)

void	Xrange (ArraySink sink, string key, string start, string end)

void	Xread (ArraySink sink, XReadOptions options, params XReadKeyIdPair[] pairs)

void	XreadGroup (ArraySink sink, string group, string consumer, XReadGroupOptions options, params XReadKeyIdPair[] pairs)

void	XrevRange (ArraySink sink, string key, string start, string end, int count)

void	XrevRange (ArraySink sink, string key, string start, string end)

void	Xtrim (IntegerSink sink, string key, int count, bool approximateCount=false)

void	Append (IntegerSink sink, string key, string value)

void	BitCount (IntegerSink sink, string key, int start, int end)

void	BitCount (IntegerSink sink, string key)

void	BitField (ArraySink sink, string key, params BitfieldSubcommand[] subcommands)

void	BitOp (IntegerSink sink, BitwiseOperation operation, string destkey, params string[] keys)

void	BitPos (IntegerSink sink, string key, int bit, int start, int end=-1)

void	BitPos (IntegerSink sink, string key, int bit)

void	Decr (IntegerSink sink, string key)

void	DecrBy (IntegerSink sink, string key, long decrement)

void	Get (BulkStringSink sink, string key)

void	GetBit (IntegerSink sink, string key, int offset)

void	GetRange (BulkStringSink sink, string key, int start, int end)

void	GetSet (BulkStringSink sink, string key, string value)

void	Incr (IntegerSink sink, string key)

void	IncrBy (IntegerSink sink, string key, long increment)

void	IncrByFloat (BulkStringSink sink, string key, string increment)

void	Mget (ArraySink sink, params string[] keys)

void	Mset (SimpleStringSink sink, params KeyValuePair[] pairs)

void	MsetNx (IntegerSink sink, params KeyValuePair[] pairs)

void	PsetEx (SimpleStringSink sink, string key, long milliseconds, string value)

void	Set (SimpleStringSink sink, string key, string value, SetOptions options)

void	Set (SimpleStringSink sink, string key, string value)

void	SetBit (IntegerSink sink, string key, int offset, string value)

void	SetEx (SimpleStringSink sink, string key, long seconds, string value)

void	SetNx (IntegerSink sink, string key, string value)

void	SetRange (IntegerSink sink, string key, int offset, string value)

void	StrLen (IntegerSink sink, string key)

void	Discard (SimpleStringSink sink)

void	Exec (ArraySink sink)

void	Multi (SimpleStringSink sink)

void	Unwatch (SimpleStringSink sink)

void	Watch (SimpleStringSink sink, params string[] keys)

Public Member Functions inherited from RedisClientBase
delegate void	ConnectionCallback (RedisClientBase client, string error)

delegate void	ConnectedEventHandler (RedisClientBase client)

delegate void	DisconnectedEventHandler (RedisClientBase client)

	RedisClientBase (string hostname, int port)

void	Connect (ConnectionCallback connectCallback=null)

void	Disconnect (ConnectionCallback disconnectCallback=null)

bool	Connected ()

Static Public Member Functions
static string	QuoteWrap (string s)

Protected Member Functions
override void	OnConnect (IAsyncResult connectResult)

Protected Member Functions inherited from RedisClientBase
virtual void	OnDisconnect (IAsyncResult disconnectResult)

Additional Inherited Members
Protected Attributes inherited from RedisClientBase
string	hostname

int	port

Socket	socket

Events inherited from RedisClientBase
ConnectedEventHandler	connected

DisconnectedEventHandler	disconnected

Detailed Description

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.

Constructor & Destructor Documentation

CommandClient	(	string	hostname,
		int	port,
		int	recvBufferLen,
		int	sendBufferLen
	)

inline

CommandClient constructor.

Parameters

hostname	The hostname or IP to connect to.
port	The port to connect to. Redis servers listen on 6379 by default.
recvBufferLen	CommandClient allocates a receive buffer internally; this parameter allows users to tailor the buffer size to fit their needs.
sendBufferLen	CommandClient allocates a send buffer internally; this parameter allows users to tailor the buffer size to fit their needs.

Member Function Documentation

void Append	(	IntegerSink	sink,
		string	key,
		string	value
	)

inline

Implements the APPEND command. If key already exists and is a string, this command appends the value at the end of the string. If key does not exist it is created and set as an empty string, so APPEND will be similar to SET in this special case.

Parameters

sink	The user-provided callback object.
key	The key to which 'value' is appended.
value	The value appended to the string at 'key'

void Auth	(	SimpleStringSink	sink,
		string	password
	)

inline

Implements the AUTH command.

Parameters

sink	The user-provided callback object.
password	Authorization password.

void Bgrewriteaof ( SimpleStringSink sink )

inline

Implements the BGREWRITEAOF command.

Parameters

sink	The user-provided callback object.

void Bgsave ( SimpleStringSink sink )

inline

Implements the BGSAVE command.

Parameters

sink	The user-provided callback object.

void BitCount	(	IntegerSink	sink,
		string	key,
		int	start,
		int	end
	)

inline

Implements the BITCOUNT command. Count the number of set bits (population counting) in a string.

Parameters

sink	The user-provided callback object.
key	Key name identifying the string whose bits are counted.
start	Starting byte index.
end	Ending byte index.

void BitCount	(	IntegerSink	sink,
		string	key
	)

inline

Implements the BITCOUNT command. Count the number of set bits (population counting) in a string.

Parameters

sink	The user-provided callback object.
key	Key name of the string whose bits are counted.

void BitField	(	ArraySink	sink,
		string	key,
		params BitfieldSubcommand[]	subcommands
	)

inline

Implements the BITFIELD command. The command treats a Redis string as a array of bits, and is capable of addressing specific integer fields of varying bit widths and arbitrary non (necessary) aligned offset.

Parameters

sink	The user-provided callback object.
key	Key name of the bitfield that is operated upon.
subcommands	One or more operations to perform on the bitfield.

void BitOp	(	IntegerSink	sink,
		BitwiseOperation	operation,
		string	destkey,
		params string[]	keys
	)

inline

Implements the BITOP command. Perform a bitwise operation between multiple keys (containing string values) and store the result in the destination key.

Parameters

sink	The user-provided callback object.
operation	The operation (AND/OR/XOR/NOT) to perform on the key(s)
destkey	Key name where the result is stored.
keys	The input key(s).

void BitPos	(	IntegerSink	sink,
		string	key,
		int	bit,
		int	start,
		int	end = `-1`
	)

inline

Implements the BITPOS command.

Parameters

sink	The user-provided callback object.
key	The name of the key that is scanned.
bit	Specifies the bit value to look for.
start	The byte offset to start scanning from.
end	The byte offset (inclusive) where scanning stops.

void BitPos	(	IntegerSink	sink,
		string	key,
		int	bit
	)

inline

Implements the BITPOS command.

Parameters

sink	The user-provided callback object.
key	The name of the key that is scanned.
bit	Specifies the bit value to look for.

void Blpop	(	ArraySink	sink,
		int	timeout,
		params string[]	keys
	)

inline

Implements the BLPOP command.

Parameters

sink	The user-provided callback object.
timeout	Specifies the maximum amount of time to block, in seconds. A value of 0 causes the operation to block indefinitely.
keys	Key name of one or more lists to pop from.

void Brpop	(	ArraySink	sink,
		int	timeout,
		params string[]	keys
	)

inline

Implements the BRPOP command.

Parameters

sink	The user-provided callback object.
timeout	Specifies the maximum amount of time to block, in seconds. A value of 0 causes the operation to block indefinitely.
keys	Key name of one or more lists to pop from.

void BrpopLpush	(	BulkStringSink	sink,
		string	source,
		string	destination,
		int	timeout
	)

inline

Implements the BRPOPLPUSH command.

Parameters

sink	The user-provided callback object.
source	Key name of the list from which an element is popped.
destination	Key name of the list to which an element is pushed.
timeout	Specifies the maximum amount of time to block, in seconds. A value of 0 causes the operation to block indefinitely.

void BzpopMax	(	ArraySink	sink,
		int	timeout,
		params string[]	keys
	)

inline

Implements the BZPOPMAX command.

Parameters

sink	The user-provided callback object.
timeout	Specifies the maximum amount of time to block, in seconds. A value of 0 causes the operation to block indefinitely.
keys	Key name(s) of the sorted sets from which the highest scored member is returned.

void BzpopMin	(	ArraySink	sink,
		int	timeout,
		params string[]	keys
	)

inline

Implements the BZPOPMIN command.

Parameters

sink	The user-provided callback object.
timeout	Specifies the maximum amount of time to block, in seconds. A value of 0 causes the operation to block indefinitely.
keys	Key name(s) of the sorted sets from which the lowest scored member is returned.

void ClientGetname ( BulkStringSink sink )

inline

Implements the CLIENT GETNAME command.

Parameters

sink	The user-provided callback object.

void ClientId ( IntegerSink sink )

inline

Implements the CLIENT ID command. Even Redis authors don't seem to know what RESP type is returned here. From Redis example:

redis> CLIENT ID ERR Unknown or disabled command 'CLIENT' redis>

It looks like a RESP Integer might be what we need based on the output of "CLIENT LIST".

Parameters

sink	The user-provided callback object.

void ClientKill	(	SimpleStringSink	sink,
		string	ip,
		int	port
	)

inline

Implements the CLIENT KILL command.

Only supported by Redis 2.8.11 and earlier.

Parameters

sink	The user-provided callback object.
ip	The IP address of the client whose connection is closed.
port	The port bound to the client connection that is closed.

void ClientKill	(	IntegerSink	sink,
		params ClientKillFilter[]	filters
	)

inline

Implements the CLIENT KILL command. [ID client-id] [TYPE normal|master|slave|pubsub] [ADDR ip:port] [SKIPME yes/no]

Parameters

sink	The user-provided callback object.
filters	The filter(s) used to select clients to disconnect.

void ClientList ( BulkStringSink sink )

inline

Implements the CLIENT LIST command.

Parameters

sink	The user-provided callback object.

void ClientList	(	BulkStringSink	sink,
		ClientListClassType	type
	)

inline

Implements the CLIENT LIST command.

Parameters

sink	The user-provided callback object.
type	A filter specifying the type of clients to list.

void ClientPause	(	SimpleStringSink	sink,
		int	timeout
	)

inline

Implements the CLIENT PAUSE command.

Parameters

sink	The user-provided callback object.
timeout	The amount of time to suspend client connections, in milliseconds.

void ClientSetName	(	SimpleStringSink	sink,
		string	name
	)

inline

Implements the CLIENT SETNAME command.

Parameters

sink	The user-provided callback object.
name	The name to assigns to the current connection.

void ClientUnblock	(	IntegerSink	sink,
		long	clientId,
		ClientUnblockOption	option
	)

inline

Implements the CLIENT UNBLOCK command.

Parameters

sink	The user-provided callback object.
clientId	The ID of the client to unblock.
option	Option specifying how the client is unblocked (i.e. via timeout or error).

void ClientUnblock	(	IntegerSink	sink,
		long	clientId
	)

inline

Implements the CLIENT UNBLOCK command.

Parameters

sink	The user-provided callback object.
clientId	The ID of the client to unblock.

void Command ( ArraySink sink )

inline

Implements the COMMAND command. Note: Array reply is nested.

Parameters

sink	The user-provided callback object.

void CommandCount ( IntegerSink sink )

inline

Implements the COMMAND COUNT command.

Parameters

sink	The user-provided callback object.

void CommandGetkeys	(	ArraySink	sink,
		params string[]	args
	)

inline

Implements the COMMAND GETKEYS command.

Parameters

sink	The user-provided callback object.
args	Components of a Redis command (a command and its arguments) used to determine key positions for the given command.

void CommandInfo	(	ArraySink	sink,
		params string[]	commandNames
	)

inline

Implements the COMMAND INFO command.

Parameters

sink	The user-provided callback object.
commandNames	The list of command names whose info is returned.

void ConfigGet	(	ArraySink	sink,
		string	parameter
	)

inline

Implements the CONFIG GET command.

Parameters

sink	The user-provided callback object.
parameter	A pattern matching desired config parameters.

void ConfigResetStat ( SimpleStringSink sink )

inline

Implements the CONFIG RESETSTAT command.

Parameters

sink	The user-provided callback object.

void ConfigRewrite ( SimpleStringSink sink )

inline

Implements the CONFIG REWRITE command.

Parameters

sink	The user-provided callback object.

void ConfigSet	(	SimpleStringSink	sink,
		string	parameter,
		string	value
	)

inline

Implements the CONFIG SET command.

Parameters

sink	The user-provided callback object.
parameter	The config parameter to set.
value	The new value of the config parameter.

void DbSize ( IntegerSink sink )

inline

Implements the DBSIZE command.

Parameters

sink	The user-provided callback object.

void Decr	(	IntegerSink	sink,
		string	key
	)

inline

Implements the DECR command.

Parameters

sink	The user-provided callback object.
key	The name of the key that is decremented.

void DecrBy	(	IntegerSink	sink,
		string	key,
		long	decrement
	)

inline

Implements the DECRBY command.

Parameters

sink	The user-provided callback object.
key	The name of the key that is decremented.
decrement	The amount to decrement.

void Del	(	IntegerSink	sink,
		params string[]	keys
	)

inline

Implements the DEL command.

Parameters

sink	The user-provided callback object.
keys	The key(s) to remove.

void Discard ( SimpleStringSink sink )

inline

Implements the DISCARD command.

Parameters

sink	The user-provided callback object.

void Dump	(	BulkStringSink	sink,
		string	key
	)

inline

Implements the DUMP command.

Parameters

sink	The user-provided callback object.
key	Key name of the value to serialized.

void Echo	(	BulkStringSink	sink,
		string	message
	)

inline

Implements the ECHO command.

Parameters

sink	The user-provided callback object.
message	The message to return.

void Eval	(	ArraySink	sink,
		string	script,
		string[]	keys,
		params string[]	argv
	)

inline

Implements the EVAL command.

Parameters

sink	The user-provided callback object.
script	The script that is evaluated. This script string is automatically wrapped in quotes as it is likely to contain spaces.
keys	Key names passed as arguments to the script.
argv	Additional non-key arguments passed to the script.

void EvalSha	(	ArraySink	sink,
		string	sha1,
		string[]	keys,
		params string[]	argv
	)

inline

Implements the EVALSHA command.

Parameters

sink	The user-provided callback object.
sha1	The SHA1 digest of a script that has been cached via ScriptLoad().
keys	Key names passed as arguments to the script.
argv	Additional non-key arguments passed to the script.

void Exec ( ArraySink sink )

inline

Implements the EXEC command.

Parameters

sink	The user-provided callback object.

void Exists	(	IntegerSink	sink,
		params string[]	keys
	)

inline

Implements the EXISTS command.

Parameters

sink	The user-provided callback object.
keys	Key name(s) to check.

void Expire	(	IntegerSink	sink,
		string	key,
		int	seconds
	)

inline

Implements the EXPIRE command.

Parameters

sink	The user-provided callback object.
key	Key name to expire.
seconds	Timeout value, in seconds.

void ExpireAt	(	IntegerSink	sink,
		string	key,
		int	timestamp
	)

inline

Implements the EXPIREAT command.

Parameters

sink	The user-provided callback object.
key	Key name to expire.
timestamp	An absolute timeout value, given as a Unix timestamp, in seconds.

void FlushAll	(	SimpleStringSink	sink,
		bool	async
	)

inline

Implements the FLUSHALL command.

Parameters

sink	The user-provided callback object.
async	Flag indicating if the operation should be performed in the background without blocking the server.

void FlushDb	(	SimpleStringSink	sink,
		bool	async
	)

inline

Implements the FLUSHDB command.

Parameters

sink	The user-provided callback object.
async	Flag indicating if the operation should be performed in the background without blocking the server.

void GeoAdd	(	IntegerSink	sink,
		string	key,
		params GeoCoord[]	geoCoords
	)

inline

Implements the GEOADD command.

Parameters

sink	The user-provided callback object.
key	Key name of the set where the given geospatial items are stored.
geoCoords	The geospatial items to add.

void GeoAdd	(	IntegerSink	sink,
		string	key,
		string	longitude,
		string	latitude,
		string	member
	)

inline

Implements the GEOADD command.

Parameters

sink	The user-provided callback object.
key	Key name of the set where the given geospatial item is stored.
longitude	Longitude of the geospatial item to add.
latitude	Latitude of the geospatial item to add.
member	Member of the geospatial item to add.

void GeoDist	(	BulkStringSink	sink,
		string	key,
		string	member1,
		string	member2,
		GeoUnit	unit
	)

inline

Implements the GEODIST command.

Parameters

sink	The user-provided callback object.
key	Key name of the set containing member1 and member2.
member1	The first geospatial item to compare.
member2	The second geospatial item to compare.
unit	Specifies the unit of distance between member1 and member2.

void GeoDist	(	BulkStringSink	sink,
		string	key,
		string	member1,
		string	member2
	)

inline

Implements the GEODIST command.

Parameters

sink	The user-provided callback object.
key	Key name of the set containing member1 and member2.
member1	The first geospatial item to compare.
member2	The second geospatial item to compare.

void GeoHash	(	ArraySink	sink,
		string	key,
		params string[]	members
	)

inline

Implements the GEOHASH command.

Parameters

sink	The user-provided callback object.
key	Key name of the set containing the given members.
members	The geospatial items whose hashes are returned.

void GeoPos	(	ArraySink	sink,
		string	key,
		params string[]	members
	)

inline

Implements the GEOPOS command.

Parameters

sink	The user-provided callback object.
key	Key name of the set containing the given members.
members	The geospatial items whose positions are returned.

void GeoRadius	(	ArraySink	sink,
		string	key,
		string	longitude,
		string	latitude,
		string	radius,
		GeoUnit	unit,
		GeoFlags	flags,
		GeoRadiusOptions	options = `null`
	)

inline

Implements the GEORADIUS command.

This version of GeoRadius() supports the WITH* flags (WITHCOORD, WITHDIST, WITHHASH). Note: using any WITH* flag(s) will cause the return value to be a nested RESP Array; the given ArraySink must be implemented to handle it accordingly.

Parameters

sink	The user-provided callback object.
key	Key name of the set from which the items are returned.
longitude	Longitude of the center location.
latitude	Latitude of the center location.
radius	Radius from the center location.
unit	Specifies the unit of distance for radius.
flags	A combination of WITHCOORD, WITHDIST, and WITHHASH flags, ORed together.
options	Optional parameters for specifying the number of elements to return, and the sort order.

void GeoRadius	(	IntegerSink	sink,
		string	key,
		string	longitude,
		string	latitude,
		string	radius,
		GeoUnit	unit,
		string	storeKey,
		string	storeDistKey,
		GeoRadiusOptions	options = `null`
	)

inline

Implements the GEORADIUS command.

This version of GeoRadius() supports the STORE* options (STORE, STOREDIST). Note: nothing prevents the simultaneous use of STORE and STOREDIST, but only one of them will have an affect in this case (STOREDIST overrides STORE). This is an artifact of how the command is implemented on the server.

Parameters

sink	The user-provided callback object.
key	Key name of the set from which the items are returned.
longitude	Longitude of the center location.
latitude	Latitude of the center location.
radius	Radius from the center location.
unit	Specifies the unit of distance for radius.
storeKey	Key name of the Sorted Set where the results of the STORE operation will be saved. The STORE option will be omitted if this is null.
storeDistKey	Key name of the Sorted Set where the results of the STOREDIST operation will be saved. The STOREDIST option will be omitted if this is null.
options	Optional parameters for specifying the number of elements to return, and the sort order.

void GeoRadiusByMember	(	ArraySink	sink,
		string	key,
		string	member,
		string	radius,
		GeoUnit	unit,
		GeoFlags	flags,
		GeoRadiusOptions	options = `null`
	)

inline

Implements the GEORADIUSBYMEMBER command.

This version of GeoRadiusByMember() supports the WITH* flags (WITHCOORD, WITHDIST, WITHHASH). Note: using any WITH* flag(s) will cause the return value to be a nested RESP Array; the given ArraySink must be implemented to handle it accordingly.

Parameters

sink	The user-provided callback object.
key	Key name of the set from which the items are returned.
member	The member whose location is used as the center for the query.
radius	Radius from the center location.
unit	Specifies the unit of distance for radius.
flags	A combination of WITHCOORD, WITHDIST, and WITHHASH flags, ORed together.
options	Optional parameters for specifying the number of elements to return, and the sort order.

void GeoRadiusByMember	(	IntegerSink	sink,
		string	key,
		string	member,
		string	radius,
		GeoUnit	unit,
		string	storeKey,
		string	storeDistKey,
		GeoRadiusOptions	options = `null`
	)

inline

Implements the GEORADIUSBYMEMBER command.

This version of GeoRadiusByMember() supports the STORE* options (STORE, STOREDIST). Note: nothing prevents the simultaneous use of STORE and STOREDIST, but only one of them will have an affect in this case (STOREDIST overrides STORE). This is an artifact of how the command is implemented on the server.

Parameters

sink	The user-provided callback object.
key	Key name of the set from which the items are returned.
member	The member whose location is used as the center for the query.
radius	Radius from the center location.
unit	Specifies the unit of distance for radius.
storeKey	Key name of the Sorted Set where the results of the STORE operation will be saved. The STORE option will be omitted if this is null.
storeDistKey	Key name of the Sorted Set where the results of the STOREDIST operation will be saved. The STOREDIST option will be omitted if this is null.
options	Optional parameters for specifying the number of elements to return, and the sort order.

void Get	(	BulkStringSink	sink,
		string	key
	)

inline

Implements the GET command.

Parameters

sink	The user-provided callback object.
key	The name of the key that is retrieved.

void GetBit	(	IntegerSink	sink,
		string	key,
		int	offset
	)

inline

Implements the GETBIT command.

Parameters

sink	The user-provided callback object.
key	The name of the key from which the bit is retrieved.
offset	The bit offset to retrieve.

void GetRange	(	BulkStringSink	sink,
		string	key,
		int	start,
		int	end
	)

inline

Implements the GETRANGE command.

Parameters

sink	The user-provided callback object.
key	The name of the key from which the byte range is read.
start	The start offset.
end	The end offset.

void GetSet	(	BulkStringSink	sink,
		string	key,
		string	value
	)

inline

Implements the GETSET command.

Parameters

sink	The user-provided callback object.
key	The name of the key whose value is retrieved and set.
value	The new value that key will be set to.

void Hdel	(	IntegerSink	sink,
		string	key,
		params string[]	fields
	)

inline

Implements the HDEL command.

Parameters

sink	The user-provided callback object.
key	Key name of the hash.
fields	Fields to delete.

void Hexists	(	IntegerSink	sink,
		string	key,
		string	field
	)

inline

Implements the HEXISTS command.

Parameters

sink	The user-provided callback object.
key	Key name of the hash.
field	Field name to check.

void Hget	(	BulkStringSink	sink,
		string	key,
		string	field
	)

inline

Implements the HGET command.

Parameters

sink	The user-provided callback object.
key	Key name of the hash.
field	Name of the field to return.

void HgetAll	(	ArraySink	sink,
		string	key
	)

inline

Implements the HGETALL command.

Parameters

sink	The user-provided callback object.
key	Key name of the hash.

void HincrBy	(	IntegerSink	sink,
		string	key,
		string	field,
		long	increment
	)

inline

Implements the HINCRBY command.

Parameters

sink	The user-provided callback object.
key	Key name of the hash.
field	Name of the field to increment.
increment	The integer value added to field.

void HincrByFloat	(	BulkStringSink	sink,
		string	key,
		string	field,
		float	increment
	)

inline

Implements the HINCRBYFLOAT command.

Parameters

sink	The user-provided callback object.
key	Key name of the hash.
field	Name of the field to increment.
increment	The float value added to field.

void Hkeys	(	ArraySink	sink,
		string	key
	)

inline

Implements the HKEYS command.

Parameters

sink	The user-provided callback object.
key	Key name of the hash.

void Hlen	(	IntegerSink	sink,
		string	key
	)

inline

HLEN key.

<summary Implements the HLEN command.

Parameters

sink	The user-provided callback object.
key	Key name of the hash.

void HmGet	(	ArraySink	sink,
		string	key,
		params string[]	fields
	)

inline

Implements the HMGET command.

Parameters

sink	The user-provided callback object.
key	Key name of the hash.
fields	The fields to return.

void HmSet	(	SimpleStringSink	sink,
		string	key,
		params FieldValuePair[]	pairs
	)

inline

Implements the HMSET command.

Parameters

sink	The user-provided callback object.
key	Key name of the hash.
pairs	The field/value pairs to set.

void Hscan	(	ArraySink	sink,
		string	key,
		ulong	cursor,
		ScanOptions	options
	)

inline

Implements the HSCAN command.

Parameters

sink	The user-provided callback object.
key	Key name of the hash.
cursor	The cursor returned by the previous call to Hscan() (or 0 to start a new iteration).
options	Additional options for the HSCAN command (e.g. MATCH, COUNT).

void Hscan	(	ArraySink	sink,
		string	key,
		ulong	cursor
	)

inline

Implements the HSCAN command.

Parameters

sink	The user-provided callback object.
key	Key name of the hash.
cursor	The cursor returned by the previous call to Hscan() (or 0 to start a new iteration).

void Hset	(	IntegerSink	sink,
		string	key,
		string	field,
		string	value
	)

inline

Implements the HSET command.

Parameters

sink	The user-provided callback object.
key	Key name of the hash.
field	The field name to set.
value	The value to set for field.

void HsetNx	(	IntegerSink	sink,
		string	key,
		string	field,
		string	value
	)

inline

Implements the HSETNX command.

Parameters

sink	The user-provided callback object.
key	Key name of the hash.
field	The field name to set.
value	The value to set if field does not already exist.

void HstrLen	(	IntegerSink	sink,
		string	key,
		string	field
	)

inline

Implements the HSTRLEN command.

Parameters

sink	The user-provided callback object.
key	Key name of the hash.
field	Name of the field whose length is returned.

void Hvals	(	ArraySink	sink,
		string	key
	)

inline

Implements the HVALS command.

Parameters

sink	The user-provided callback object.
key	Key name of the hash.

void Incr	(	IntegerSink	sink,
		string	key
	)

inline

Implements the INCR command.

Parameters

sink	The user-provided callback object.
key	The name of the key that is incremented.

void IncrBy	(	IntegerSink	sink,
		string	key,
		long	increment
	)

inline

Implements the INCRBY command.

Parameters

sink	The user-provided callback object.
key	The name of the key that is incremented.
increment	The amount to increment.

void IncrByFloat	(	BulkStringSink	sink,
		string	key,
		string	increment
	)

inline

Implements the INCRBYFLOAT command.

Parameters

sink	The user-provided callback object.
key	The name of the key that is incremented.
increment	The amount to increment. This is a string because Redis supports alternative ways to specify the float value (e.g. "2.0e2")

void Info	(	BulkStringSink	sink,
		string	section = `null`
	)

inline

Implements the INFO command.

Parameters

sink	The user-provided callback object.
section	Specifies the section about which information is returned.

void Keys	(	ArraySink	sink,
		string	pattern
	)

inline

Implements the KEYS command.

Parameters

sink	The user-provided callback object.
pattern	The pattern used to match key names.

void LastSave ( IntegerSink sink )

inline

Implements the LASTSAVE command.

Parameters

sink	The user-provided callback object.

void Lindex	(	BulkStringSink	sink,
		string	key,
		int	index
	)

inline

Implements the LINDEX command.

Parameters

sink	The user-provided callback object.
key	Key name of the list from which a value is returned.
index	Zero-based index of the item to return.

void Linsert	(	IntegerSink	sink,
		string	key,
		PivotType	pivotType,
		string	pivot,
		string	value
	)

inline

Implements the LINSERT command.

Parameters

sink	The user-provided callback object.
key	Key name of the list into which value is inserted.
pivotType	Indicates whether to insert value BEFORE, or AFTER pivot.
pivot	The reference value used to figure out the insertion position.
value	The value to insert.

void Llen	(	IntegerSink	sink,
		string	key
	)

inline

Implements the LLEN command.

Parameters

sink	The user-provided callback object.
key	Key name of the list whose length is returned.

void Lpop	(	BulkStringSink	sink,
		string	key
	)

inline

Implements the LPOP command.

Parameters

sink	The user-provided callback object.
key	Key name of the list from which a value is popped.

void Lpush	(	IntegerSink	sink,
		string	key,
		params string[]	values
	)

inline

Implements the LPUSH command.

Parameters

sink	The user-provided callback object.
key	Key name of the list to which values are pushed.
values	The value(s) to push.

void Lpushx	(	IntegerSink	sink,
		string	key,
		string	value
	)

inline

Implements the LPUSHX command.

Parameters

sink	The user-provided callback object.
key	Key name of the list to which value is pushed if it does not already exist.
value	The value to push.

void Lrange	(	ArraySink	sink,
		string	key,
		int	start,
		int	stop
	)

inline

Implements the LRANGE command.

Parameters

sink	The user-provided callback object.
key	Key name of the list from which values are returned.
start	Zero-based index of the first element in the range to return.
stop	Zero-based index of the last element in the range to return.

void Lrem	(	IntegerSink	sink,
		string	key,
		int	count,
		string	value
	)

inline

Implements the LREM command.

Parameters

sink	The user-provided callback object.
key	Key name of the list from which elements are removed.
count	Indicates not only the number of elements to remove, but where to remove them from (e.g. the head of the list, or the tail). When count is 0, all elements matching value are removed, irrespective of their position.
value	The value to remove.

void Lset	(	SimpleStringSink	sink,
		string	key,
		int	index,
		string	value
	)

inline

Implements the LSET command.

Parameters

sink	The user-provided callback object.
key	Key name of the list in which value is set.
index	Zero-based index of the item to set.
value	The value to set.

void Ltrim	(	SimpleStringSink	sink,
		string	key,
		int	start,
		int	stop
	)

inline

Implements the LTRIM command.

Parameters

sink	The user-provided callback object.
key	Key name of the list that is trimmed.
start	Zero-based index of the first element in the range to preserve.
stop	Zero-based index of the last element in the range to preserve.

void MemoryDoctor ( BulkStringSink sink )

inline

Implements the MEMORY DOCTOR command.

Parameters

sink	The user-provided callback object.

void MemoryHelp ( ArraySink sink )

inline

Implements the MEMORY HELP command.

Parameters

sink	The user-provided callback object.

void MemoryMallocStats ( BulkStringSink sink )

inline

Implements the MEMORY MALLOC-STATS command.

Parameters

sink	The user-provided callback object.

void MemoryPurge ( SimpleStringSink sink )

inline

Implements the MEMORY PURGE command.

Parameters

sink	The user-provided callback object.

void MemoryStats ( ArraySink sink )

inline

Implements the MEMORY STATS command.

Parameters

sink	The user-provided callback object.

void MemoryUsage	(	IntegerSink	sink,
		string	key,
		int	count
	)

inline

Implements the MEMORY USAGE command.

Parameters

sink	The user-provided callback object.
key	Key name whose memory usage is reported.
count	The number of nested values to sample. A value of 0 results in all nested values being sampled.

void MemoryUsage	(	IntegerSink	sink,
		string	key
	)

inline

Implements the MEMORY USAGE command.

Parameters

sink	The user-provided callback object.
key	Key name whose memory usage is reported.

void Mget	(	ArraySink	sink,
		params string[]	keys
	)

inline

Implements the MGET command.

Parameters

sink	The user-provided callback object.
keys	The list of key names whose values are returned.

void Migrate	(	SimpleStringSink	sink,
		string	host,
		int	port,
		string	key,
		int	destDb,
		int	timeout
	)

inline

Implements the MIGRATE command.

Parameters

sink	The user-provided callback object.
host	Hostname of the destination Redis server.
port	Port number of the destination Redis server.
key	The key to migrate.
destDb	Index of the logical database on the destination server.
timeout	Maximum idle time for the communication, in milliseconds.

void Migrate	(	SimpleStringSink	sink,
		string	host,
		int	port,
		int	destDb,
		int	timeout,
		bool	copy,
		bool	replace,
		params string[]	keys
	)

inline

Implements the MIGRATE command.

Parameters

sink	The user-provided callback object.
host	Hostname of the destination Redis server.
port	Port number of the destination Redis server.
destDb	Index of the logical database on the destination server.
timeout	Maximum idle time for the communication, in milliseconds.
copy	Flag indicating whether or not to remove the key from the local instance.
replace	Flag indicating whether or not to replace the key on the remote instance.
keys	The key(s) to migrate.

void Move	(	IntegerSink	sink,
		string	key,
		int	db
	)

inline

Implements the MOVE command.

Parameters

sink	The user-provided callback object.
key	The key to move.
db	Index of the destination database.

void Mset	(	SimpleStringSink	sink,
		params KeyValuePair[]	pairs
	)

inline

Implements the MSET command.

Parameters

sink	The user-provided callback object.
pairs	The list of key/value pairs to set.

void MsetNx	(	IntegerSink	sink,
		params KeyValuePair[]	pairs
	)

inline

Implements the MSETNX command.

Parameters

sink	The user-provided callback object.
pairs	The list of key/value pairs to set.

void Multi ( SimpleStringSink sink )

inline

Implements the MULTI command.

Parameters

sink	The user-provided callback object.

override void OnConnect ( IAsyncResult connectResult )

inlineprotectedvirtual

Callback used in calls to Socket.BeginConnect().

Reimplemented from RedisClientBase.

void Persist	(	IntegerSink	sink,
		string	key
	)

inline

Implements the PERSIST command.

Parameters

sink	The user-provided callback object.
key	Key name to persist.

void Pexpire	(	IntegerSink	sink,
		string	key,
		int	milliseconds
	)

inline

Implements the PEXPIRE command.

Parameters

sink	The user-provided callback object.
key	Key name to expire.
milliseconds	Timeout value, in milliseconds.

void PexpireAt	(	IntegerSink	sink,
		string	key,
		int	timestamp
	)

inline

Implements the PEXPIREAT command.

Parameters

sink	The user-provided callback object.
key	Key name to expire.
timestamp	An absolute timeout value, given as a Unix timestamp, in milliseconds.

void Pfadd	(	IntegerSink	sink,
		string	key,
		params string[]	elements
	)

inline

Implements the PFADD command.

Parameters

sink	The user-provided callback object.
key	Key name of the affected HyperLogLog data structure.
elements	The element(s) to add.

void Pfcount	(	IntegerSink	sink,
		params string[]	keys
	)

inline

Implements the PFCOUNT command.

Parameters

sink	The user-provided callback object.
keys	Key names to use in cardinality calculation.

void Pfmerge	(	SimpleStringSink	sink,
		string	destkey,
		params string[]	sourcekey
	)

inline

Implements the PFMERGE command.

Parameters

sink	The user-provided callback object.
destkey	Key name of the destination HyperLogLog data structure.
sourcekey	Key name(s) of the sources that are merged into destkey.

void Ping	(	BulkStringSink	sink,
		string	message
	)

inline

Implements the PING command.

Parameters

sink	The user-provided callback object.
message	The message to return.

void Ping ( SimpleStringSink sink )

inline

Implements the PING command.

Parameters

sink	The user-provided callback object.

void PsetEx	(	SimpleStringSink	sink,
		string	key,
		long	milliseconds,
		string	value
	)

inline

Implements the PSETEX command.

Parameters

sink	The user-provided callback object.
key	The name of the key that is set.
milliseconds	The timeout value in milliseconds.
value	The value that key is set to.

void Pttl	(	IntegerSink	sink,
		string	key
	)

inline

Implements the PTTL command.

Parameters

sink	The user-provided callback object.
key	The key whose TTL (in milliseconds) is returned.

void Publish	(	IntegerSink	sink,
		string	channel,
		string	message
	)

inline

Implements the PUBLISH command.

Parameters

sink	The user-provided callback object.
channel	The name of the channel that message is published to.
message	The message to publish.

void PubsubChannels	(	ArraySink	sink,
		string	pattern
	)

inline

Implements the PUBSUB CHANNELS command.

Parameters

pattern The pattern used to match channel names.

void PubsubChannels ( ArraySink sink )

inline

Implements the PUBSUB CHANNELS command.

void PubsubNumPat ( IntegerSink sink )

inline

Implements the PUBSUB NUMPAT command.

void PubsubNumSub	(	ArraySink	sink,
		params string[]	channels
	)

inline

Implements the PUBSUB NUMSUB command.

Parameters

channels Specifies the channels to include in the count.

void Quit ( SimpleStringSink sink )

inline

Implements the QUIT command.

Parameters

sink	The user-provided callback object.

static string QuoteWrap ( string s )

inlinestatic

Utility method to wrap quotes around string values that contain spaces.

Parameters

s	The string value to wrap.

Returns: The given string wrapped in quotation marks.

void RandomKey ( BulkStringSink sink )

inline

Implements the RANDOMKEY command.

Parameters

sink	The user-provided callback object.

void Rename	(	SimpleStringSink	sink,
		string	key,
		string	newkey
	)

inline

Implements the RENAME command.

Parameters

sink	The user-provided callback object.
key	Old key name.
newkey	New key name.

void RenameNx	(	IntegerSink	sink,
		string	key,
		string	newkey
	)

inline

Implements the RENAMENX command.

Parameters

sink	The user-provided callback object.
key	Old key name.
newkey	New key name.

void ReplicaOf	(	SimpleStringSink	sink,
		string	host,
		string	port
	)

inline

Implements the REPLICAOF command.

A special value of "NO" for host, and "ONE" for port will turn off replication

Parameters

sink	The user-provided callback object.
host	The hostname of a Redis server to replicate.
port	The Redis port on host (specified as a string to accommodate the "REPLICAOF NO ONE" command format).

void Restore	(	SimpleStringSink	sink,
		string	key,
		int	ttl,
		string	serializedValue,
		RestoreOptions	options
	)

inline

Implements the RESTORE command.

Parameters

sink	The user-provided callback object.
key	Key name for the restored value.
ttl	TTL for the new key, in milliseconds. No expiration is set if this value is 0.
serializedValue	The serialized value, as produced by Dump().
options	Additional options for the RESTORE command (e.g. REPLACE, ABSTTL, IDLETIME, and FREQ).

void Role ( ArraySink sink )

inline

Implements the ROLE command.

Parameters

sink	The user-provided callback object.

void Rpop	(	BulkStringSink	sink,
		string	key
	)

inline

Implements the RPOP command.

Parameters

sink	The user-provided callback object.
key	Key name of the list from which a value is popped.

void RpopLpush	(	BulkStringSink	sink,
		string	source,
		string	destination
	)

inline

Implements the RPOPLPUSH command.

Parameters

sink	The user-provided callback object.
source	Key name of the list from which an element is popped.
destination	Key name of the list to which an element is pushed.

void Rpush	(	IntegerSink	sink,
		string	key,
		params string[]	values
	)

inline

Implements the RPUSH command.

Parameters

sink	The user-provided callback object.
key	Key name of the list to which values are pushed.
values	The value(s) to push.

void Rpushx	(	IntegerSink	sink,
		string	key,
		string	value
	)

inline

Implements the RPUSHX command.

Parameters

sink	The user-provided callback object.
key	Key name of the list to which value is pushed if it does not already exist.
value	The value to push.

void Sadd	(	IntegerSink	sink,
		string	key,
		params string[]	members
	)

inline

Implements the SADD command.

Parameters

sink	The user-provided callback object.
key	Key name of the set to which members are added.
members	The elements to add.

void Save ( SimpleStringSink sink )

inline

Implements the SAVE command.

Parameters

sink	The user-provided callback object.

void Scan	(	ArraySink	sink,
		ulong	cursor,
		ScanOptions	options
	)

inline

Implements the SCAN command.

Parameters

sink	The user-provided callback object.
cursor	The cursor returned by the previous call to Scan() (or 0 to start a new iteration).
options	Additional options for the SCAN command (e.g. MATCH, COUNT).

void Scard	(	IntegerSink	sink,
		string	key
	)

inline

Implements the SCARD command.

Parameters

sink	The user-provided callback object.
key	Key name of the set whose cardinality is returned.

void ScriptDebug	(	SimpleStringSink	sink,
		DebugState	debugState
	)

inline

Implements the SCRIPT DEBUG command.

Parameters

sink	The user-provided callback object.
debugState	The debug mode to set (i.e. YES, SYNC, NO)

void ScriptExists	(	ArraySink	sink,
		params string[]	digests
	)

inline

Implements the SCRIPT EXISTS command.

Parameters

sink	The user-provided callback object.
digests	The SHA1 digests whose script cache presences are returned.

void ScriptFlush ( SimpleStringSink sink )

inline

Implements the SCRIPT FLUSH command.

Parameters

sink	The user-provided callback object.

void ScriptKill ( SimpleStringSink sink )

inline

Implements the SCRIPT KILL command.

Parameters

sink	The user-provided callback object.

void ScriptLoad	(	BulkStringSink	sink,
		string	script
	)

inline

Implements the SCRIPT LOAD command.

Parameters

sink	The user-provided callback object.
script	The script that is loaded into the script cache. This script string is automatically wrapped in quotes as it is likely to contain spaces.

void Sdiff	(	ArraySink	sink,
		params string[]	keys
	)

inline

Implements the SDIFF command.

Parameters

sink	The user-provided callback object.
keys	Key names of the sets whose differences are returned.

void SdiffStore	(	IntegerSink	sink,
		string	destination,
		params string[]	keys
	)

inline

Implements the SDIFFSTORE command.

Parameters

sink	The user-provided callback object.
destination	Key name of the set used to store the result.
keys	Key names of the sets whose differences are stored in destination.

void Select	(	SimpleStringSink	sink,
		int	index
	)

inline

Implements the SELECT command.

Parameters

sink	The user-provided callback object.
index	The zero-based index of the Redis logical database to select.

void Set	(	SimpleStringSink	sink,
		string	key,
		string	value,
		SetOptions	options
	)

inline

Implements the SET command.

Parameters

sink	The user-provided callback object.
key	The name of the key that is set.
value	The value that key is set to.
options	Additional options for the SET command allowing the caller to specify expiration values and extant key behavior.

void Set	(	SimpleStringSink	sink,
		string	key,
		string	value
	)

inline

Implements the SET command.

Parameters

sink	The user-provided callback object.
key	The name of the key that is set.
value	The value that key is set to.

void SetBit	(	IntegerSink	sink,
		string	key,
		int	offset,
		string	value
	)

inline

Implements the SETBIT command.

Parameters

sink	The user-provided callback object.
key	The name of the key containing the bit to set.
offset	The offset of the bit to set.
value	The value the bit will be set to.

void SetEx	(	SimpleStringSink	sink,
		string	key,
		long	seconds,
		string	value
	)

inline

Implements the SETEX command.

Parameters

sink	The user-provided callback object.
key	The name of the key that is set.
seconds	The timeout value in seconds.
value	The value that key is set to.

void SetNx	(	IntegerSink	sink,
		string	key,
		string	value
	)

inline

Implements the SETNX command.

Parameters

sink	The user-provided callback object.
key	The name of the key to set.
value	The value that key is set to if key doesn't already exist.

void SetRange	(	IntegerSink	sink,
		string	key,
		int	offset,
		string	value
	)

inline

Implements the SETRANGE command.

Parameters

sink	The user-provided callback object.
key	The name of the key that is written to.
offset	The byte offset at which value is written.
value	The value that is written into key.

void Shutdown ( SimpleStringSink sink )

inline

Implements the SHUTDOWN command. From the docs:

"On success nothing is returned since the server quits and the connection is closed."

Similar to CLIENT REPLY, nothing is returned, but in this case the socket should be closed and we won't be stuck waiting indefinitely for a response.

Parameters

sink	The user-provided callback object.

void Shutdown	(	SimpleStringSink	sink,
		ShutdownOption	option
	)

inline

Implements the SHUTDOWN command.

Parameters

sink	The user-provided callback object.
option	Specifies DB saving behavior on shutdown.

void Sinter	(	ArraySink	sink,
		params string[]	keys
	)

inline

Implements the SINTER command.

Parameters

sink	The user-provided callback object.
keys	Key names of the sets that are intersected with each other.

void SinterStore	(	IntegerSink	sink,
		string	destination,
		params string[]	keys
	)

inline

Implements the SINTERSTORE command.

Parameters

sink	The user-provided callback object.
destination	Key name of the set used to store the result.
keys	Key names of the sets that are intersected with each other.

void SisMember	(	IntegerSink	sink,
		string	key,
		string	member
	)

inline

Implements the SISMEMBER command.

Parameters

sink	The user-provided callback object.
key	Key name of the set that is inspected.
member	The name of the element whose presence is returned.

void SlaveOf	(	SimpleStringSink	sink,
		string	host,
		string	port
	)

inline

Implements the SLAVEOF command.

A special value of "NO" for host, and "ONE" for port will turn off replication

Parameters

sink	The user-provided callback object.
host	The hostname of a Redis server to replicate.
port	The Redis port on host (specified as a string to accommodate the "SLAVEOF NO ONE" command format).

void SlowLogGet	(	ArraySink	sink,
		int	count
	)

inline

Implements the SLOWLOG command.

Parameters

sink	The user-provided callback object.
count	The number of entries to return.

void SlowLogGet ( ArraySink sink )

inline

Implements the SLOWLOG command.

Parameters

sink	The user-provided callback object.

void SlowLogLen ( IntegerSink sink )

inline

Implements the SLOWLOG command.

Parameters

sink	The user-provided callback object.

void SlowLogReset ( SimpleStringSink sink )

inline

Implements the SLOWLOG command.

Parameters

sink	The user-provided callback object.

void Smembers	(	ArraySink	sink,
		string	key
	)

inline

Implements the SMEMBERS command.

Parameters

sink	The user-provided callback object.
key	Key name of the set whose elements are returned.

void Smove	(	IntegerSink	sink,
		string	source,
		string	destination,
		string	member
	)

inline

Implements the SMOVE command.

Parameters

sink	The user-provided callback object.
source	Key name of the set from which member is moved.
destination	Key name of the set to which member is moved.
member	The name of the element to move.

void Sort	(	ArraySink	sink,
		string	key,
		SortOptions	options
	)

inline

Implements the SORT command. Array reply: without passing the store option the command returns a list of sorted elements.

Parameters

sink	The user-provided callback object.
key	Key name of the list, set or sorted set to sort.
options	Additional options for the SORT command (e.g. BY pattern, LIMIT, GET patterns, sort order, and ALPHA)

void Sort	(	IntegerSink	sink,
		string	key,
		SortOptions	options,
		string	storeKey
	)

inline

Implements the SORT command. Integer reply: when the store option is specified the command returns the number of sorted elements in the destination list.

Parameters

sink	The user-provided callback object.
key	Key name of the list, set or sorted set to sort.
options	Additional options for the SORT command (e.g. BY pattern, LIMIT, GET patterns, sort order, and ALPHA)
storeKey	Key name used to store the resulting list.

void Spop	(	BulkStringSink	sink,
		string	key
	)

inline

Implements the SPOP command.

Parameters

sink	The user-provided callback object.
key	Key name of the set from which random elements are popped.

void Spop	(	BulkStringSink	sink,
		string	key,
		int	count
	)

inline

Implements the SPOP command.

Parameters

sink	The user-provided callback object.
key	Key name of the set from which random elements are popped.
count	The numer of elements to return.

void SrandMember	(	BulkStringSink	sink,
		string	key
	)

inline

Implements the SRANDMEMBER command.

Parameters

sink	The user-provided callback object.
key	Key name of the set from which random elements are returned.

void SrandMember	(	BulkStringSink	sink,
		string	key,
		int	count
	)

inline

Implements the SRANDMEMBER command.

Parameters

sink	The user-provided callback object.
key	Key name of the set from which random elements are returned.
count	The numer of elements to return.

void Srem	(	IntegerSink	sink,
		string	key,
		params string[]	members
	)

inline

Implements the SREM command.

Parameters

sink	The user-provided callback object.
key	Key name of the set from which elements are removed.
members	The names of the elements to remove.

void Sscan	(	ArraySink	sink,
		string	key,
		ulong	cursor,
		ScanOptions	options
	)

inline

Implements the SSCAN command.

Parameters

sink	The user-provided callback object.
key	Key name of the set that is iterated.
cursor	The cursor returned by the previous call to Sscan() (or 0 to start a new iteration).
options	Additional options for the SSCAN command (e.g. MATCH, COUNT).

void StrLen	(	IntegerSink	sink,
		string	key
	)

inline

Implements the STRLEN command.

Parameters

sink	The user-provided callback object.
key	The name of the key whose length is returned.

void Sunion	(	ArraySink	sink,
		params string[]	keys
	)

inline

Implements the SUNION command.

Parameters

sink	The user-provided callback object.
keys	Key names of the sets that are combined with each other.

void SunionStore	(	IntegerSink	sink,
		string	destination,
		params string[]	keys
	)

inline

Implements the SUNIONSTORE command.

Parameters

sink	The user-provided callback object.
destination	Key name of the set used to store the result.
keys	Key names of the sets that are combined with each other.

void SwapDb	(	SimpleStringSink	sink,
		int	indexOne,
		int	indexTwo
	)

inline

Implements the SWAPDB command.

Parameters

sink	The user-provided callback object.
indexOne	The index of the Redis databases that is swapped with indexTwo.
indexTwo	The index of the Redis databases that is swapped with indexOne.

void Time ( ArraySink sink )

inline

Implements the TIME command.

Parameters

sink	The user-provided callback object.

void Touch	(	IntegerSink	sink,
		params string[]	keys
	)

inline

Implements the TOUCH command.

Parameters

sink	The user-provided callback object.
keys	Key name(s) to touch.

void Ttl	(	IntegerSink	sink,
		string	key
	)

inline

Implements the TTL command.

Parameters

sink	The user-provided callback object.
key	The key whose TTL (in seconds) is returned.

void Type	(	SimpleStringSink	sink,
		string	key
	)

inline

Implements the TYPE command.

Parameters

sink	The user-provided callback object.
key	The key name whose type is returned.

void Unlink	(	IntegerSink	sink,
		params string[]	keys
	)

inline

Implements the UNLINK command.

Parameters

sink	The user-provided callback object.
keys	The key name(s) to unlink.

void Unwatch ( SimpleStringSink sink )

inline

Implements the UNWATCH command.

Parameters

sink	The user-provided callback object.

void Wait	(	IntegerSink	sink,
		int	numReplicas,
		int	timeout
	)

inline

Implements the WAIT command.

Parameters

sink	The user-provided callback object.
numReplicas	The number of replicas to wait for.
timeout	The timeout for the operation, in milliseconds.

void Watch	(	SimpleStringSink	sink,
		params string[]	keys
	)

inline

Implements the WATCH command.

Parameters

sink	The user-provided callback object.
keys	The key(s) to watch.

void Xack	(	IntegerSink	sink,
		string	key,
		string	group,
		params string[]	ids
	)

inline

Implements the XACK command.

Parameters

sink	The user-provided callback object.
key	Key name of the stream whose messages are acknowledged.
group	The stream consumer group.
ids	IDs of messages to acknowledge.

void Xadd	(	BulkStringSink	sink,
		string	key,
		string	id,
		params FieldValuePair[]	pairs
	)

inline

Implements the XADD command.

Specify the stream entry ID as "*" to auto-generate a unique ID.

Parameters

sink	The user-provided callback object.
key	Key name of the stream to which the stream entry is added.
id	Stream entry ID.
pairs	Field/value pairs that are added to the stream.

void Xclaim	(	ArraySink	sink,
		string	key,
		string	group,
		string	consumer,
		int	minIdleTime,
		XclaimOptions	options,
		params string[]	ids
	)

inline

Implements the XCLAIM command.

Parameters

sink	The user-provided callback object.
key	Key name of the stream containing group.
group	The consumer group the originally owned the messages being claimed.
consumer	The consumer group that is claiming the messages.
minIdleTime	The minimum amount of time a message must be idle before it can be claimed.
options	Additional options for the XCLAIM command (e.g. IDLE, TIME, RETRYCOUNT, FORCE, and JUSTID).
ids	IDs of messages to claim.

void Xdel	(	IntegerSink	sink,
		string	key,
		params string[]	ids
	)

inline

Implements the XDEL command.

Parameters

sink	The user-provided callback object.
key	Key name of the stream from which ids are deleted.
ids	Stream entry IDs to delete.

void XgroupCreate	(	SimpleStringSink	sink,
		string	key,
		string	groupname,
		XgroupCreateOptions	options
	)

inline