From de61d7bb8dd2ccc5188d0d97d5c307aab172d2d8 Mon Sep 17 00:00:00 2001
From: David Fifield <david@bamsoftware.com>
Date: Sat, 21 Sep 2024 18:27:35 +0000
Subject: [PATCH] Document relayURL return in SignalingServer.pollOffer.

The second return value was added in
863a8296e85ae467aa3855ab85f6f990f9cb40e5.
---
 proxy/lib/snowflake.go | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/proxy/lib/snowflake.go b/proxy/lib/snowflake.go
index 809a6cb..8e75b3f 100644
--- a/proxy/lib/snowflake.go
+++ b/proxy/lib/snowflake.go
@@ -232,7 +232,7 @@ func (s *SignalingServer) Post(path string, payload io.Reader) ([]byte, error) {
 }
 
 // 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) {
 	brokerPath := s.url.ResolveReference(&url.URL{Path: "proxy"})