io.vertx.redis.client.impl

Class PooledRedisConnection

java.lang.Object

io.vertx.redis.client.impl.PooledRedisConnection

All Implemented Interfaces:

ReadStream<Response>, StreamBase, RedisConnection

public class PooledRedisConnection
extends Object
implements RedisConnection

A pooled Redis connection

Constructor Summary

Constructors

Constructor and Description
PooledRedisConnection(Lease<RedisConnection> lease)

Method Summary

Modifier and Type	Method and Description
RedisConnection	actual()
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.
void	close() Closes the connection or returns to the pool.
RedisConnection	endHandler(Handler<Void> endHandler) Set an end handler.
RedisConnection	exceptionHandler(Handler<Throwable> handler) Set an exception handler on the read stream.
RedisConnection	fetch(long amount) Fetch the specified amount of elements.
RedisConnection	handler(Handler<Response> handler) Set a data handler.
RedisConnection	pause() Pause the ReadStream, it sets the buffer in fetch mode and clears the actual demand.
boolean	pendingQueueFull() Flag to notify if the pending message queue (commands in transit) is full.
RedisConnection	resume() Resume reading, and sets the buffer in flowing mode.
Future<Response>	send(Request command) Send the given command to the redis server or cluster.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.vertx.redis.client.RedisConnection

batch, send

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

pipe, pipeTo, pipeTo

Constructor Detail

PooledRedisConnection

public PooledRedisConnection(Lease<RedisConnection> lease)

Method Detail

actual

public RedisConnection actual()

exceptionHandler

public RedisConnection exceptionHandler(Handler<Throwable> handler)

Description copied from interface: RedisConnection

Set an exception handler on the read stream.

Specified by:

exceptionHandler in interface ReadStream<Response>

Specified by:

exceptionHandler in interface StreamBase

Specified by:

exceptionHandler in interface RedisConnection

Parameters:

handler - the exception handler

Returns:

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

handler

public RedisConnection handler(Handler<Response> handler)

Description copied from interface: RedisConnection

Set a data handler. As data is read, the handler will be called with the data.

Specified by:

handler in interface ReadStream<Response>

Specified by:

handler in interface RedisConnection

Returns:

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

pause

public RedisConnection pause()

Description copied from interface: RedisConnection

Pause the ReadStream, it sets the buffer in fetch mode and clears the actual demand.

While it's paused, no data will be sent to the data handler.

Specified by:

pause in interface ReadStream<Response>

Specified by:

pause in interface RedisConnection

Returns:

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

resume

public RedisConnection resume()

Description copied from interface: RedisConnection

Resume reading, and sets the buffer in flowing mode.

If the ReadStream has been paused, reading will recommence on it.

Specified by:

resume in interface ReadStream<Response>

Specified by:

resume in interface RedisConnection

Returns:

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

fetch

public RedisConnection fetch(long amount)

Description copied from interface: RedisConnection

Fetch the specified amount of elements. If the ReadStream has been paused, reading will recommence with the specified amount of items, otherwise the specified amount will be added to the current stream demand.

Specified by:

fetch in interface ReadStream<Response>

Specified by:

fetch in interface RedisConnection

Returns:

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

endHandler

public RedisConnection endHandler(Handler<Void> endHandler)

Description copied from interface: RedisConnection

Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.

Specified by:

endHandler in interface ReadStream<Response>

Specified by:

endHandler in interface RedisConnection

Returns:

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

send

public Future<Response> send(Request command)

Description copied from interface: RedisConnection

Send the given command to the redis server or cluster.

Specified by:

send in interface RedisConnection

Parameters:

command - the command to send

Returns:

a future with the result of the operation

batch

public Future<List<Response>> batch(List<Request> commands)

Description copied from interface: RedisConnection

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

Specified by:

batch in interface RedisConnection

Parameters:

commands - list of command to send

Returns:

a future with the result of the operation

close

public void close()

Description copied from interface: RedisConnection

Closes the connection or returns to the pool.

Specified by:

close in interface RedisConnection

pendingQueueFull

public boolean pendingQueueFull()

Description copied from interface: RedisConnection

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.

Specified by:

pendingQueueFull in interface RedisConnection

Returns:

true is queue is full.