BanchoBot.tryWaitForTopic

Waits for an event or returns one which is in the backlog already. Removes matching backlog entries.

bool tryWaitForMessage(bool delegate(Message) @(safe) nothrow check, Duration timeout, Message result)
bool tryWaitForQuit(bool delegate(Quit) @(safe) nothrow check, Duration timeout, Quit result)
bool tryWaitForTopic(bool delegate(TopicChange) @(safe) nothrow check, Duration timeout, TopicChange result)
class BanchoBot
version(D_Ddoc)
nothrow
bool
tryWaitForTopic
(
bool delegate
(
TopicChange
)
@safe nothrow check
,
Duration timeout
,
out TopicChange result
)
bool tryWaitForMembership(bool delegate(MembershipEvent) @(safe) nothrow check, Duration timeout, MembershipEvent result)
Message waitForMessage(bool delegate(Message) @(safe) nothrow check, Duration timeout)
Quit waitForQuit(bool delegate(Quit) @(safe) nothrow check, Duration timeout)
TopicChange waitForTopic(bool delegate(TopicChange) @(safe) nothrow check, Duration timeout)
MembershipEvent waitForMembership(bool delegate(MembershipEvent) @(safe) nothrow check, Duration timeout)

Parameters

check bool delegate ( TopicChange ) @safe nothrow: a delegate checking for which object to check for. Return true to return this object & not add it to the backlog.
timeout Duration: the timeout after which to interrupt the waiting task

Return Value

Type: bool

boolean if something was found within timeout (for try- prefix) or the result (for non try- prefix)

Throws

WaitTimeoutException on timeout (for non try- prefix)

Meta

Source

See Implementation