vertx-lang-scala-docs_2.12 3.9.1 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package redis
  Definition Classes
    scala
-  package client
  Definition Classes
    redis
- Command
- Redis
- RedisAPI
- RedisConnection
- RedisOptions
- Request
- Response

c

io.vertx.scala.redis.client

# RedisConnection 

###
Companion object RedisConnection

#### class RedisConnection extends ReadStream[Response]

A simple Redis client.

Linear Supertypes
ReadStream[Response], StreamBase, AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. RedisConnection
2. ReadStream
3. StreamBase
4. AnyRef
5. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new RedisConnection(_asJava: AnyRef)

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##(): Int
   Definition Classes
     AnyRef → Any
3.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
4.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
5.  def asJava: AnyRef
   Definition Classes
     RedisConnection → ReadStream → StreamBase
6.  def batch(commands: Buffer[Request], onSend: Handler[AsyncResult[Buffer[Option[Response]]]]): RedisConnection

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

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

   onSend

     the asynchronous result handler.

   returns

     fluent self.

7.  def batchFuture(commands: Buffer[Request]): Future[Buffer[Option[Response]]]

   Like batch but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

8.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @native() @throws( ... )
9.  def close(): Unit

   Closes the connection or returns to the pool.

10.  def endHandler(endHandler: Handler[Unit]): RedisConnection

    Definition Classes
      RedisConnection → ReadStream
11.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
12.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
13.  def exceptionHandler(handler: Handler[Throwable]): RedisConnection

    returns

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

    Definition Classes
      RedisConnection → ReadStream → StreamBase
14.  def fetch(amount: Long): RedisConnection

    Definition Classes
      RedisConnection → ReadStream
15.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
16.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
17.  def handler(handler: Handler[Response]): RedisConnection

    Definition Classes
      RedisConnection → ReadStream
18.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
19.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
20.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
21.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
22.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
23.  def pause(): RedisConnection

    Definition Classes
      RedisConnection → ReadStream
24.  def pendingQueueFull(): Boolean

    Flag to notify if the pending message queue (commands in transit) is full.

    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. * @return true is queue is full.

25.  def pipe(): Pipe[Response]

    Pause this stream and return a io.vertx.scala.core.streams.Pipe to transfer the elements of this stream to a destination io.vertx.scala.core.streams.WriteStream.

    Pause this stream and return a io.vertx.scala.core.streams.Pipe to transfer the elements of this stream to a destination io.vertx.scala.core.streams.WriteStream.

    The stream will be resumed when the pipe will be wired to a `WriteStream`. * @return a pipe

    Definition Classes
      RedisConnection → ReadStream
26.  def pipeTo(dst: WriteStream[Response], handler: Handler[AsyncResult[Unit]]): Unit

    Pipe this `ReadStream` to the `WriteStream`.

    Pipe this `ReadStream` to the `WriteStream`.

    Elements emitted by this stream will be written to the write stream until this stream ends or fails.

    Once this stream has ended or failed, the write stream will be ended and the `handler` will be called with the result. * @param dst the destination write stream

    Definition Classes
      RedisConnection → ReadStream
27.  def pipeTo(dst: WriteStream[Response]): Unit

    Like io.vertx.scala.core.streams.ReadStream#pipeTo but with no completion handler.

    Like io.vertx.scala.core.streams.ReadStream#pipeTo but with no completion handler.

    Definition Classes
      RedisConnection → ReadStream
28.  def pipeToFuture(dst: WriteStream[Response]): Future[Unit]

    Like pipeTo but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Like pipeTo but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

    Definition Classes
      RedisConnection → ReadStream
29.  def resume(): RedisConnection

    Definition Classes
      RedisConnection → ReadStream
30.  def send(command: Request, onSend: Handler[AsyncResult[Option[Response]]]): RedisConnection

    Send the given command to the redis server or cluster.

    Send the given command to the redis server or cluster. * @param command the command to send

    onSend

      the asynchronous result handler.

    returns

      fluent self.

31.  def sendFuture(command: Request): Future[Option[Response]]

    Like send but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

32.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
33.  def toString(): String
    Definition Classes
      AnyRef → Any
34.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
35.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
36.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )

### Inherited from ReadStream[Response]

### Inherited from StreamBase

### Inherited from AnyRef

### Inherited from Any

### Ungrouped