Handshake

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.
enableFoundRows: if the server should return the number of found (matched) rows, not the number of changed rows for UPDATE and INSERT ... ON DUPLICATE KEY UPDATE statements.
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

Instance Constructors

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

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.
enableFoundRows
if the server should return the number of found (matched) rows, not the number of changed rows for UPDATE and INSERT ... ON DUPLICATE KEY UPDATE statements.
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

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

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

Definition Classes
AnyRef → Any
def andThen[A](g: (Try[HandshakeResponse]) ⇒ A): (HandshakeInit) ⇒ A

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

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

Definition Classes
Any
val charset: Short

default character established with the server.
val clientCap: Capability

The capability this client has.
def clone(): AnyRef

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

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

initial database to use for the session.
val enableFoundRows: Boolean

if the server should return the number of found (matched) rows, not the number of changed rows for UPDATE and INSERT ...
if the server should return the number of found (matched) rows, not the number of changed rows for UPDATE and INSERT ... ON DUPLICATE KEY UPDATE statements.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

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

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

Definition Classes
Any
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.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val password: Option[String]

MySQL password used to login.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

MySQL username used to login.
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object Handshake | package mysql

Instance Constructors

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

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def andThen[A](g: (Try[HandshakeResponse]) ⇒ A): (HandshakeInit) ⇒ A

def apply(init: HandshakeInit): Try[HandshakeResponse]

final def asInstanceOf[T0]: T0

val charset: Short

val clientCap: Capability

def clone(): AnyRef

def compose[A](g: (A) ⇒ HandshakeInit): (A) ⇒ Try[HandshakeResponse]

val database: Option[String]

val enableFoundRows: Boolean

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val maxPacketSize: StorageUnit

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val password: Option[String]

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

def toString(): String

val username: Option[String]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from (HandshakeInit) ⇒ Try[HandshakeResponse]

Inherited from AnyRef

Inherited from Any

Ungrouped