io.vertx.redis.client

Interface RedisConnection

All Superinterfaces:

io.vertx.core.streams.ReadStream<Response>, io.vertx.core.streams.StreamBase

public interface RedisConnection
extends io.vertx.core.streams.ReadStream<Response>

A simple Redis client.

Method Summary

Modifier and Type	Method and Description
io.vertx.core.Future<List<Response>>	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.
default RedisConnection	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.
io.vertx.core.Future<Void>	close() Closes the connection or returns to the pool.
default RedisConnection	close(io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> onClose) Closes the connection or returns to the pool.
RedisConnection	endHandler(io.vertx.core.Handler<Void> endHandler)
RedisConnection	exceptionHandler(io.vertx.core.Handler<Throwable> handler)
RedisConnection	fetch(long amount)
RedisConnection	handler(io.vertx.core.Handler<Response> handler)
RedisConnection	pause()
boolean	pendingQueueFull() Flag to notify if the pending message queue (commands in transit) is full.
RedisConnection	resume()
io.vertx.core.Future<Response>	send(Request command) Send the given command to the redis server or cluster.
default RedisConnection	send(Request command, io.vertx.core.Handler<io.vertx.core.AsyncResult<Response>> onSend) Send the given command to the redis server or cluster.

Methods inherited from interface io.vertx.core.streams.ReadStream

pipe, pipeTo, pipeTo

Method Detail

exceptionHandler

RedisConnection exceptionHandler(io.vertx.core.Handler<Throwable> handler)

Specified by:

exceptionHandler in interface io.vertx.core.streams.ReadStream<Response>

Specified by:

exceptionHandler in interface io.vertx.core.streams.StreamBase

handler

RedisConnection handler(io.vertx.core.Handler<Response> handler)

Specified by:

handler in interface io.vertx.core.streams.ReadStream<Response>

pause

RedisConnection pause()

Specified by:

pause in interface io.vertx.core.streams.ReadStream<Response>

resume

RedisConnection resume()

Specified by:

resume in interface io.vertx.core.streams.ReadStream<Response>

fetch

RedisConnection fetch(long amount)

Specified by:

fetch in interface io.vertx.core.streams.ReadStream<Response>

endHandler

RedisConnection endHandler(io.vertx.core.Handler<Void> endHandler)

Specified by:

endHandler in interface io.vertx.core.streams.ReadStream<Response>

send

default RedisConnection 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

io.vertx.core.Future<Response> send(Request command)

Send the given command to the redis server or cluster.

Parameters:

command - the command to send

Returns:

a future with the result of the operation

batch

default RedisConnection 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

io.vertx.core.Future<List<Response>> 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:

a future with the result of the operation

close

io.vertx.core.Future<Void> close()

Closes the connection or returns to the pool.

close

default RedisConnection close(io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> onClose)

Closes the connection or returns to the pool.

pendingQueueFull

boolean pendingQueueFull()

Flag to notify if the pending message queue (commands in transit) is full. When the pending message queue is full and a new send command is issued it will result in a exception to be thrown. Checking this flag before sending can allow the application to wait before sending the next message.

Returns:

true is queue is full.