syncsocket v0.2.13

SyncSocket

Synchronized messaging application framework server

API Docs

Channel

Channel constructor.

Parameters

• server Server The server object
• opts object Options
  • opts.channelId string The channel id (string). If not passed, will generate a random one
  • opts.timeserver string The timeserver which channel will use (if not set, will use the server's default)
  • opts.autoSyncClients boolean Automatically instruct unsynchronized clients to re-synchronize

addClient

Adds client to the channel

Parameters

• client Client

hasClient

Whether a client is joined this channel

Parameters

• client

Returns boolean

Channel#error

Channel error

Channel#join

Client joined the channel

Channel#left

Client left the channel

Channel#clientStateChange

Client has switched state

Properties

• client Client
• newState string

Channel#scheduledMessage

An event has been scheduled

Properties

• envelope object
• time number

Server

Server constructor

Parameters

• srv (http.Server | number | object) http server, port or options
• opts object

Properties

• embeddedTimeserver boolean If set to true, an embedded timeserver will be launched
• timeserverHost string Clients will connect to this timeserver if no timeserver specified for channel
• timeserverPort number Clients will connect to this timeserver if no timeserver specified for channel

timeserverUrl

URL of server's default timeserver (set via timeserverHost() and timeserverPort())

Returns string URL

serveClient

Sets/gets whether client code is being served

Parameters

• v boolean whether to serve client code

Returns (Server | boolean) self when setting or value when getting

embeddedTimeserver

Sets/gets whether embedded timeserver is active

Parameters

• v boolean whether to activate integrated timeserver

Returns (Server | boolean) self when setting or value when getting

timeserverHost

Sets/gets timeserver host to which clients will connect if no timeserver specified for channel

Parameters

• v string default host

Returns (Server | string) self when setting or value when getting

timeserverPort

Sets/gets timeserver port to which clients will connect if no timeserver specified for channel

Parameters

• v number default port

Returns (Server | number) self when setting or value when getting

listen

Attaches to a server or port

Parameters

• server (http.Server | number) or port
• options Object

Returns Server self

createChannel

Creates a channel

Parameters

• channelId ?string channel id or null. If null, then id will be generated

Returns ?Channel that has been created or null

addToChannel

Adds a client to a specific channel

Parameters

• client Client
• opts object Options
  • opts.channelId string The channel ID to add client

Returns boolean Operation result

getChannel

Get specific channel

Parameters

• channelId Channel id

Returns ?Channel

close

Shuts down the server

Returns Server

Server#connection

Client has successfully connected

Server#disconnect

Client has disconnected