BlueZero Plugin API reference
BlueZero plugin
simB0.getHandles
Description
|
Return a list of active handles |
Lua synopsis |
table handles=simB0.getHandles()
|
Lua parameters |
- |
Lua return values |
handles (table of string): list of handles. |
See also
|
|
simB0.nodeCleanup
simB0.nodeCreate
simB0.nodeDestroy
simB0.nodeInit
simB0.nodeSetAnnounceTimeout
simB0.nodeSpinOnce
simB0.pingResolver
Description
|
Check if resolver node is reachable |
Lua synopsis |
simB0.pingResolver()
|
Lua parameters |
- |
Lua return values |
- |
See also
|
|
simB0.publisherCreate
simB0.publisherDestroy
simB0.publisherPublish
simB0.serviceClientCall
simB0.serviceClientCreate
simB0.serviceClientDestroy
simB0.serviceServerCreate
simB0.serviceServerDestroy
simB0.socketCleanup
simB0.socketInit
simB0.socketPoll
simB0.socketRead
simB0.socketSetCompression
simB0.socketSetOption
Description
|
Set a low-level socket option. Available options:
- lingerPeriod
- backlog
- readTimeout
- writeTimeout
- immediate
- conflate
- readHWM
- writeHWM
|
Lua synopsis |
simB0.socketSetOption(string handle, string option, int value)
|
Lua parameters |
handle (string): socket handle
option (string): option key.
value (int): option value.
|
Lua return values |
- |
See also
|
|
simB0.socketSpinOnce
simB0.socketWrite
simB0.spin
Description
|
Call nodeSpinOnce() continuously |
Lua synopsis |
simB0.spin(string handle)
|
Lua parameters |
handle (string): the node handle |
Lua return values |
- |
See also
|
|
simB0.subscriberCreate
simB0.subscriberDestroy
Script functions
Script functions are used to call some lua code from the plugin side (tipically used for event handlers).
topicCallback
Description
|
Callback for a subscriber. |
Lua synopsis |
simB0.topicCallback(string payload)
|
Lua parameters |
payload (string): raw payload |
Lua return values |
- |
See also
|
|
serviceCallback
Description
|
Callback for a service server. |
Lua synopsis |
string payload=simB0.serviceCallback(string payload)
|
Lua parameters |
payload (string): raw request payload |
Lua return values |
payload (string): raw response payload |
See also
|
|
|