WebSocket

Instance Constructors

new WebSocket(endpoint: String, protocols: String*)

endpoint
The URL to which to connect; this should be the URL to which the WebSocket server will respond.
protocols
Either a single protocol string or an array of protocol strings. These strings are used to indicate sub-protocols, so that a single server can implement multiple WebSocket sub-protocols (for example, you might want one server to be able to handle different types of interactions depending on the specified protocol). If you don't specify a protocol string, an empty string is assumed.

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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def binaryType: String

A string indicating the type of binary data being transmitted by the connection.
A string indicating the type of binary data being transmitted by the connection. This should be either "blob" if DOM Blob objects are being used or "arraybuffer" if ArrayBuffer objects are being used.
def bufferedAmount: Long

The number of bytes of data that have been queued using calls to send() but not yet transmitted to the network.
The number of bytes of data that have been queued using calls to send() but not yet transmitted to the network. This value resets to zero once all queued data has been sent. This value does not reset to zero when the connection is closed; if you keep calling send(), this will continue to climb. Read only.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def close(code: Int = js.native, reason: String = js.native): Unit

Closes the WebSocket connection or connection attempt, if any.
Closes the WebSocket connection or connection attempt, if any. If the connection is already CLOSED, this method does nothing.
code
Optional: A numeric value indicating the status code explaining why the connection is being closed. If this parameter is not specified, a default value of 1000 (indicating a normal "transaction complete" closure) is assumed. See the list of status codes on the CloseEvent page for permitted values.
reason
Optional: A human-readable string explaining why the connection is closing. This string must be no longer than 123 bytes of UTF-8 text (not characters).
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def extensions: String

The extensions selected by the server.
The extensions selected by the server. This is currently only the empty string or a list of extensions as negotiated by the connection.
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hasOwnProperty(v: String): Boolean

Definition Classes
Object
def hashCode(): Int

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

Definition Classes
Any
def isPrototypeOf(v: Object): Boolean

Definition Classes
Object
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
var onclose: Function1[CloseEvent, Any]

An event listener to be called when the WebSocket connection's readyState changes to CLOSED.
An event listener to be called when the WebSocket connection's readyState changes to CLOSED. The listener receives a CloseEvent named "close".
var onerror: Function1[ErrorEvent, Any]

An event listener to be called when an error occurs.
An event listener to be called when an error occurs. This is a simple event named "error".
var onmessage: Function1[MessageEvent, Any]

An event listener to be called when a message is received from the server.
An event listener to be called when a message is received from the server. The listener receives a MessageEvent named "message".
var onopen: Function1[OpenEvent, Any]

An event listener to be called when the WebSocket connection's readyState changes to OPEN; this indicates that the connection is ready to send and receive data.
An event listener to be called when the WebSocket connection's readyState changes to OPEN; this indicates that the connection is ready to send and receive data. The event is a simple one with the name "open".
def propertyIsEnumerable(v: String): Boolean

Definition Classes
Object
def protocol: String

A string indicating the name of the sub-protocol the server selected; this will be one of the strings specified in the protocols parameter when creating the WebSocket object.
def readyState: Int

The current state of the connection; this is one of the Ready state constants.
The current state of the connection; this is one of the Ready state constants. Read only.
def send(data: |[|[String, ArrayBuffer], Blob]): Unit

Transmits data to the server over the WebSocket connection.
Transmits data to the server over the WebSocket connection.
data
A text string to send to the server.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
def url: String

The URL as resolved by the constructor.
The URL as resolved by the constructor. This is always an absolute URL. Read only.
def valueOf(): Any

Definition Classes
Object
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 WebSocket | package ws

class WebSocket extends Object

Instance Constructors

new WebSocket(endpoint: String, protocols: String*)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def binaryType: String

def bufferedAmount: Long

def clone(): AnyRef

def close(code: Int = js.native, reason: String = js.native): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def extensions: String

def finalize(): Unit

final def getClass(): Class[_]

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def isPrototypeOf(v: Object): Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

var onclose: Function1[CloseEvent, Any]

var onerror: Function1[ErrorEvent, Any]

var onmessage: Function1[MessageEvent, Any]

var onopen: Function1[OpenEvent, Any]

def propertyIsEnumerable(v: String): Boolean

def protocol: String

def readyState: Int

def send(data: |[|[String, ArrayBuffer], Blob]): Unit

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

def toLocaleString(): String

def toString(): String

def url: String

def valueOf(): Any

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped