Skip to main content
Version: 9.0.2

gre.greio_disconnect

gre.greio_disconnect(
channel,
[is_receive_channel]
)

This function forces any cached Storyboard IO channel connections to the specified channel to be closed. Subsequent calls using the same channel name will re-establish the connection to the channel if required.

Parameters

ParameterTypeDescription
channel#stringThe channel that is to be disconnected.
is_receiving#booleanAn optional boolean parameter. True if closing a receiving channel. False or no argument if closing a sending channel.

Example

-- Send an event to a custom channel
gre.send_event("StoryboardRocks", "my_channel")
-- Close the cached connection to that channel
gre.greio_disconnect("my_channel")