coraline-client

Class: CoralineClient

CoralineClient

Represents a Coraline Client, it does have function for login to Coralines and handle messages and queries

new CoralineClient (sock, id, coraline)

Name Type Description
sock Socket Client socket connection
id number Client ID given by the Coraline server
coraline Object Coraline.toObject object
Name Type Description
id number Coraline ID
name String Coraline name
max_clients number Maximum number of clients connected

Extends

Members

coraline Object readonly

Remote Coraline Info

id Socket readonly

Client ID

iid number

Query ID Counter

qmanager EventEmitter

Query event manager

queries Object

Query container object

sock Socket

SocketIO connection

Methods

message (signal, args)

Emits a message to the server
Name Type Description
signal String Signal to emit
args Any repeatable Arguments to send

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

query (signal)

Makes a query to the server
Name Type Description
signal String Signal to emit
...args Any repeatable Arguments to send

resolve (iid)

Emits a resolve signal to the server
Name Type Description
iid number Query ID
...args Any repeatable Arguments to response

resolveQuery (iid)

Runs a query and deletes it from the query pool
Name Type Description
iid number Query ID
...args Any repeatable Arguments to pass to the function