API Docs for:
Show:

Guest Class

Extends events.EventEmitter
Defined in: src/signaling.coffee:254
Module: easy-signaling

A guest which might join a Room.

It will join the room once the client sends 'join' and and leave once it emits the 'left' event.

Constructor

Guest

(
  • conn
  • room_fun
)

Defined in src/signaling.coffee:254

Parameters:

  • conn Channel

    The connection to the guest

  • room_fun Function

    Function which will be called upon joining and which should return the Room to join

Item Index

Methods

Properties

Events

Methods

closing

() private

Defined in src/signaling.coffee:424

The connection to the guest is closing

error

(
  • The
)
private

Defined in src/signaling.coffee:407

The guest encountered an error

Parameters:

  • The Error

    error which was encountered

receive

(
  • data
)
private

Defined in src/signaling.coffee:306

The guest receives data

Parameters:

  • data Object

    The incoming message

send

(
  • data
)
private

Defined in src/signaling.coffee:397

The guest sends data

Parameters:

  • data Object

    The outgoing message

Properties

id

String

Defined in src/signaling.coffee:286

The unique identifier of the guest

status

Object

Defined in src/signaling.coffee:293

The status object of the guest. Will only be available after joining.

Events

joined

(
  • room
)

Defined in src/signaling.coffee:268

Guest joined a room

Parameters:

  • room Room

    The joined room

left

(
  • room
)

Defined in src/signaling.coffee:274

Guest left the room

Parameters:

  • room Room

    The joined room

status_changed

(
  • status
)

Defined in src/signaling.coffee:280

The status of the guest changed

Parameters:

  • status Object

    The new status