document Wrapper

mastercactapus · mastercactapus · commit 3a92c8137aa1 · 2020-09-23T17:35:37.000-05:00
diff --git a/wrapper.go b/wrapper.go
@@ -9,6 +9,7 @@ import (
 	"github.com/mastercactapus/proxyprotocol"
 )
 
+// Wrapper provides PROXY protocol support to Caddy by implementing the caddy.ListenerWrapper interface. It must be loaded before the `tls` listener.
 type Wrapper struct {
 	// Timeout specifies an optional maximum time for the PROXY header to be received. If zero, timeout is disabled. Default is 5s.
 	Timeout caddy.Duration `json:"timeout,omitempty"`

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ import (`
`9`	`9`	`"github.com/mastercactapus/proxyprotocol"`
`10`	`10`	`)`
`11`	`11`
	`12`	+// Wrapper provides PROXY protocol support to Caddy by implementing the caddy.ListenerWrapper interface. It must be loaded before the `tls` listener.
`12`	`13`	`type Wrapper struct {`
`13`	`14`	`// Timeout specifies an optional maximum time for the PROXY header to be received. If zero, timeout is disabled. Default is 5s.`
`14`	`15`	Timeout caddy.Duration `json:"timeout,omitempty"`