scredis.io

Connection

trait Connection extends AnyRef

Represents a connection to a Redis server.

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Connection
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def connect(): Unit

    Connects to the Redis server with provided host and port.

    Connects to the Redis server with provided host and port.

    Exceptions thrown
    ConnectionException

    if unable to connect

  2. abstract def currentTimeout: Duration

    Returns the currently set read/write timeout of this connection.

    Returns the currently set read/write timeout of this connection.

    return the current timeout, can be infinite

  3. abstract def disconnect(): Unit

    Disconnects from the Redis server.

    Disconnects from the Redis server.

    Exceptions thrown
    ConnectionException

    if an error occurs while disconnecting

  4. abstract def isConnected: Boolean

    Returns true if the connection is connected to a Redis server, false otherwise

    Returns true if the connection is connected to a Redis server, false otherwise

    returns

    true if the connection is connected to a Redis server, false otherwise

  5. abstract def read(count: Int, consumeEndLine: Boolean = true): Array[Byte]

    Reads count bytes from the input stream and optionally consumes a CRLF (without returning it).

    Reads count bytes from the input stream and optionally consumes a CRLF (without returning it).

    count

    the number of bytes to read

    consumeEndLine

    when true, reads a CRLF after having read count bytes

    returns

    the read bytes

    Exceptions thrown
    ConnectionException

    if any other error occurs

    ConnectionTimeoutException

    if a timeout occurs while trying to read

  6. abstract def readLine(): Array[Byte]

    Reads the next line from the input stream (delimited by a CRLF) without returning the end line delimiter

    Reads the next line from the input stream (delimited by a CRLF) without returning the end line delimiter

    returns

    the read bytes

    Exceptions thrown
    ConnectionException

    if any other error occurs

    ConnectionTimeoutException

    if a timeout occurs while trying to read

  7. abstract def reconnect(): Unit

    Diconnects and reconnects

    Diconnects and reconnects

    Exceptions thrown
    ConnectionException

    if an error occurs

  8. abstract def restoreDefaultTimeout(): Unit

    Restores the connection timeout value to the original configured value

  9. abstract def setTimeout(timeout: Duration): Unit

    Sets the read/write timeout of this connection.

    Sets the read/write timeout of this connection.

    timeout

    the timeout's duration, can be infinite

  10. abstract val timeout: Duration

  11. abstract def write(data: Array[Byte]): Unit

    Writes data to the output stream.

    Writes data to the output stream.

    Exceptions thrown
    ConnectionException

    if any other error occurs

    ConnectionTimeoutException

    if a timeout occurs while trying to write

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  18. def toString(): String

    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped