update docs

This commit is contained in:
aler9
2021-11-28 12:30:28 +01:00
parent 1876546d05
commit a5d0128654
2 changed files with 5 additions and 4 deletions

View File

@@ -150,8 +150,9 @@ type Client struct {
// disable being redirected to other servers, that can happen during Describe(). // disable being redirected to other servers, that can happen during Describe().
// It defaults to false. // It defaults to false.
RedirectDisable bool RedirectDisable bool
// enable communication with servers which don't provide server ports. // enable communication with servers which don't provide server ports or use
// this can be a security issue. // different server ports than the ones announced.
// This can be a security issue.
// It defaults to false. // It defaults to false.
AnyPortEnable bool AnyPortEnable bool
// the stream transport (UDP, Multicast or TCP). // the stream transport (UDP, Multicast or TCP).
@@ -417,7 +418,7 @@ func (c *Client) Close() error {
} }
// Wait waits until all client resources are closed. // Wait waits until all client resources are closed.
// This can happen when a read error occurs or when Close() is called. // This can happen when a fatal error occurs or when Close() is called.
func (c *Client) Wait() error { func (c *Client) Wait() error {
<-c.done <-c.done
return c.closeError return c.closeError

View File

@@ -312,7 +312,7 @@ func (s *Server) Start() error {
return nil return nil
} }
// Close closes all the server resources and waits for the to close. // Close closes all the server resources and waits for them to close.
func (s *Server) Close() error { func (s *Server) Close() error {
s.ctxCancel() s.ctxCancel()
s.wg.Wait() s.wg.Wait()