coraline-client

Class: CoralineInstance

CoralineInstance

Represents a Coraline server, it does have functions for sending and receiving messages and queries from clients

new CoralineInstance (sock, config)

Name Type Description
sock Socket SocketIO master connection
config Object Coraline Configuration Object
Name Type Description
max_clients number Max number of clients allowed
name String The name of the Coraline
id number Internal Coraline reference ID

Extends

Members

clients Object

Client pool

id number readonly

Coraline ID

max_clients number readonly

Coraline max_clients

name String readonly

Coraline name

qmanager EventEmitter

Query EventEmitter

sock Socket

SocketIO master connection

Methods

broadcast (signal)

Emits a broadcast signal to clients
Name Type Description
signal String Signal to emit
...args Any repeatable Arguments to send

client (client_id)

Returns a client with specified id
Name Type Description
client_id number Client ID to search

onquery (signal, cb)

Adds a listener to a query event
Name Type Description
signal String Event name to listen
cb function Callback fired each time a query with the specified signal is received

resolve (id, iid)

Resolves a query
Name Type Description
id number Client ID
iid number Query ID
...args Any repeatable Arguments to send