environment_get

Mon, 01 Jan 0001 00:00:00 +0000

Gets an RFC 1572 NEW-ENVIRON variable from a live connection.

Function

Synopsis

mux.telnet.environment_get( descriptor, kind, name )

Arguments

number descriptor: A live descriptor ID, normally ctx.descriptor.
string kind: Either "var" or "uservar".
string name: The binary-safe variable name.

Returns

string or nil value: The binary-safe value, or nil when the variable is absent.

Examples

if mux.telnet.environment_has(ctx.descriptor, "var", "USER") then
 local user = mux.telnet.environment_get(ctx.descriptor, "var", "USER")
end

Notes

A defined empty value returns "". The two kinds are distinct namespaces and all received data is untrusted. An invalid descriptor or kind raises an error; this function is unavailable during @lua/check.

environment_has

Mon, 01 Jan 0001 00:00:00 +0000

Tests whether an RFC 1572 NEW-ENVIRON variable is defined on a live connection.

Function

Synopsis

mux.telnet.environment_has( descriptor, kind, name )

Arguments

number descriptor: A live descriptor ID, normally ctx.descriptor.
string kind: Either "var" or "uservar".
string name: The binary-safe variable name.

Returns

boolean defined: Whether the variable is present, including with an empty value.

Notes

The two kinds are distinct namespaces. Client-provided names and values are untrusted input. An invalid descriptor or kind raises an error; this function is unavailable during @lua/check.

mux.telnet package on StompyMUX Documentation

environment_get

Function

Synopsis

Arguments

Returns

Examples

Notes

environment_has

Function

Synopsis

Arguments

Returns

Notes