Add More Examples & Categorized in Folders & TOC

Former-commit-id: ce4d711a75a4ba08ffab075e6baa88724725885b

_examples/examples/intermediate/websockets/connectionlist/main.go

@@ -0,0 +1,113 @@
+package main
+
+import (
+	"fmt"
+	"sync"
+	"time"
+
+	"gopkg.in/kataras/iris.v6"
+	"gopkg.in/kataras/iris.v6/adaptors/httprouter"
+	"gopkg.in/kataras/iris.v6/adaptors/view"
+	"gopkg.in/kataras/iris.v6/adaptors/websocket"
+)
+
+type clientPage struct {
+	Title string
+	Host  string
+}
+
+func main() {
+	app := iris.New()
+	app.Adapt(iris.DevLogger())                  // enable all (error) logs
+	app.Adapt(httprouter.New())                  // select the httprouter as the servemux
+	app.Adapt(view.HTML("./templates", ".html")) // select the html engine to serve templates
+
+	ws := websocket.New(websocket.Config{
+		// the path which the websocket client should listen/registered to,
+		Endpoint: "/my_endpoint",
+		// the client-side javascript static file path
+		// which will be served by Iris.
+		// default is /iris-ws.js
+		// if you change that you have to change the bottom of templates/client.html
+		// script tag:
+		ClientSourcePath: "/iris-ws.js",
+		//
+		// Set the timeouts, 0 means no timeout
+		// websocket has more configuration, go to ../../config.go for more:
+		// WriteTimeout: 0,
+		// ReadTimeout:  0,
+		// by-default all origins are accepted, you can change this behavior by setting:
+		// CheckOrigin: (r *http.Request ) bool {},
+		//
+		//
+		// IDGenerator used to create (and later on, set)
+		// an ID for each incoming websocket connections (clients).
+		// The request is an argument which you can use to generate the ID (from headers for example).
+		// If empty then the ID is generated by DefaultIDGenerator: randomString(64):
+		// IDGenerator func(ctx *iris.Context) string {},
+	})
+
+	app.Adapt(ws) // adapt the websocket server, you can adapt more than one with different Endpoint
+
+	app.StaticWeb("/js", "./static/js") // serve our custom javascript code
+
+	app.Get("/", func(ctx *iris.Context) {
+		ctx.Render("client.html", clientPage{"Client Page", ctx.ServerHost()})
+	})
+
+	Conn := make(map[websocket.Connection]bool)
+	var myChatRoom = "room1"
+	var mutex = new(sync.Mutex)
+
+	ws.OnConnection(func(c websocket.Connection) {
+		c.Join(myChatRoom)
+		mutex.Lock()
+		Conn[c] = true
+		mutex.Unlock()
+		c.On("chat", func(message string) {
+			if message == "leave" {
+				c.Leave(myChatRoom)
+				c.To(myChatRoom).Emit("chat", "Client with ID: "+c.ID()+" left from the room and cannot send or receive message to/from this room.")
+				c.Emit("chat", "You have left from the room: "+myChatRoom+" you cannot send or receive any messages from others inside that room.")
+				return
+			}
+		})
+		c.OnDisconnect(func() {
+			mutex.Lock()
+			delete(Conn, c)
+			mutex.Unlock()
+			fmt.Printf("\nConnection with ID: %s has been disconnected!\n", c.ID())
+		})
+	})
+
+	var delay = 1 * time.Second
+	go func() {
+		i := 0
+		for {
+			mutex.Lock()
+			broadcast(Conn, fmt.Sprintf("aaaa %d\n", i))
+			mutex.Unlock()
+			time.Sleep(delay)
+			i++
+		}
+	}()
+
+	go func() {
+		i := 0
+		for {
+			mutex.Lock()
+			broadcast(Conn, fmt.Sprintf("aaaa2 %d\n", i))
+			mutex.Unlock()
+			time.Sleep(delay)
+			i++
+		}
+	}()
+
+	app.Listen(":8080")
+}
+
+func broadcast(Conn map[websocket.Connection]bool, message string) {
+	for k := range Conn {
+		k.To("room1").Emit("chat", message)
+	}
+}

_examples/examples/intermediate/websockets/connectionlist/static/js/chat.js

@@ -0,0 +1,38 @@
+var messageTxt;
+var messages;
+
+$(function () {
+
+	messageTxt = $("#messageTxt");
+	messages = $("#messages");
+
+
+	w = new Ws("ws://" + HOST + "/my_endpoint");
+	w.OnConnect(function () {
+		console.log("Websocket connection established");
+	});
+
+	w.OnDisconnect(function () {
+		appendMessage($("<div><center><h3>Disconnected</h3></center></div>"));
+	});
+
+	w.On("chat", function (message) {
+		appendMessage($("<div>" + message + "</div>"));
+	});
+
+	$("#sendBtn").click(function () {
+		w.Emit("chat", messageTxt.val().toString());
+		messageTxt.val("");
+	});
+
+})
+
+
+function appendMessage(messageDiv) {
+    var theDiv = messages[0];
+    var doScroll = theDiv.scrollTop == theDiv.scrollHeight - theDiv.clientHeight;
+    messageDiv.appendTo(messages);
+    if (doScroll) {
+        theDiv.scrollTop = theDiv.scrollHeight - theDiv.clientHeight;
+    }
+}

_examples/examples/intermediate/websockets/connectionlist/templates/client.html

@@ -0,0 +1,24 @@
+<html>
+
+<head>
+<title>{{ .Title}}</title>
+</head>
+
+<body>
+	<div id="messages"
+		style="border-width: 1px; border-style: solid; height: 400px; width: 375px;">
+
+	</div>
+	<input type="text" id="messageTxt" />
+	<button type="button" id="sendBtn">Send</button>
+	<script type="text/javascript">
+		var HOST = {{.Host}}
+	</script>
+	<script src="js/vendor/jquery-2.2.3.min.js" type="text/javascript"></script>
+	<!-- This is auto-serving by the Iris, you don't need to have this file in your disk-->
+	<script src="/iris-ws.js" type="text/javascript"></script>
+	<!-- -->
+	<script src="js/chat.js" type="text/javascript"></script>
+</body>
+
+</html>

_examples/examples/intermediate/websockets/custom-go-client/main.go

@@ -0,0 +1,179 @@
+package main
+
+// Run first `go run main.go server`
+// and `go run main.go client` as many times as you want.
+// Originally written by: github.com/antlaw to describe an old kataras/go-websocket's issue
+// which you can find here: https://github.com/kataras/go-websocket/issues/24
+import (
+	"fmt"
+	"os"
+	"strings"
+	"time"
+
+	"gopkg.in/kataras/iris.v6"
+	"gopkg.in/kataras/iris.v6/adaptors/httprouter"
+	"gopkg.in/kataras/iris.v6/adaptors/websocket"
+
+	xwebsocket "golang.org/x/net/websocket"
+)
+
+// WS is the current websocket connection
+var WS *xwebsocket.Conn
+
+func main() {
+	if len(os.Args) == 2 && strings.ToLower(os.Args[1]) == "server" {
+		ServerLoop()
+	} else if len(os.Args) == 2 && strings.ToLower(os.Args[1]) == "client" {
+		ClientLoop()
+	} else {
+		fmt.Println("wsserver [server|client]")
+	}
+}
+
+/////////////////////////////////////////////////////////////////////////
+// client side
+func sendUntilErr(sendInterval int) {
+	i := 1
+	for {
+		time.Sleep(time.Duration(sendInterval) * time.Second)
+		err := SendMessage("2", "all", "objectupdate", "2.UsrSchedule_v1_1")
+		if err != nil {
+			fmt.Println("failed to send join message", err.Error())
+			return
+		}
+		fmt.Println("objectupdate", i)
+		i++
+	}
+}
+
+func recvUntilErr() {
+	var msg = make([]byte, 2048)
+	var n int
+	var err error
+	i := 1
+	for {
+		if n, err = WS.Read(msg); err != nil {
+			fmt.Println(err.Error())
+			return
+		}
+		fmt.Printf("%v Received: %s.%v\n", time.Now(), string(msg[:n]), i)
+		i++
+	}
+
+}
+
+//ConnectWebSocket connect a websocket to host
+func ConnectWebSocket() error {
+	var origin = "http://localhost/"
+	var url = "ws://localhost:9090/socket"
+	var err error
+	WS, err = xwebsocket.Dial(url, "", origin)
+	return err
+}
+
+// CloseWebSocket closes the current websocket connection
+func CloseWebSocket() error {
+	if WS != nil {
+		return WS.Close()
+	}
+	return nil
+}
+
+// SendMessage broadcast a message to server
+func SendMessage(serverID, to, method, message string) error {
+	buffer := []byte(message)
+	return SendtBytes(serverID, to, method, buffer)
+}
+
+// SendtBytes broadcast a message to server
+func SendtBytes(serverID, to, method string, message []byte) error {
+	// look https://github.com/kataras/iris/tree/master/adaptors/websocket/message.go , client.go and client.js
+	// to understand the buffer line:
+	buffer := []byte(fmt.Sprintf("iris-websocket-message:%v;0;%v;%v;", method, serverID, to))
+	buffer = append(buffer, message...)
+	_, err := WS.Write(buffer)
+	if err != nil {
+		fmt.Println(err)
+		return err
+	}
+	return nil
+}
+
+// ClientLoop connects to websocket server, the keep send and recv dataS
+func ClientLoop() {
+	for {
+		time.Sleep(time.Second)
+		err := ConnectWebSocket()
+		if err != nil {
+			fmt.Println("failed to connect websocket", err.Error())
+			continue
+		}
+		// time.Sleep(time.Second)
+		err = SendMessage("2", "all", "join", "dummy2")
+		go sendUntilErr(1)
+		recvUntilErr()
+		err = CloseWebSocket()
+		if err != nil {
+			fmt.Println("failed to close websocket", err.Error())
+		}
+	}
+
+}
+
+/////////////////////////////////////////////////////////////////////////
+// server side
+
+// OnConnect handles incoming websocket connection
+func OnConnect(c websocket.Connection) {
+	fmt.Println("socket.OnConnect()")
+	c.On("join", func(message string) { OnJoin(message, c) })
+	c.On("objectupdate", func(message string) { OnObjectUpdated(message, c) })
+	// ok works too c.EmitMessage([]byte("dsadsa"))
+	c.OnDisconnect(func() { OnDisconnect(c) })
+
+}
+
+// ServerLoop listen and serve websocket requests
+func ServerLoop() {
+	app := iris.New()
+	app.Adapt(iris.DevLogger()) // enable all (error) logs
+	app.Adapt(httprouter.New()) // select the httprouter as the servemux
+
+	ws := websocket.New(websocket.Config{Endpoint: "/socket"})
+	app.Adapt(ws)
+
+	ws.OnConnection(OnConnect)
+	app.Listen("0.0.0.0:9090")
+
+}
+
+// OnJoin handles Join broadcast group request
+func OnJoin(message string, c websocket.Connection) {
+	t := time.Now()
+	c.Join("server2")
+	fmt.Println("OnJoin() time taken:", time.Since(t))
+}
+
+// OnObjectUpdated broadcasts to all client an incoming message
+func OnObjectUpdated(message string, c websocket.Connection) {
+	t := time.Now()
+	s := strings.Split(message, ";")
+	if len(s) != 3 {
+		fmt.Println("OnObjectUpdated() invalid message format:" + message)
+		return
+	}
+	serverID, _, objectID := s[0], s[1], s[2]
+	err := c.To("server"+serverID).Emit("objectupdate", objectID)
+	if err != nil {
+		fmt.Println(err, "failed to broacast object")
+		return
+	}
+	fmt.Println(fmt.Sprintf("OnObjectUpdated() message:%v, time taken: %v", message, time.Since(t)))
+}
+
+// OnDisconnect clean up things when a client is disconnected
+func OnDisconnect(c websocket.Connection) {
+	c.Leave("server2")
+	fmt.Println("OnDisconnect(): client disconnected!")
+
+}

_examples/examples/intermediate/websockets/native-messages/main.go

@@ -0,0 +1,62 @@
+package main
+
+import (
+	"fmt"
+
+	"gopkg.in/kataras/iris.v6"
+	"gopkg.in/kataras/iris.v6/adaptors/httprouter"
+	"gopkg.in/kataras/iris.v6/adaptors/view"
+	"gopkg.in/kataras/iris.v6/adaptors/websocket"
+)
+
+/* Native messages no need to import the iris-ws.js to the ./templates.client.html
+Use of: OnMessage and EmitMessage.
+
+
+NOTICE: IF YOU HAVE RAN THE PREVIOUS EXAMPLES YOU HAVE TO CLEAR YOUR BROWSER's CACHE
+BECAUSE chat.js is different than the CACHED. OTHERWISE YOU WILL GET Ws is undefined from the browser's console, becuase it will use the cached.
+*/
+
+type clientPage struct {
+	Title string
+	Host  string
+}
+
+func main() {
+	app := iris.New()
+	app.Adapt(iris.DevLogger())                  // enable all (error) logs
+	app.Adapt(httprouter.New())                  // select the httprouter as the servemux
+	app.Adapt(view.HTML("./templates", ".html")) // select the html engine to serve templates
+
+	ws := websocket.New(websocket.Config{
+		// the path which the websocket client should listen/registered to,
+		Endpoint: "/my_endpoint",
+		// to enable binary messages (useful for protobuf):
+		// BinaryMessages: true,
+	})
+
+	app.Adapt(ws) // adapt the websocket server, you can adapt more than one with different Endpoint
+
+	app.StaticWeb("/js", "./static/js") // serve our custom javascript code
+
+	app.Get("/", func(ctx *iris.Context) {
+		ctx.Render("client.html", clientPage{"Client Page", ctx.Host()})
+	})
+
+	ws.OnConnection(func(c websocket.Connection) {
+
+		c.OnMessage(func(data []byte) {
+			message := string(data)
+			c.To(websocket.Broadcast).EmitMessage([]byte("Message from: " + c.ID() + "-> " + message)) // broadcast to all clients except this
+			c.EmitMessage([]byte("Me: " + message))                                                    // writes to itself
+		})
+
+		c.OnDisconnect(func() {
+			fmt.Printf("\nConnection with ID: %s has been disconnected!", c.ID())
+		})
+
+	})
+
+	app.Listen(":8080")
+
+}

_examples/examples/intermediate/websockets/native-messages/static/js/chat.js

@@ -0,0 +1,38 @@
+var messageTxt;
+var messages;
+
+$(function () {
+
+	messageTxt = $("#messageTxt");
+	messages = $("#messages");
+
+
+	w = new WebSocket("ws://" + HOST + "/my_endpoint");
+	w.onopen = function () {
+		console.log("Websocket connection enstablished");
+	};
+
+	w.onclose = function () {
+		appendMessage($("<div><center><h3>Disconnected</h3></center></div>"));
+	};
+	w.onmessage = function(message){
+		appendMessage($("<div>" + message.data + "</div>"));
+	};
+
+
+	$("#sendBtn").click(function () {
+		w.send(messageTxt.val().toString());
+		messageTxt.val("");
+	});
+
+})
+
+
+function appendMessage(messageDiv) {
+    var theDiv = messages[0];
+    var doScroll = theDiv.scrollTop == theDiv.scrollHeight - theDiv.clientHeight;
+    messageDiv.appendTo(messages);
+    if (doScroll) {
+        theDiv.scrollTop = theDiv.scrollHeight - theDiv.clientHeight;
+    }
+}

_examples/examples/intermediate/websockets/native-messages/templates/client.html

@@ -0,0 +1,21 @@
+<html>
+
+<head>
+<title>{{ .Title}}</title>
+</head>
+
+<body>
+	<div id="messages"
+		style="border-width: 1px; border-style: solid; height: 400px; width: 375px;">
+
+	</div>
+	<input type="text" id="messageTxt" />
+	<button type="button" id="sendBtn">Send</button>
+	<script type="text/javascript">
+		var HOST = {{.Host}}
+	</script>
+	<script src="js/vendor/jquery-2.2.3.min.js" type="text/javascript"></script>
+	<script src="js/chat.js" type="text/javascript"></script>
+</body>
+
+</html>

_examples/examples/intermediate/websockets/overview/main.go

@@ -0,0 +1,99 @@
+package main
+
+import (
+	"fmt" // optional
+
+	"gopkg.in/kataras/iris.v6"
+	"gopkg.in/kataras/iris.v6/adaptors/httprouter"
+	"gopkg.in/kataras/iris.v6/adaptors/view"
+	"gopkg.in/kataras/iris.v6/adaptors/websocket"
+)
+
+type clientPage struct {
+	Title string
+	Host  string
+}
+
+func main() {
+	app := iris.New()
+	app.Adapt(iris.DevLogger())                  // enable all (error) logs
+	app.Adapt(httprouter.New())                  // select the httprouter as the servemux
+	app.Adapt(view.HTML("./templates", ".html")) // select the html engine to serve templates
+
+	ws := websocket.New(websocket.Config{
+		// the path which the websocket client should listen/registered to,
+		Endpoint: "/my_endpoint",
+		// the client-side javascript static file path
+		// which will be served by Iris.
+		// default is /iris-ws.js
+		// if you change that you have to change the bottom of templates/client.html
+		// script tag:
+		ClientSourcePath: "/iris-ws.js",
+		//
+		// Set the timeouts, 0 means no timeout
+		// websocket has more configuration, go to ../../config.go for more:
+		// WriteTimeout: 0,
+		// ReadTimeout:  0,
+		// by-default all origins are accepted, you can change this behavior by setting:
+		// CheckOrigin: (r *http.Request ) bool {},
+		//
+		//
+		// IDGenerator used to create (and later on, set)
+		// an ID for each incoming websocket connections (clients).
+		// The request is an argument which you can use to generate the ID (from headers for example).
+		// If empty then the ID is generated by DefaultIDGenerator: randomString(64):
+		// IDGenerator func(ctx *iris.Context) string {},
+	})
+
+	app.Adapt(ws) // adapt the websocket server, you can adapt more than one with different Endpoint
+
+	app.StaticWeb("/js", "./static/js") // serve our custom javascript code
+
+	app.Get("/", func(ctx *iris.Context) {
+		ctx.Render("client.html", clientPage{"Client Page", ctx.Host()})
+	})
+
+	var myChatRoom = "room1"
+
+	ws.OnConnection(func(c websocket.Connection) {
+		// Context returns the (upgraded) *iris.Context of this connection
+		// avoid using it, you normally don't need it,
+		// websocket has everything you need to authenticate the user BUT if it's necessary
+		// then  you use it to receive user information, for example: from headers.
+
+		// ctx := c.Context()
+
+		// join to a room (optional)
+		c.Join(myChatRoom)
+
+		c.On("chat", func(message string) {
+			if message == "leave" {
+				c.Leave(myChatRoom)
+				c.To(myChatRoom).Emit("chat", "Client with ID: "+c.ID()+" left from the room and cannot send or receive message to/from this room.")
+				c.Emit("chat", "You have left from the room: "+myChatRoom+" you cannot send or receive any messages from others inside that room.")
+				return
+			}
+			// to all except this connection ->
+			// c.To(websocket.Broadcast).Emit("chat", "Message from: "+c.ID()+"-> "+message)
+			// to all connected clients: c.To(websocket.All)
+
+			// to the client itself ->
+			//c.Emit("chat", "Message from myself: "+message)
+
+			//send the message to the whole room,
+			//all connections are inside this room will receive this message
+			c.To(myChatRoom).Emit("chat", "From: "+c.ID()+": "+message)
+		})
+
+		// or create a new leave event
+		// c.On("leave", func() {
+		// 	c.Leave(myChatRoom)
+		// })
+
+		c.OnDisconnect(func() {
+			fmt.Printf("Connection with ID: %s has been disconnected!\n", c.ID())
+		})
+	})
+
+	app.Listen(":8080")
+}

_examples/examples/intermediate/websockets/overview/static/js/chat.js

@@ -0,0 +1,38 @@
+var messageTxt;
+var messages;
+
+$(function () {
+
+	messageTxt = $("#messageTxt");
+	messages = $("#messages");
+
+
+	w = new Ws("ws://" + HOST + "/my_endpoint");
+	w.OnConnect(function () {
+		console.log("Websocket connection established");
+	});
+
+	w.OnDisconnect(function () {
+		appendMessage($("<div><center><h3>Disconnected</h3></center></div>"));
+	});
+
+	w.On("chat", function (message) {
+		appendMessage($("<div>" + message + "</div>"));
+	});
+
+	$("#sendBtn").click(function () {
+		w.Emit("chat", messageTxt.val().toString());
+		messageTxt.val("");
+	});
+
+})
+
+
+function appendMessage(messageDiv) {
+    var theDiv = messages[0];
+    var doScroll = theDiv.scrollTop == theDiv.scrollHeight - theDiv.clientHeight;
+    messageDiv.appendTo(messages);
+    if (doScroll) {
+        theDiv.scrollTop = theDiv.scrollHeight - theDiv.clientHeight;
+    }
+}

_examples/examples/intermediate/websockets/overview/templates/client.html

@@ -0,0 +1,24 @@
+<html>
+
+<head>
+<title>{{ .Title}}</title>
+</head>
+
+<body>
+	<div id="messages"
+		style="border-width: 1px; border-style: solid; height: 400px; width: 375px;">
+
+	</div>
+	<input type="text" id="messageTxt" />
+	<button type="button" id="sendBtn">Send</button>
+	<script type="text/javascript">
+		var HOST = {{.Host}}
+	</script>
+	<script src="js/vendor/jquery-2.2.3.min.js" type="text/javascript"></script>
+	<!-- This is auto-serving by the Iris, you don't need to have this file in your disk-->
+	<script src="/iris-ws.js" type="text/javascript"></script>
+	<!-- -->
+	<script src="js/chat.js" type="text/javascript"></script>
+</body>
+
+</html>

_examples/examples/intermediate/websockets/ridiculous-simple/main.go

@@ -0,0 +1,48 @@
+package main
+
+import (
+	"fmt"
+
+	"gopkg.in/kataras/iris.v6"
+	"gopkg.in/kataras/iris.v6/adaptors/httprouter"
+	"gopkg.in/kataras/iris.v6/adaptors/websocket"
+)
+
+func handleConnection(c websocket.Connection) {
+
+	// Read events from browser
+	c.On("chat", func(msg string) {
+
+		// Print the message to the console
+		fmt.Printf("%s sent: %s\n", c.Context().RemoteAddr(), msg)
+
+		// Write message back to browser
+		c.Emit("chat", msg)
+	})
+
+}
+
+func main() {
+	app := iris.New()
+	app.Adapt(iris.DevLogger())
+	app.Adapt(httprouter.New())
+
+	// create our echo websocket server
+	ws := websocket.New(websocket.Config{
+		ReadBufferSize:  1024,
+		WriteBufferSize: 1024,
+		Endpoint:        "/echo",
+	})
+
+	ws.OnConnection(handleConnection)
+
+	// Adapt the websocket server.
+	// you can adapt more than one of course.
+	app.Adapt(ws)
+
+	app.Get("/", func(ctx *iris.Context) {
+		ctx.ServeFile("websockets.html", false) // second parameter: enable gzip?
+	})
+
+	app.Listen(":8080")
+}

_examples/examples/intermediate/websockets/ridiculous-simple/websockets.html

@@ -0,0 +1,29 @@
+<input id="input" type="text" />
+<button onclick="send()">Send</button>
+<pre id="output"></pre>
+<script src="/iris-ws.js"></script>
+<script>
+	var input = document.getElementById("input");
+	var output = document.getElementById("output");
+
+	// Ws comes from the auto-served '/iris-ws.js'
+	var socket = new Ws("ws://localhost:8080/echo");
+	socket.OnConnect(function () {
+		output.innerHTML += "Status: Connected\n";
+	});
+
+	socket.OnDisconnect(function () {
+		output.innerHTML += "Status: Disconnected\n";
+	});
+
+	// read events from the server
+	socket.On("chat", function (msg) {
+		output.innerHTML += "Server: " + msg + "\n";
+	});
+
+	function send() {
+		// send chat event data to the server
+		socket.Emit("chat", input.value);
+		input.value = "";
+	}
+</script>

_examples/examples/intermediate/websockets/secure/main.go

@@ -0,0 +1,197 @@
+package main
+
+import (
+	"fmt"       // optional
+	"io/ioutil" // optional
+	"os"        // optional
+	"time"      // optional
+
+	"gopkg.in/kataras/iris.v6"
+	"gopkg.in/kataras/iris.v6/adaptors/httprouter"
+	"gopkg.in/kataras/iris.v6/adaptors/view"
+	"gopkg.in/kataras/iris.v6/adaptors/websocket"
+)
+
+type clientPage struct {
+	Title string
+	Host  string
+}
+
+func main() {
+	app := iris.New()
+	app.Adapt(iris.DevLogger())                  // enable all (error) logs
+	app.Adapt(httprouter.New())                  // select the httprouter as the servemux
+	app.Adapt(view.HTML("./templates", ".html")) // select the html engine to serve templates
+
+	ws := websocket.New(websocket.Config{
+		// the path which the websocket client should listen/registered to,
+		Endpoint: "/my_endpoint",
+		// the client-side javascript static file path
+		// which will be served by Iris.
+		// default is /iris-ws.js
+		// if you change that you have to change the bottom of templates/client.html
+		// script tag:
+		ClientSourcePath: "/iris-ws.js",
+		//
+		// Set the timeouts, 0 means no timeout
+		// websocket has more configuration, go to ../../config.go for more:
+		// WriteTimeout: 0,
+		// ReadTimeout:  0,
+		// by-default all origins are accepted, you can change this behavior by setting:
+		// CheckOrigin: (r *http.Request ) bool {},
+		//
+		//
+		// IDGenerator used to create (and later on, set)
+		// an ID for each incoming websocket connections (clients).
+		// The request is an argument which you can use to generate the ID (from headers for example).
+		// If empty then the ID is generated by DefaultIDGenerator: randomString(64):
+		// IDGenerator func(ctx *iris.Context) string {},
+	})
+
+	app.Adapt(ws) // adapt the websocket server, you can adapt more than one with different Endpoint
+
+	app.StaticWeb("/js", "./static/js") // static route to serve our javascript files
+
+	app.Get("/", func(ctx *iris.Context) {
+		// send our custom javascript source file before client really asks for that
+		// using the new go v1.8's HTTP/2 Push.
+		// Note that you have to listen using ListenTLS in order this to work.
+		if err := ctx.Push("/js/chat.js", nil); err != nil {
+			app.Log(iris.DevMode, err.Error())
+		}
+		ctx.Render("client.html", clientPage{"Client Page", ctx.Host()})
+	})
+
+	var myChatRoom = "room1"
+
+	ws.OnConnection(func(c websocket.Connection) {
+		// Context returns the (upgraded) *iris.Context of this connection
+		// avoid using it, you normally don't need it,
+		// websocket has everything you need to authenticate the user BUT if it's necessary
+		// then  you use it to receive user information, for example: from headers.
+
+		// ctx := c.Context()
+
+		// join to a room (optional)
+		c.Join(myChatRoom)
+
+		c.On("chat", func(message string) {
+			if message == "leave" {
+				c.Leave(myChatRoom)
+				c.To(myChatRoom).Emit("chat", "Client with ID: "+c.ID()+" left from the room and cannot send or receive message to/from this room.")
+				c.Emit("chat", "You have left from the room: "+myChatRoom+" you cannot send or receive any messages from others inside that room.")
+				return
+			}
+			// to all except this connection ->
+			// c.To(websocket.Broadcast).Emit("chat", "Message from: "+c.ID()+"-> "+message)
+			// to all connected clients: c.To(websocket.All)
+
+			// to the client itself ->
+			//c.Emit("chat", "Message from myself: "+message)
+
+			//send the message to the whole room,
+			//all connections are inside this room will receive this message
+			c.To(myChatRoom).Emit("chat", "From: "+c.ID()+": "+message)
+		})
+
+		// or create a new leave event
+		// c.On("leave", func() {
+		// 	c.Leave(myChatRoom)
+		// })
+
+		c.OnDisconnect(func() {
+			fmt.Printf("Connection with ID: %s has been disconnected!\n", c.ID())
+		})
+	})
+
+	listenTLS(app)
+
+}
+
+// a test listenTLS for our localhost
+func listenTLS(app *iris.Framework) {
+
+	const (
+		testTLSCert = `-----BEGIN CERTIFICATE-----
+MIIDBTCCAe2gAwIBAgIJAOYzROngkH6NMA0GCSqGSIb3DQEBBQUAMBkxFzAVBgNV
+BAMMDmxvY2FsaG9zdDo4MDgwMB4XDTE3MDIxNzAzNDM1NFoXDTI3MDIxNTAzNDM1
+NFowGTEXMBUGA1UEAwwObG9jYWxob3N0OjgwODAwggEiMA0GCSqGSIb3DQEBAQUA
+A4IBDwAwggEKAoIBAQCfsiVHO14FpKsi0pvBv68oApQm2MO+dCvq87sDU4E0QJhG
+KV1RCUmQVypChEqdLlUQsopcXSyKwbWoyg1/KNHYO3DHMfePb4bC1UD2HENq7Ph2
+8QJTEi/CJvUB9hqke/YCoWYdjFiI3h3Hw8q5whGO5XR3R23z69vr5XxoNlcF2R+O
+TdkzArd0CWTZS27vbgdnyi9v3Waydh/rl+QRtPUgEoCEqOOkMSMldXO6Z9GlUk9b
+FQHwIuEnlSoVFB5ot5cqebEjJnWMLLP83KOCQekJeHZOyjeTe8W0Fy1DGu5fvFNh
+xde9e/7XlFE//00vT7nBmJAUV/2CXC8U5lsjLEqdAgMBAAGjUDBOMB0GA1UdDgQW
+BBQOfENuLn/t0Z4ZY1+RPWaz7RBH+TAfBgNVHSMEGDAWgBQOfENuLn/t0Z4ZY1+R
+PWaz7RBH+TAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4IBAQBG7AEEuIq6
+rWCE5I2t4IXz0jN7MilqEhUWDbUajl1paYf6Ikx5QhMsFx21p6WEWYIYcnWAKZe2
+chAgnnGojuxdx0qjiaH4N4xWGHsWhaesnIF1xJepLlX3kJZQURvRxM4wlljlQPIb
+9tqzKP131K1HDqplAtp7nWQ72m3J0ZfzH0mYIUxuaS/uQIVtgKqdilwy/VE5dRZ9
+QFIb4G9TnNThXMqgTLjfNr33jVbTuv6fzKHYNbCkP3L10ydEs/ddlREmtsn9nE8Q
+XCTIYXzA2kr5kWk7d3LkUiSvu3g2S1Ol1YaIKaOQyRveseCGwR4xohLT+dPUW9dL
+3hDVLlwE3mB3
+-----END CERTIFICATE-----
+
+`
+		testTLSKey = `-----BEGIN RSA PRIVATE KEY-----
+MIIEogIBAAKCAQEAn7IlRzteBaSrItKbwb+vKAKUJtjDvnQr6vO7A1OBNECYRild
+UQlJkFcqQoRKnS5VELKKXF0sisG1qMoNfyjR2DtwxzH3j2+GwtVA9hxDauz4dvEC
+UxIvwib1AfYapHv2AqFmHYxYiN4dx8PKucIRjuV0d0dt8+vb6+V8aDZXBdkfjk3Z
+MwK3dAlk2Utu724HZ8ovb91msnYf65fkEbT1IBKAhKjjpDEjJXVzumfRpVJPWxUB
+8CLhJ5UqFRQeaLeXKnmxIyZ1jCyz/NyjgkHpCXh2Tso3k3vFtBctQxruX7xTYcXX
+vXv+15RRP/9NL0+5wZiQFFf9glwvFOZbIyxKnQIDAQABAoIBAEzBx4ExW8PCni8i
+o5LAm2PTuXniflMwa1uGwsCahmOjGI3AnAWzPRSPkNRf2a0q8+AOsMosTphy+umi
+FFKmQBZ6m35i2earaE6FSbABbbYbKGGi/ccH2sSrDOBgdfXRTzF8eiSBrJw8hnvZ
+87rNOLtCNnSOdJ7lItODfgRo+fLo4uQenJ8VONYwtwm1ejn8qLXq8O5zF66IYUD6
+gAzqOiAWumgZL0tEmndeQ+noe4STpJZlOjiCsA12NiJaKDDeDIn5A/pXce+bYNfJ
+k4yoroyq/JXBkhyuZDvX9vYp5AA+Q68h8/KmsKkifUgSGSHun5/80lYyT/f60TLX
+PxT9GYECgYEA0s8qck7L29nBBTQ6IPF3GHGmqiRdfH+qhP/Jn4NtoW3XuVe4A15i
+REq1L8WAiOUIBnBaD8HzbeioqJJYx1pu7x9h/GCNDhdBfwhTjnBe+JjfLqvJKnc0
+HUT5wj4DVqattxKzUW8kTRBSWtVremzeffDo+EL6dnR7Bc02Ibs4WpUCgYEAwe34
+Uqhie+/EFr4HjYRUNZSNgYNAJkKHVxk4qGzG5VhvjPafnHUbo+Kk/0QW7eIB+kvR
+FDO8oKh9wTBrWZEcLJP4jDIKh4y8hZTo9B8EjxFONXVxZlOSYuGjheL8AiLzE7L9
+C1spaKMM/MyxAXDRHpG/NeEgXM7Kn6kUGwJdNekCgYAshLNiEGHcu8+XWcAs1NFh
+yB56L9PORuerzpi1pvuv65JzAaNKktQNt/krbXoHbtaTBYb/bOYLf+aeMsmsz9w9
+g1MeCQXAxAiA2zFKE1D7Ds2S/ZQt8559z+MusgnicrCcyMY1nFL+M0QxCoD4CaWy
+0v1f8EUUXuTcBMo5tV/hQQKBgDoBBW8jsiFDu7DZscSgOde00QZVzZAkAfsJLisi
+LfNXGjZdZawUUuoX1iYLpZgNK25D0wtp1hdvjf2Ej/dAMd8bexHjvcaBT7ncqjiq
+NmDcWjofIIXspTIyLwjStXGmJnJT7N/CqoYDjtTmHGND7Shpi3mAFn/r0isjFUJm
+2J5RAoGALuGXxzmSRWmkIp11F/Qr3PBFWBWkrRWaH2TRLMhrU/wO8kCsSyo4PmAZ
+ltOfD7InpDiCu43hcDPQ/29FUbDnmAhvMnmIQuHXGgPF/LhqEhbKPA/o/eZdQVCK
+QG+tmveBBIYMed5YbWstZu/95lIHF+u8Hl+Z6xgveozfE5yqiUA=
+-----END RSA PRIVATE KEY-----
+
+	`
+	)
+
+	// create the key and cert files on the fly, and delete them when this test finished
+	certFile, ferr := ioutil.TempFile("", "cert")
+
+	if ferr != nil {
+		panic(ferr)
+	}
+
+	keyFile, ferr := ioutil.TempFile("", "key")
+	if ferr != nil {
+		panic(ferr)
+	}
+
+	certFile.WriteString(testTLSCert)
+	keyFile.WriteString(testTLSKey)
+
+	// add an event when control+C pressed, to remove the temp cert and key files.
+	app.Adapt(iris.EventPolicy{
+		Interrupted: func(*iris.Framework) {
+			certFile.Close()
+			time.Sleep(50 * time.Millisecond)
+			os.Remove(certFile.Name())
+
+			keyFile.Close()
+			time.Sleep(50 * time.Millisecond)
+			os.Remove(keyFile.Name())
+		},
+	})
+
+	// https://localhost
+	app.ListenTLS("localhost:443", certFile.Name(), keyFile.Name())
+}

_examples/examples/intermediate/websockets/secure/static/js/chat.js

@@ -0,0 +1,38 @@
+var messageTxt;
+var messages;
+
+$(function () {
+
+	messageTxt = $("#messageTxt");
+	messages = $("#messages");
+
+  /* secure wss because we ListenTLS */
+	w = new Ws("wss://" + HOST + "/my_endpoint");
+	w.OnConnect(function () {
+		console.log("Websocket connection established");
+	});
+
+	w.OnDisconnect(function () {
+		appendMessage($("<div><center><h3>Disconnected</h3></center></div>"));
+	});
+
+	w.On("chat", function (message) {
+		appendMessage($("<div>" + message + "</div>"));
+	});
+
+	$("#sendBtn").click(function () {
+		w.Emit("chat", messageTxt.val().toString());
+		messageTxt.val("");
+	});
+
+})
+
+
+function appendMessage(messageDiv) {
+    var theDiv = messages[0];
+    var doScroll = theDiv.scrollTop == theDiv.scrollHeight - theDiv.clientHeight;
+    messageDiv.appendTo(messages);
+    if (doScroll) {
+        theDiv.scrollTop = theDiv.scrollHeight - theDiv.clientHeight;
+    }
+}

_examples/examples/intermediate/websockets/secure/templates/client.html

@@ -0,0 +1,24 @@
+<html>
+
+<head>
+<title>{{ .Title}}</title>
+</head>
+
+<body>
+	<div id="messages"
+		style="border-width: 1px; border-style: solid; height: 400px; width: 375px;">
+
+	</div>
+	<input type="text" id="messageTxt" />
+	<button type="button" id="sendBtn">Send</button>
+	<script type="text/javascript">
+		var HOST = {{.Host}}
+	</script>
+	<script src="/js/vendor/jquery-2.2.3.min.js"></script>
+	<!-- This is auto-serving by the Iris, you don't need to have this file in your disk-->
+	<script src="/iris-ws.js"></script>
+	<!-- -->
+	<script src="/js/chat.js"></script>
+</body>
+
+</html>