remove

Clears a typed channel flag.

Function

Synopsis

channel_flags:remove( flag )

Arguments

ChannelFlag flag
A constant from mux.comsys.flags.

Returns

boolean changed
true when the flag was cleared and false when it was already clear.

Raises

  • mux.unavailable.checking during @lua/check.
  • mux.channel.invalid if the originating channel was destroyed.
  • mux.channel_flag.invalid if flag is not a typed constant from this Lua runtime.

Notes

Flag changes take effect immediately and are not part of the Lua State transaction.

See Also