Add doc

relay/server/server.go

@@ -13,16 +13,27 @@ import (
 	"github.com/netbirdio/netbird/relay/server/listener/ws"
 )
 
+// ListenerConfig is the configuration for the listener.
+// Address: the address to bind the listener to. It could be an address behind a reverse proxy.
+// TLSConfig: the TLS configuration for the listener.
 type ListenerConfig struct {
 	Address   string
 	TLSConfig *tls.Config
 }
 
+// Server is the main entry point for the relay server.
+// It is the gate between the WebSocket listener and the Relay server logic.
+// In a new HTTP connection, the server will accept the connection and pass it to the Relay server via the Accept method.
 type Server struct {
 	relay      *Relay
 	wSListener listener.Listener
 }
 
+// NewServer creates a new relay server instance.
+// meter: the OpenTelemetry meter
+// exposedAddress: this address will be used as the instance URL. It should be a domain:port format.
+// tlsSupport: if true, the server will support TLS
+// authValidator: the auth validator to use for the server
 func NewServer(meter metric.Meter, exposedAddress string, tlsSupport bool, authValidator auth.Validator) (*Server, error) {
 	relay, err := NewRelay(meter, exposedAddress, tlsSupport, authValidator)
 	if err != nil {
@@ -33,6 +44,7 @@ func NewServer(meter metric.Meter, exposedAddress string, tlsSupport bool, authV
 	}, nil
 }
 
+// Listen starts the relay server.
 func (r *Server) Listen(cfg ListenerConfig) error {
 	r.wSListener = &ws.Listener{
 		Address:   cfg.Address,
@@ -47,6 +59,8 @@ func (r *Server) Listen(cfg ListenerConfig) error {
 	return wslErr
 }
 
+// Close stops the relay server. If there are active connections, they will be closed gracefully. In case of a timeout,
+// the connections will be forcefully closed.
 func (r *Server) Close() (err error) {
 	// stop service new connections
 	if r.wSListener != nil {
@@ -60,6 +74,7 @@ func (r *Server) Close() (err error) {
 	return
 }
 
+// InstanceURL returns the instance URL of the relay server.
 func (r *Server) InstanceURL() string {
 	return r.relay.instanceURL
 }