API Docs for:
Show:

Hotel Class

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

Manages Rooms and its Guests

Constructor

Hotel

()

Defined in src/signaling.coffee:68

Example:

var hotel = new Hotel()
guest_a = hotel.create_guest(conn_a, 'room')
guest_b = hotel.create_guest(conn_b, 'room')

Item Index

Methods

Properties

Events

Methods

create_guest

(
  • conn
  • room_name
)
Guest

Defined in src/signaling.coffee:126

Create a new guest which might join the room with the given name

Parameters:

  • conn Channel

    The connection to the guest

  • room_name String

    The name of the room to join

Returns:

Guest:

get_room

(
  • name
)
Room private

Defined in src/signaling.coffee:104

Get a room. The room is created if it did not exist. The room will be removed when it throws empty.

Parameters:

  • name String

    The name of the room

Returns:

Room:

Properties

rooms

Unknown private

Defined in src/signaling.coffee:94

An object containing the rooms with their names as keys

Events

room_created

(
  • room
)

Defined in src/signaling.coffee:82

A new room was created

Parameters:

  • room Room

    The new room

room_removed

(
  • room
)

Defined in src/signaling.coffee:88

A new room was removed because all guests left

Parameters:

  • room Room

    The empty room