AP_Scripting: docs update

This commit is contained in:
Andrew Tridgell 2024-09-29 14:06:45 +10:00
parent 3bbde7c302
commit b6f20e3786
1 changed files with 21 additions and 1 deletions

View File

@ -517,10 +517,20 @@ function motor_factor_table_ud:roll(index, value) end
local SocketAPM_ud = {} local SocketAPM_ud = {}
-- Get a new socket -- Get a new socket
---@param datagram boolean ---@param datagram integer -- set to 1 for UDP, 0 for TCP
---@return SocketAPM_ud ---@return SocketAPM_ud
function Socket(datagram) end function Socket(datagram) end
-- return an IPv4 address given a string
---@param str_address string -- ipv4 address as string
---@return uint32_t_ud -- ipv4 address
function string_to_ipv4_addr(str_address) end
-- return a string representation of ipv4 address
---@param addr uint32_t_ud|integer|number -- ipv4 address
---@return string -- string representation of address
function ipv4_addr_to_string(addr) end
-- return true if a socket is connected -- return true if a socket is connected
---@return boolean ---@return boolean
function SocketAPM_ud:is_connected() end function SocketAPM_ud:is_connected() end
@ -541,6 +551,14 @@ function SocketAPM_ud:listen(backlog) end
---@return integer ---@return integer
function SocketAPM_ud:send(str, len) end function SocketAPM_ud:send(str, len) end
-- send a lua string to a specified address. May contain binary data
---@param str string
---@param len uint32_t_ud|integer|number
---@param ipaddr uint32_t_ud|integer|number -- ipv4 address
---@param port integer -- ipv4 port
---@return integer
function SocketAPM_ud:sendto(str, len, ipaddr, port) end
-- bind to an address. Use "0.0.0.0" for wildcard bind -- bind to an address. Use "0.0.0.0" for wildcard bind
---@param IP_address string ---@param IP_address string
---@param port integer ---@param port integer
@ -562,6 +580,8 @@ function SocketAPM_ud:accept() end
-- receive data from a socket -- receive data from a socket
---@param length integer ---@param length integer
---@return string|nil ---@return string|nil
---@return uint32_t_ud|nil -- source IP
---@return integer|nil -- source port
function SocketAPM_ud:recv(length) end function SocketAPM_ud:recv(length) end
-- check for available input -- check for available input