quit

Disconnects from the server, optionally with a quit reason.

void
quit
(,
const string reason = string.init
,,
const string caller = __FUNCTION__
)

Parameters

state IRCPluginState

The current plugin's IRCPluginState, via which to send messages to the server.

reason string

Optionally, the reason for quitting.

properties Message.Property

Custom message properties, such as Message.Property.quiet and Message.Property.forced.

caller string

String name of the calling function, or something else that gives context.

Examples

IRCPluginState state;
state.mainThread = thisTid;

enum properties = Message.Property.quiet;
quit(state, "reason", properties);

receive(
    (Message m)
    {
        with (m.event)
        {
            assert((type == IRCEvent.Type.QUIT), Enum!(IRCEvent.Type).toString(type));
            assert((content == "reason"), content);
            assert(m.caller.length);
            assert(m.properties & (Message.Property.forced | Message.Property.priority | Message.Property.quiet));
        }
    }
);

Meta