API Docs for: 0.0.0
Show:

LCARSServer Class

Defined in: library\x-beta.js:3
Module: Elements

General Library Access/Retrieval Server for the LCARS Library

The library serves as an endpoint for specific collections as designated by the configuration. A websocket is used to synchronize collections being provided to various registrations, allowing for multiple displays to synchronize displayed data.

Constructor

LCARSServer

(
  • handler
)

Defined in library\x-beta.js:3

Parameters:

  • handler Handler

Item Index

Methods

Events

Methods

broadcast

(
  • message
  • [] [sessions]
)

Defined in library\x-beta.js:130

Parameters:

  • message Object

    The message to send to indicated connections.

  • [] [sessions] String optional

    When specified, only the indicated sessions will receive the message.

terminate

(
  • session
)

Defined in library\x-beta.js:141

Parameters:

  • session String

    The identifier for the session to be terminated.

Events

establish

Defined in library\x-beta.js:102

Occurs when a Petition connects to an AccessSet successfully.

Event Payload:

  • data Petition

fault

Defined in library\x-beta.js:121

Occurs when a Petition is received with an unknown event key.

Event Payload:

  • data Petition

malformed

Defined in library\x-beta.js:112

Occurs when a Petition appears valid but suffers an exception.

Event Payload:

  • data Anomaly