Document relayURL return in SignalingServer.pollOffer.

The second return value was added in
863a8296e8.
This commit is contained in:
David Fifield 2024-09-21 18:27:35 +00:00
parent 0f0f118827
commit de61d7bb8d

View file

@ -232,7 +232,7 @@ func (s *SignalingServer) Post(path string, payload io.Reader) ([]byte, error) {
} }
// pollOffer communicates the proxy's capabilities with broker // pollOffer communicates the proxy's capabilities with broker
// and retrieves a compatible SDP offer // and retrieves a compatible SDP offer and relay URL.
func (s *SignalingServer) pollOffer(sid string, proxyType string, acceptedRelayPattern string, pollInterval time.Duration, shutdown chan struct{}) (*webrtc.SessionDescription, string) { func (s *SignalingServer) pollOffer(sid string, proxyType string, acceptedRelayPattern string, pollInterval time.Duration, shutdown chan struct{}) (*webrtc.SessionDescription, string) {
brokerPath := s.url.ResolveReference(&url.URL{Path: "proxy"}) brokerPath := s.url.ResolveReference(&url.URL{Path: "proxy"})