Package io.vertx.reactivex.redis.client

Class Redis

java.lang.Object

io.vertx.reactivex.redis.client.Redis

public class Redis
extends Object

A simple Redis client.

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

Field Summary

Fields

Modifier and Type	Field	Description
static TypeArg<Redis>	__TYPE_ARG

Constructor Summary

Constructors

Constructor	Description
Redis(io.vertx.redis.client.Redis delegate)
Redis(Object delegate)

Method Summary

Modifier and Type	Method	Description
Redis	batch(List<Request> commands)	Sends a list of commands in a single IO operation, this prevents any inter twinning to happen from other client users.
Redis	batch(List<Request> commands, io.vertx.core.Handler<io.vertx.core.AsyncResult<List<Response>>> onSend)	Sends a list of commands in a single IO operation, this prevents any inter twinning to happen from other client users.
void	close()	Closes the client and terminates any connection.
Redis	connect()	Connects to the redis server.
Redis	connect(io.vertx.core.Handler<io.vertx.core.AsyncResult<RedisConnection>> handler)	Connects to the redis server.
static Redis	createClient(Vertx vertx)	Create a new redis client using the default client options.
static Redis	createClient(Vertx vertx, io.vertx.redis.client.RedisOptions options)	Create a new redis client using the given client options.
static Redis	createClient(Vertx vertx, String connectionString)	Create a new redis client using the default client options.
boolean	equals(Object o)
io.vertx.redis.client.Redis	getDelegate()
int	hashCode()
static Redis	newInstance(io.vertx.redis.client.Redis arg)
io.reactivex.Single<List<Response>>	rxBatch(List<Request> commands)	Sends a list of commands in a single IO operation, this prevents any inter twinning to happen from other client users.
io.reactivex.Single<RedisConnection>	rxConnect()	Connects to the redis server.
io.reactivex.Maybe<Response>	rxSend(Request command)	Send the given command to the redis server or cluster.
Redis	send(Request command)	Send the given command to the redis server or cluster.
Redis	send(Request command, io.vertx.core.Handler<io.vertx.core.AsyncResult<Response>> onSend)	Send the given command to the redis server or cluster.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__TYPE_ARG

public static final TypeArg<Redis> __TYPE_ARG

Constructor Detail

Redis

public Redis(io.vertx.redis.client.Redis delegate)

Redis

public Redis(Object delegate)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDelegate

public io.vertx.redis.client.Redis getDelegate()

createClient

public static Redis createClient(Vertx vertx)

Create a new redis client using the default client options.

Parameters:

vertx - the vertx instance

Returns:

the client

createClient

public static Redis createClient(Vertx vertx,
                                 String connectionString)

Create a new redis client using the default client options. Does not support rediss (redis over ssl scheme) for now.

Parameters:

vertx - the vertx instance

connectionString - a string URI following the scheme: redis://[username:password@][host][:port][/database]

Returns:

the client

createClient

public static Redis createClient(Vertx vertx,
                                 io.vertx.redis.client.RedisOptions options)

Create a new redis client using the given client options.

Parameters:

vertx - the vertx instance

options - the user provided options

Returns:

the client

connect

public Redis connect(io.vertx.core.Handler<io.vertx.core.AsyncResult<RedisConnection>> handler)

Connects to the redis server.

Parameters:

handler - the async result handler

Returns:

a reference to this, so the API can be used fluently

connect

public Redis connect()

Connects to the redis server.

Returns:

a reference to this, so the API can be used fluently

rxConnect

public io.reactivex.Single<RedisConnection> rxConnect()

Connects to the redis server.

Returns:

a reference to this, so the API can be used fluently

close

public void close()

Closes the client and terminates any connection.

send

public Redis send(Request command,
                  io.vertx.core.Handler<io.vertx.core.AsyncResult<Response>> onSend)

Send the given command to the redis server or cluster.

Parameters:

command - the command to send

onSend - the asynchronous result handler.

Returns:

fluent self.

send

public Redis send(Request command)

Send the given command to the redis server or cluster.

Parameters:

command - the command to send

Returns:

fluent self.

rxSend

public io.reactivex.Maybe<Response> rxSend(Request command)

Send the given command to the redis server or cluster.

Parameters:

command - the command to send

Returns:

fluent self.

batch

public Redis batch(List<Request> commands,
                   io.vertx.core.Handler<io.vertx.core.AsyncResult<List<Response>>> onSend)

Sends a list of commands in a single IO operation, this prevents any inter twinning to happen from other client users.

Parameters:

commands - list of command to send

onSend - the asynchronous result handler.

Returns:

fluent self.

batch

public Redis batch(List<Request> commands)

Sends a list of commands in a single IO operation, this prevents any inter twinning to happen from other client users.

Parameters:

commands - list of command to send

Returns:

fluent self.

rxBatch

public io.reactivex.Single<List<Response>> rxBatch(List<Request> commands)

Sends a list of commands in a single IO operation, this prevents any inter twinning to happen from other client users.

Parameters:

commands - list of command to send

Returns:

fluent self.

newInstance

public static Redis newInstance(io.vertx.redis.client.Redis arg)