Version 3.0.0-beta cleaned

config/websocket.go

@@ -0,0 +1,78 @@
+package config
+
+import (
+	"time"
+
+	"github.com/imdario/mergo"
+)
+
+// Currently only these 5 values are used for real
+const (
+	// DefaultWriteTimeout 10 * time.Second
+	DefaultWriteTimeout = 10 * time.Second
+	// DefaultPongTimeout 60 * time.Second
+	DefaultPongTimeout = 60 * time.Second
+	// DefaultPingPeriod (DefaultPongTimeout * 9) / 10
+	DefaultPingPeriod = (DefaultPongTimeout * 9) / 10
+	// DefaultMaxMessageSize 1024
+	DefaultMaxMessageSize = 1024
+)
+
+//
+
+// Websocket the config contains options for 'websocket' package
+type Websocket struct {
+	// WriteTimeout time allowed to write a message to the connection.
+	// Default value is 10 * time.Second
+	WriteTimeout time.Duration
+	// PongTimeout allowed to read the next pong message from the connection
+	// Default value is 60 * time.Second
+	PongTimeout time.Duration
+	// PingPeriod send ping messages to the connection with this period. Must be less than PongTimeout
+	// Default value is (PongTimeout * 9) / 10
+	PingPeriod time.Duration
+	// MaxMessageSize max message size allowed from connection
+	// Default value is 1024
+	MaxMessageSize int
+	// Endpoint is the path which the websocket server will listen for clients/connections
+	// Default value is empty string, if you don't set it the Websocket server is disabled.
+	Endpoint string
+	// Headers  the response headers before upgrader
+	// Default is empty
+	Headers map[string]string
+}
+
+// DefaultWebsocket returns the default config for iris-ws websocket package
+func DefaultWebsocket() Websocket {
+	return Websocket{
+		WriteTimeout:   DefaultWriteTimeout,
+		PongTimeout:    DefaultPongTimeout,
+		PingPeriod:     DefaultPingPeriod,
+		MaxMessageSize: DefaultMaxMessageSize,
+		Headers:        make(map[string]string, 0),
+		Endpoint:       "",
+	}
+}
+
+// Merge merges the default with the given config and returns the result
+func (c Websocket) Merge(cfg []Websocket) (config Websocket) {
+
+	if len(cfg) > 0 {
+		config = cfg[0]
+		mergo.Merge(&config, c)
+	} else {
+		_default := c
+		config = _default
+	}
+
+	return
+}
+
+// MergeSingle merges the default with the given config and returns the result
+func (c Websocket) MergeSingle(cfg Websocket) (config Websocket) {
+
+	config = cfg
+	mergo.Merge(&config, c)
+
+	return
+}