VoxelEngine/doc/en/scripting/builtins/libnetwork.md

network library

A library for working with the network.

HTTP requests

-- Performs a GET request to the specified URL.
network.get(
    url: str,
    -- Function to call when response is received
    callback: function(str),
    -- Error handler
    [optional] onfailure: function(int, str),
    -- List of additional request headers
    [optional] headers: table<str>
)

-- Example:
network.get("https://api.github.com/repos/MihailRis/VoxelEngine-Cpp/releases/latest", function (s)
    print(json.parse(s).name) -- will output the name of the latest engine release
end)

-- A variant for binary files, with a byte array instead of a string in the response.
network.get_binary(
    url: str,
    callback: function(ByteArray),
    [optional] onfailure: function(int, str),
    [optional] headers: table<str>
)

-- Performs a POST request to the specified URL.
-- Currently, only `Content-Type: application/json` is supported
-- After receiving the response, passes the text to the callback function.
-- In case of an error, the HTTP response code will be passed to onfailure.
network.post(
    url: str,
    -- Request body as a table (will be converted to JSON) or string
    body: table|str,
    -- Function called when response is received
    callback: function(str),
    -- Error handler
    [optional] onfailure: function(int, str),
    -- List of additional request headers
    [optional] headers: table<str>
)

TCP Connections

network.tcp_connect(
    -- Address
    address: str,
    -- Port
    port: int,
    -- Function called upon successful connection
    -- Sending will not work before connection
    -- Socket is passed as the only argument
    callback: function(Socket),
    -- Function called when a connection error occurs
    -- Arguments passed: socket and error text
    [optional] error_callback: function(Socket, str)
) --> Socket

Initiates TCP connection.

The Socket class has the following methods:

-- Sends a byte array
socket:send(table|ByteArray|str)

-- Reads the received data
socket:recv(
    -- Maximum size of the byte array to read
    length: int,
    -- Use table instead of Bytearray
    [optional] usetable: bool=false
) -> nil|table|Bytearray
-- Returns nil on error (socket is closed or does not exist).
-- If there is no data yet, returns an empty byte array.

-- Closes the connection
socket:close()

-- Returns the number of data bytes available for reading
socket:available() --> int

-- Checks that the socket exists and is not closed.
socket:is_alive() --> bool

-- Checks if the connection is present (using socket:send(...) is available).
socket:is_connected() --> bool

-- Returns the address and port of the connection.
socket:get_address() --> str, int

-- Opens a TCP server.
network.tcp_open(
    -- Port
    port: int,
    -- Function called when connecting
    -- The socket of the connected client is passed as the only argument
    callback: function(Socket)
) --> ServerSocket

The SocketServer class has the following methods:

-- Closes the server, breaking connections with clients.
server:close()

-- Checks if the TCP server exists and is open.
server:is_open() --> bool

-- Returns the server port.
server:get_port() --> int

Analytics

-- Returns the approximate amount of data sent (including connections to localhost)
-- in bytes.
network.get_total_upload() --> int
-- Returns the approximate amount of data received (including connections to localhost)
-- in bytes.
network.get_total_download() --> int

Other

-- Looks for a free port to use.
network.find_free_port() --> int or nil