Auxiliary API

Detailed Description

Optional bindings implemented in xrc/lua and declared in inc/lxrc.h.

Installation functions require an initialized BAS Lua state and ownership of its server mutex. Install during startup, before application scripts. They return no C value; Lua allocation errors follow the Lua error mechanism.

Collaboration diagram for Auxiliary API:

Modules
	The Lua Thread Library
	See Advanced Lua Bindings, section Calling Lua Code Asynchronously From C Code for how to use this class.

Functions
void	balua_forkpty (lua_State *L)
	Install the forkpty Lua bindings. More...
void	balua_http (lua_State *L)
	Install the httpc Lua bindings. More...
void	balua_luaio (lua_State *L)
	Install the LuaIo Lua bindings. More...
void	balua_sharkssl (lua_State *L)
	Install the SharkSSL Lua bindings. More...
void	balua_socket (lua_State *L)
	Install the socket Lua bindings. More...
void	balua_relsocket (lua_State *L)
	Notify registered coroutine sockets that the server is shutting down. More...
void	balua_crypto (lua_State *L)
	Install the crypto Lua bindings. More...
void	balua_tracelogger (lua_State *L, struct LThreadMgr *tmgr)
	Install the TraceLogger Lua bindings. More...

Function Documentation

balua_crypto()

void balua_crypto

(

lua_State *

L

)

Install the crypto Lua bindings.

Parameters

L	Required initialized BAS Lua state; borrowed for the call.

balua_forkpty()

void balua_forkpty

(

lua_State *

L

)

Install the forkpty Lua bindings.

Parameters

L	Required initialized BAS Lua state; borrowed for the call.

balua_http()

void balua_http

(

lua_State *

L

)

Install the httpc Lua bindings.

Parameters

L	Required initialized BAS Lua state; borrowed for the call.

balua_luaio()

void balua_luaio

(

lua_State *

L

)

Install the LuaIo Lua bindings.

Parameters

L	Required initialized BAS Lua state; borrowed for the call.

balua_relsocket()

void balua_relsocket

(

lua_State *

L

)

Notify registered coroutine sockets that the server is shutting down.

Parameters

L	Required initialized BAS Lua state with the server mutex held. Pending socket operations resume with E_SYS_SHUTDOWN. Lua callbacks may run before this function returns. Call before closing the VM; this function neither closes the VM nor waits for all application work to finish.

balua_sharkssl()

void balua_sharkssl

(

lua_State *

L

)

Install the SharkSSL Lua bindings.

Parameters

L	Required initialized BAS Lua state; borrowed for the call.

balua_socket()

void balua_socket

(

lua_State *

L

)

Install the socket Lua bindings.

Parameters

L	Required initialized BAS Lua state; borrowed for the call.

balua_tracelogger()

void balua_tracelogger	(	lua_State *	L,
		struct LThreadMgr *	tmgr
	)

Install the TraceLogger Lua bindings.

Parameters

L	Required initialized BAS Lua state with its mutex held.
tmgr	Borrowed manager, required for trlogger:onclient(cb); otherwise NULL is allowed. Keep it alive while the logger can schedule jobs.