mux.comsys on StompyMUX Documentation

mux.comsys.flags

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

mux.comsys.flags contains immutable typed constants accepted by ChannelFlags:

Constant	Native behavior
`PUBLIC`	Makes the channel visible without a successful join lock.
`LOUD`	Announces applicable connection and presence changes.
`TRANSPARENT`	Relaxes hidden-member filtering in native channel displays.

Constants compare by identity within the current Lua runtime and render as their uppercase names. Unknown constants, raw strings, and constants from another runtime raise mux.channel_flag.invalid.

channel

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

Retrieves an existing communication channel by name.

Function

Synopsis

mux.comsys.channel( name )

Arguments

string name: An existing channel name without embedded NUL bytes. Lookup is case-insensitive.

Returns

Channel channel: A live handle for the channel. Channel:name() returns its canonical spelling.

Raises

mux.unavailable.checking during @lua/check.
mux.arg.invalid when the name contains an embedded NUL byte.
mux.channel.invalid when the channel does not exist.

Example

local public = mux.comsys.channel("Public")

create_channel

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

Creates a private communication channel using the native channel-name rules.

Function

Synopsis

mux.comsys.create_channel( name )

Arguments

string name: A non-empty printable ASCII name without spaces, shorter than 50 bytes.

Returns

Channel channel: A handle for the newly created channel.

Raises

mux.unavailable.checking during @lua/check.
mux.arg.invalid for an invalid name, including an embedded NUL byte.
mux.channel.invalid when a channel with the same name already exists.

Example

local staff = mux.comsys.create_channel("Staff")
staff:flags():add(mux.comsys.flags.PUBLIC)

destroy_channel

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

Permanently removes a live communication channel and its membership storage.

Function

Synopsis

mux.comsys.destroy_channel( channel )

Arguments

Channel channel: A live channel handle.

Returns

Nothing.

Raises

mux.unavailable.checking during @lua/check.
mux.channel.invalid when the channel handle is stale.

Notes

The supplied handle and every ChannelFlags handle derived from it become stale. A later channel created with the same name does not revive them.

Example

local staff = mux.comsys.create_channel("Staff")
mux.comsys.destroy_channel(staff)

list_channels

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

Lists every live communication channel in deterministic name order.

Function

Synopsis

mux.comsys.list_channels( )

Arguments

None.

Returns

Channel[] channels: A dense array of channel handles sorted case-insensitively by name, with the original spelling as the tie-breaker.

Raises

mux.unavailable.checking during @lua/check.
mux.internal if the native registry count changes while the channel list is copied.

Example

for _, channel in ipairs(mux.comsys.list_channels()) do
 mux.log("channels.log", channel:name())
end

mux.comsys on StompyMUX Documentation

mux.comsys.flags

See Also

channel

Function

Synopsis

Arguments

Returns

Raises

Example

See Also

create_channel

Function

Synopsis

Arguments

Returns

Raises

Example

See Also

destroy_channel

Function

Synopsis

Arguments

Returns

Raises

Notes

Example

See Also

list_channels

Function

Synopsis

Arguments

Returns

Raises

Example

See Also