ModApiHttp Class Reference

#include <l_http.h>

Inheritance diagram for ModApiHttp:

Collaboration diagram for ModApiHttp:

Static Public Member Functions
static void	Initialize (lua_State *L, int top)
static void	InitializeAsync (lua_State *L, int top)
Static Public Member Functions inherited from ModApiBase
static ScriptApiBase *	getScriptApiBase (lua_State *L)
static Server *	getServer (lua_State *L)
static ServerInventoryManager *	getServerInventoryMgr (lua_State *L)
static EmergeThread *	getEmergeThread (lua_State *L)
static IGameDef *	getGameDef (lua_State *L)
static Environment *	getEnv (lua_State *L)
static std::string	getCurrentModPath (lua_State *L)
template<typename T>
static T *	getScriptApi (lua_State *L)
static bool	registerFunction (lua_State *L, const char *name, lua_CFunction func, int top)
template<typename T>
static void	registerClass (lua_State *L, const luaL_Reg *methods, const luaL_Reg *metamethods)
template<typename T>
static T *	checkObject (lua_State *L, int narg)
static int	l_deprecated_function (lua_State *L, const char *good, const char *bad, lua_CFunction func)
	A wrapper for deprecated functions.

Static Private Member Functions
static void	read_http_fetch_request (lua_State *L, HTTPFetchRequest &req)
static void	push_http_fetch_result (lua_State *L, HTTPFetchResult &res, bool completed=true)
static int	l_http_fetch_sync (lua_State *L)
static int	l_http_fetch_async (lua_State *L)
static int	l_http_fetch_async_get (lua_State *L)
static int	l_request_http_api (lua_State *L)
static int	l_get_http_api (lua_State *L)
static int	l_set_http_api_lua (lua_State *L)

Additional Inherited Members
Protected Member Functions inherited from LuaHelper
template<>
bool	readParam (lua_State *L, int index)
template<>
s16	readParam (lua_State *L, int index)
template<>
int	readParam (lua_State *L, int index)
template<>
float	readParam (lua_State *L, int index)
template<>
v2s16	readParam (lua_State *L, int index)
template<>
v2f	readParam (lua_State *L, int index)
template<>
v3f	readParam (lua_State *L, int index)
template<>
std::string_view	readParam (lua_State *L, int index)
template<>
std::string	readParam (lua_State *L, int index)
template<>
std::string_view	readParam (lua_State *L, int index)
	Read a string from Lua state L at index without copying it.
Static Protected Member Functions inherited from LuaHelper
template<typename T>
static T	readParam (lua_State *L, int index)
	Read a value using a template type T from Lua state L at index.
template<typename T>
static T	readParam (lua_State *L, int index, const T &default_value)
	Read a value using a template type T from Lua state L at index.
static bool	geti (lua_State *L, int table, int i)
	Utility for list iteration.
template<typename F>
static void	for_ipairs (lua_State *L, int table, const F &f)
	Iterate values t[1], t[2], ... of the given table in order.

Member Function Documentation

Initialize()

void ModApiHttp::Initialize ( lua_State * L, int top )

static

References API_FCT.

Referenced by ServerScripting::InitializeModApi(), and MainMenuScripting::initializeModApi().

Here is the caller graph for this function:

InitializeAsync()

void ModApiHttp::InitializeAsync ( lua_State * L, int top )

static

References API_FCT.

Referenced by MainMenuScripting::initializeModApi().

Here is the caller graph for this function:

l_get_http_api()

int ModApiHttp::l_get_http_api ( lua_State * L )

staticprivate

References HTTP_API, and NO_MAP_LOCK_REQUIRED.

l_http_fetch_async()

int ModApiHttp::l_http_fetch_async ( lua_State * L )

staticprivate

References HTTPFetchRequest::caller, httpfetch_async(), infostream, NO_MAP_LOCK_REQUIRED, read_http_fetch_request(), and HTTPFetchRequest::url.

Here is the call graph for this function:

l_http_fetch_async_get()

int ModApiHttp::l_http_fetch_async_get ( lua_State * L )

staticprivate

References httpfetch_async_get(), NO_MAP_LOCK_REQUIRED, and push_http_fetch_result().

Here is the call graph for this function:

l_http_fetch_sync()

int ModApiHttp::l_http_fetch_sync ( lua_State * L )

staticprivate

References httpfetch_sync_interruptible(), infostream, NO_MAP_LOCK_REQUIRED, push_http_fetch_result(), read_http_fetch_request(), and HTTPFetchRequest::url.

Here is the call graph for this function:

l_request_http_api()

int ModApiHttp::l_request_http_api ( lua_State * L )

staticprivate

References ScriptApiSecurity::checkWhitelisted(), CUSTOM_RIDX_HTTP_API_LUA, HTTP_API, and NO_MAP_LOCK_REQUIRED.

Here is the call graph for this function:

l_set_http_api_lua()

int ModApiHttp::l_set_http_api_lua ( lua_State * L )

staticprivate

References CUSTOM_RIDX_HTTP_API_LUA, and NO_MAP_LOCK_REQUIRED.

push_http_fetch_result()

void ModApiHttp::push_http_fetch_result ( lua_State * L, HTTPFetchResult & res, bool completed = true )

staticprivate

References HTTPFetchResult::data, HTTPFetchResult::response_code, setboolfield(), setintfield(), setstringfield(), HTTPFetchResult::succeeded, and HTTPFetchResult::timeout.

Referenced by l_http_fetch_async_get(), and l_http_fetch_sync().

Here is the call graph for this function:

Here is the caller graph for this function:

read_http_fetch_request()

void ModApiHttp::read_http_fetch_request ( lua_State * L, HTTPFetchRequest & req )

staticprivate

References HTTPFetchRequest::caller, es_HttpMethod, HTTPFetchRequest::extra_headers, HTTPFetchRequest::fields, LuaHelper::for_ipairs(), getboolfield_default(), getfloatfield(), getstringfield(), HTTP_POST, httpfetch_caller_alloc_secure(), HTTPFetchRequest::method, HTTPFetchRequest::multipart, HTTPFetchRequest::quiet, HTTPFetchRequest::raw_data, LuaHelper::readParam(), string_to_enum(), HTTPFetchRequest::timeout, HTTPFetchRequest::url, and HTTPFetchRequest::useragent.

Referenced by l_http_fetch_async(), and l_http_fetch_sync().

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• script/lua_api/l_http.h
• script/lua_api/l_http.cpp