API¶

All methods, grouped by object. The guide pages show them in use.

Lync¶

Call
`define(name, definitions)`	Creates a namespace. Returns the same table with each definition bound to it.
`packet(codec)`	An event one way. See Packets.
`query(request, reply)`	A request and its reply. See Queries.
`replicate(codec)`	Server owned records. See Sets.
`group()`	A membership set. See Groups.
`all`	Every client, as a recipient.
`except(target)`	Everyone but a player, a list, or a group.
`none`	The sentinel that clears an optional field in `update`.
`start()`	See Lifecycle.
`flush(name?, budget?)`
`close()`
`onLog(fn)`	The log listener. Returns a connection.
`console`	The built-in log listener that prints to the output. A connection.

Call	Side
`:unreliable()`	declaration	Delivery.
`:newest(hz?)`	declaration
`:timestamped()`	declaration
`:fireServer(payload)`	client
`:fireClient(to, payload)`	server
`:onServer(fn)`	server	`fn(payload, player, sent?)`
`:onClient(fn)`	client	`fn(payload, sent?)`
`:describe()`	either	The schema as text. Two schemas with the same text are compatible.

Call	Side
`:request(value, timeout?)`	client	Yields. Returns `ok, reply, detail`.
`:request(client, value, fn, timeout?)`	server	`fn(ok, reply, detail)` on completion.
`:onServer(fn)`	server	The single responder on the server.
`:onClient(fn)`	client	The single responder on the client.
`:describe()`	either

Call	Side
`:keyBy(field)`	declaration	Audiences split on `field`.
`:add(id, record)`	server
`:update(id, fields)`	server
`:remove(id)`	server
`:clear()`	server
`:audience(key, to)`	server	Keyed sets only.
`:get(id)`	either	The live record or nil.
`:size()`	either	The count. Same as `#set`.
`:entries()`	either	An iterator. Same as `for id, record in set`.
`:onAdded(fn)`	either	`fn(id, record)`
`:onChanged(fn)`	either	`fn(id, record, old)`
`:onRemoved(fn)`	either	`fn(id, cause)`
`:describe()`	either

Call
`:add(player)`
`:remove(player)`
`:has(player)`
`:size()`	The count. Same as `#group`.
`:players()`	An iterator. Same as `for _, player in group`.
`:destroy()`	Empties and releases. Any later use throws.

Member
`.connected`	Whether it is still attached.
`:disconnect()`	Detaches the handler. Calling it more than once has no further effect.