diff --git a/http_server.go b/http_server.go index 094c43b..eea0d90 100644 --- a/http_server.go +++ b/http_server.go @@ -10,6 +10,9 @@ import ( ) // HTTPServer owns the health endpoint listener and server. +// +// server, err := service.ServeHTTPHealth("127.0.0.1", 5554) +// defer func() { _ = server.Close() }() type HTTPServer struct { listener net.Listener server *http.Server diff --git a/serve.go b/serve.go index 0be39f6..e456290 100644 --- a/serve.go +++ b/serve.go @@ -11,7 +11,10 @@ import ( const dnsTTL = 300 -// DNSServer handles a live UDP+TCP DNS endpoint and owns listener resources. +// DNSServer owns the UDP+TCP DNS listeners returned by Serve. +// +// srv, err := service.Serve("127.0.0.1", 53) +// defer func() { _ = srv.Close() }() type DNSServer struct { udpListener net.PacketConn tcpListener net.Listener @@ -20,6 +23,9 @@ type DNSServer struct { } // ServiceRuntime owns the DNS and HTTP listeners created by ServeAll. +// +// runtime, err := service.ServeAll("127.0.0.1", 53, 5554) +// defer func() { _ = runtime.Close() }() type ServiceRuntime struct { DNS *DNSServer HTTP *HTTPServer