com.twitter.finagle.exp.mysql

Handshake

case class Handshake(username: Option[String] = scala.None, password: Option[String] = scala.None, database: Option[String] = scala.None, clientCap: Capability = Capability.baseCap, charset: Short = ..., maxPacketSize: StorageUnit = ...) extends (HandshakeInit) ⇒ Try[HandshakeResponse] with Product with Serializable

Bridges a server handshake (HandshakeInit) with a client handshake (HandshakeResponse) using the given parameters. This facilitates the connection phase of the mysql protocol.

username

MySQL username used to login.

password

MySQL password used to login.

database

initial database to use for the session.

clientCap

The capability this client has.

charset

default character established with the server.

maxPacketSize

max size of a command packet that the client intends to send to the server. The largest possible packet that can be transmitted to or from a MySQL 5.5 server or client is 1GB.

returns

A Try[HandshakeResponse] that encodes incompatibility with the server.

Linear Supertypes
Serializable, Serializable, Product, Equals, (HandshakeInit) ⇒ Try[HandshakeResponse], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Handshake
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Function1
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Handshake(username: Option[String] = scala.None, password: Option[String] = scala.None, database: Option[String] = scala.None, clientCap: Capability = Capability.baseCap, charset: Short = ..., maxPacketSize: StorageUnit = ...)

    username

    MySQL username used to login.

    password

    MySQL password used to login.

    database

    initial database to use for the session.

    clientCap

    The capability this client has.

    charset

    default character established with the server.

    maxPacketSize

    max size of a command packet that the client intends to send to the server. The largest possible packet that can be transmitted to or from a MySQL 5.5 server or client is 1GB.

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. def andThen[A](g: (Try[HandshakeResponse]) ⇒ A): (HandshakeInit) ⇒ A

    Definition Classes
    Function1
    Annotations
    @unspecialized()
  7. def apply(init: HandshakeInit): Try[HandshakeResponse]

    Definition Classes
    Handshake → Function1
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. val charset: Short

    default character established with the server.

  10. val clientCap: Capability

    The capability this client has.

  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  12. def compose[A](g: (A) ⇒ HandshakeInit): (A) ⇒ Try[HandshakeResponse]

    Definition Classes
    Function1
    Annotations
    @unspecialized()
  13. val database: Option[String]

    initial database to use for the session.

  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. def finalize(): Unit

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

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

    Definition Classes
    Any
  18. val maxPacketSize: StorageUnit

    max size of a command packet that the client intends to send to the server.

    max size of a command packet that the client intends to send to the server. The largest possible packet that can be transmitted to or from a MySQL 5.5 server or client is 1GB.

  19. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  22. val password: Option[String]

    MySQL password used to login.

  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  24. def toString(): String

    Definition Classes
    Function1 → AnyRef → Any
  25. val username: Option[String]

    MySQL username used to login.

  26. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from (HandshakeInit) ⇒ Try[HandshakeResponse]

Inherited from AnyRef

Inherited from Any

Ungrouped