status-go/vendor/github.com/pion/webrtc/v3/gathering_complete_promise.go

25 lines
1.1 KiB
Go

package webrtc
import (
"context"
)
// GatheringCompletePromise is a Pion specific helper function that returns a channel that is closed when gathering is complete.
// This function may be helpful in cases where you are unable to trickle your ICE Candidates.
//
// It is better to not use this function, and instead trickle candidates. If you use this function you will see longer connection startup times.
// When the call is connected you will see no impact however.
func GatheringCompletePromise(pc *PeerConnection) (gatherComplete <-chan struct{}) {
gatheringComplete, done := context.WithCancel(context.Background())
// It's possible to miss the GatherComplete event since setGatherCompleteHandler is an atomic operation and the
// promise might have been created after the gathering is finished. Therefore, we need to check if the ICE gathering
// state has changed to complete so that we don't block the caller forever.
pc.setGatherCompleteHandler(func() { done() })
if pc.ICEGatheringState() == ICEGatheringStateComplete {
done()
}
return gatheringComplete.Done()
}