SocketIOEvent

A socket.io event.

A socket.io event consists of a name (which is used on the client side to register handlers for events), and a set of arguments associated with that event.

The arguments mirror the structure in JavaScript, when you publish an event, you pass the event name, and then several arguments. When you subscribe to an event, you declare a function that takes zero or more arguments. Consequently, the arguments get modelled as a sequence.

Furthermore, socket.io allows you to pass either a structure that can be serialized to JSON (in the Play world, this is a JsValue), or a binary argument (in the Play world, this is a ByteString). Hence, each argument is Either[JsValue, ByteString].

Finally, as the last argument, socket.io allows the emitter to pass an ack function. This then gets passed to the consumer as the last argument to their callback function, and they can invoke it, and the arguments passed to it will be serialized to the wire, and passed to the function registered on the other side.

name: The name of the event.
arguments: The list of arguments.
ack: An optional ack function.

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new SocketIOEvent(name: String, arguments: Seq[Either[JsValue, ByteString]], ack: Option[SocketIOEventAck])

name
The name of the event.
arguments
The list of arguments.
ack
An optional ack function.

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
val ack: Option[SocketIOEventAck]

An optional ack function.
val arguments: Seq[Either[JsValue, ByteString]]

The list of arguments.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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 name: String

The name of the event.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

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

Definition Classes
AnyRef
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 SocketIOEvent | package socketio

case class SocketIOEvent(name: String, arguments: Seq[Either[JsValue, ByteString]], ack: Option[SocketIOEventAck]) extends Product with Serializable

Instance Constructors

new SocketIOEvent(name: String, arguments: Seq[Either[JsValue, ByteString]], ack: Option[SocketIOEventAck])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val ack: Option[SocketIOEventAck]

val arguments: Seq[Either[JsValue, ByteString]]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

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 AnyRef

Inherited from Any

Ungrouped