API Docs for:
Show:

Room Class

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

A room containing and conencting Guests. Can be created by a Hotel or used alone.

Constructor

Room

(
  • name
)

Defined in src/signaling.coffee:137

Parameters:

  • name String

Example:

var room = new Room()
guest_a = room.create_guest(conn_a)
guest_b = room.create_guest(conn_b)

Item Index

Methods

Properties

Events

Methods

broadcast

(
  • msg
  • sender
)
private

Defined in src/signaling.coffee:186

Send a message to all guest except the sender

Parameters:

  • msg Object

    The message

  • sender String

    The id of the sender of the message (who will be skipped)

create_guest

(
  • conn
)
Guest

Defined in src/signaling.coffee:244

Create a guest which might join the room

Parameters:

  • conn Channel

    The connection to the guest

Returns:

Guest:

join

(
  • guets
)
Boolean private

Defined in src/signaling.coffee:215

A guest joins the room. Will be removed when it emits 'left'

Parameters:

  • guets Guest

    The guest which joins the room

Returns:

Boolean:

true if and only if the guest could join

send

(
  • msg
  • recipient
)
Boolean private

Defined in src/signaling.coffee:199

Send a message to a guest

Parameters:

  • msg Object

    The message

  • recipient String

    The recipient of the message

Returns:

Boolean:

True if the recipient exists

Properties

guests

Unknown private

Defined in src/signaling.coffee:175

The current guests of the room

name

Unknown

Defined in src/signaling.coffee:169

The name of the room

Events

empty

()

Defined in src/signaling.coffee:164

The room was left by all guests

guest_joined

(
  • guest
)

Defined in src/signaling.coffee:152

A guest joined the room

Parameters:

  • guest Guest

    The new guest

guest_left

(
  • guest
)

Defined in src/signaling.coffee:158

A guest left the room

Parameters:

  • guest Guest

    The leaving guest