README
¶
qu
simple channels that act as breakers or momentary one-shot triggers.
can enable logging to get detailed information on channel state, and channels do not panic if closed channels are attempted to be closed or signalled with.
provides a neat function based syntax for usage.
wait function does require use of the <- receive operator prefix to be used in
a select statement.
usage
creating channels:
unbuffered
newSigChan := qu.T()
buffered
newBufferedSigChan := qu.Ts(5)
closing
newSigChan.Q()
signalling
newBufferedSigChan.Signal()
logging features
numberOpenUnbufferedChannels := GetOpenUnbufferedChanCount()
numberOpenBufferedChannels := GetOpenBufferedChanCount()
print a list of closed and open channels known by qu:
PrintChanState()
garbage collection
this library automatically cleans up closed channels once a minute to free resources that have become unused.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetOpenBufferedChanCount ¶
func GetOpenBufferedChanCount() (o no)
GetOpenBufferedChanCount returns the number of qu channels that are still open
func GetOpenUnbufferedChanCount ¶
func GetOpenUnbufferedChanCount() (o no)
GetOpenUnbufferedChanCount returns the number of qu channels that are still open
func PrintChanState ¶
func PrintChanState()
PrintChanState creates an output showing the current state of the channels being monitored This is a function for use by the programmer while debugging
Types ¶
type C ¶
type C chan struct{}
C is your basic empty struct signalling channel
func T ¶
func T() C
T creates an unbuffered chan struct{} for trigger and quit signalling (momentary and breaker switches)
func Ts ¶
func Ts(n no) C
Ts creates a buffered chan struct{} which is specifically intended for signalling without blocking, generally one is the size of buffer to be used, though there might be conceivable cases where the channel should accept more signals without blocking the caller
func (C) IsClosed ¶
func (c C) IsClosed() bo
IsClosed exposes a test to see if the channel is closed
func (C) Q ¶
func (c C) Q()
Q closes the channel, which makes it emit a nil every time it is selected.
Source Files