mirror of
https://github.com/taigrr/go-fastping
synced 2025-01-18 05:03:15 -08:00
Add documents
This commit is contained in:
parent
d1ac219a65
commit
ee8935c046
@ -200,10 +200,13 @@ func (p *Pinger) RunLoop() {
|
|||||||
go p.run(false)
|
go p.run(false)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Return a channel that is closed when RunLoop() is stopped by an error or
|
||||||
|
// Stop(). It must be called after RunLoop() call. If not, it causes panic.
|
||||||
func (p *Pinger) Done() <-chan bool {
|
func (p *Pinger) Done() <-chan bool {
|
||||||
return p.ctx.done
|
return p.ctx.done
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Stop RunLoop(). It must be called after RunLoop(). If not, it causes panic.
|
||||||
func (p *Pinger) Stop() {
|
func (p *Pinger) Stop() {
|
||||||
p.debugln("Stop(): close(p.ctx.stop)")
|
p.debugln("Stop(): close(p.ctx.stop)")
|
||||||
close(p.ctx.stop)
|
close(p.ctx.stop)
|
||||||
@ -211,6 +214,8 @@ func (p *Pinger) Stop() {
|
|||||||
<-p.ctx.done
|
<-p.ctx.done
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Return an error that is set by RunLoop(). It must be called after RunLoop().
|
||||||
|
// If not, it causes panic.
|
||||||
func (p *Pinger) Err() error {
|
func (p *Pinger) Err() error {
|
||||||
return p.ctx.err
|
return p.ctx.err
|
||||||
}
|
}
|
||||||
|
Loading…
x
Reference in New Issue
Block a user