mirror of
https://github.com/kataras/iris.git
synced 2025-12-29 07:47:22 +00:00
Add notes for the new lead maintainer of the open-source iris project and align with @get-ion/ion by @hiveminded
Former-commit-id: da4f38eb9034daa49446df3ee529423b98f9b331
This commit is contained in:
kataras
166
_examples/tutorial/online-visitors/main.go
Normal file
166
_examples/tutorial/online-visitors/main.go
Normal file
@@ -0,0 +1,166 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"sync/atomic"
|
||||
|
||||
"github.com/kataras/iris"
|
||||
"github.com/kataras/iris/context"
|
||||
|
||||
"github.com/kataras/iris/websocket"
|
||||
)
|
||||
|
||||
func main() {
|
||||
// init the web application instance
|
||||
// app := iris.New()
|
||||
app := iris.Default()
|
||||
|
||||
// load templaes
|
||||
app.RegisterView(iris.HTML("./templates", ".html").Reload(true))
|
||||
// setup the websocket server
|
||||
ws := websocket.New(websocket.Config{})
|
||||
ws.OnConnection(HandleWebsocketConnection)
|
||||
|
||||
app.Get("/my_endpoint", ws.Handler())
|
||||
app.Any("/iris-ws.js", websocket.ClientHandler())
|
||||
|
||||
// register static assets request path and system directory
|
||||
app.StaticWeb("/js", "./static/assets/js")
|
||||
|
||||
h := func(ctx context.Context) {
|
||||
ctx.ViewData("", page{PageID: "index page"})
|
||||
ctx.View("index.html")
|
||||
}
|
||||
|
||||
h2 := func(ctx context.Context) {
|
||||
ctx.ViewData("", page{PageID: "other page"})
|
||||
ctx.View("other.html")
|
||||
}
|
||||
|
||||
// Open some browser tabs/or windows
|
||||
// and navigate to
|
||||
// http://localhost:8080/ and http://localhost:8080/other multiple times.
|
||||
// Each page has its own online-visitors counter.
|
||||
app.Get("/", h)
|
||||
app.Get("/other", h2)
|
||||
app.Run(iris.Addr(":8080"))
|
||||
}
|
||||
|
||||
type page struct {
|
||||
PageID string
|
||||
}
|
||||
|
||||
type pageView struct {
|
||||
source string
|
||||
count uint64
|
||||
}
|
||||
|
||||
func (v *pageView) increment() {
|
||||
atomic.AddUint64(&v.count, 1)
|
||||
}
|
||||
|
||||
func (v *pageView) decrement() {
|
||||
oldCount := v.count
|
||||
if oldCount > 0 {
|
||||
atomic.StoreUint64(&v.count, oldCount-1)
|
||||
}
|
||||
}
|
||||
|
||||
func (v *pageView) getCount() uint64 {
|
||||
val := atomic.LoadUint64(&v.count)
|
||||
return val
|
||||
}
|
||||
|
||||
type (
|
||||
pageViews []pageView
|
||||
)
|
||||
|
||||
func (v *pageViews) Add(source string) {
|
||||
args := *v
|
||||
n := len(args)
|
||||
for i := 0; i < n; i++ {
|
||||
kv := &args[i]
|
||||
if kv.source == source {
|
||||
kv.increment()
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
c := cap(args)
|
||||
if c > n {
|
||||
args = args[:n+1]
|
||||
kv := &args[n]
|
||||
kv.source = source
|
||||
kv.count = 1
|
||||
*v = args
|
||||
return
|
||||
}
|
||||
|
||||
kv := pageView{}
|
||||
kv.source = source
|
||||
kv.count = 1
|
||||
*v = append(args, kv)
|
||||
}
|
||||
|
||||
func (v *pageViews) Get(source string) *pageView {
|
||||
args := *v
|
||||
n := len(args)
|
||||
for i := 0; i < n; i++ {
|
||||
kv := &args[i]
|
||||
if kv.source == source {
|
||||
return kv
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (v *pageViews) Reset() {
|
||||
*v = (*v)[:0]
|
||||
}
|
||||
|
||||
var v pageViews
|
||||
|
||||
// HandleWebsocketConnection handles the online viewers per example(gist source)
|
||||
func HandleWebsocketConnection(c websocket.Connection) {
|
||||
|
||||
c.On("watch", func(pageSource string) {
|
||||
v.Add(pageSource)
|
||||
// join the socket to a room linked with the page source
|
||||
c.Join(pageSource)
|
||||
|
||||
viewsCount := v.Get(pageSource).getCount()
|
||||
if viewsCount == 0 {
|
||||
viewsCount++ // count should be always > 0 here
|
||||
}
|
||||
c.To(pageSource).Emit("watch", viewsCount)
|
||||
})
|
||||
|
||||
c.OnLeave(func(roomName string) {
|
||||
if roomName != c.ID() { // if the roomName it's not the connection iself
|
||||
// the roomName here is the source, this is the only room(except the connection's ID room) which we join the users to.
|
||||
pageV := v.Get(roomName)
|
||||
if pageV == nil {
|
||||
return // for any case that this room is not a pageView source
|
||||
}
|
||||
// decrement -1 the specific counter for this page source.
|
||||
pageV.decrement()
|
||||
// 1. open 30 tabs.
|
||||
// 2. close the browser.
|
||||
// 3. re-open the browser
|
||||
// 4. should be v.getCount() = 1
|
||||
// in order to achieve the previous flow we should decrement exactly when the user disconnects
|
||||
// but emit the result a little after, on a goroutine
|
||||
// getting all connections within this room and emit the online views one by one.
|
||||
// note:
|
||||
// we can also add a time.Sleep(2-3 seconds) inside the goroutine at the future if we don't need 'real-time' updates.
|
||||
go func(currentConnID string) {
|
||||
for _, conn := range c.Server().GetConnectionsByRoom(roomName) {
|
||||
if conn.ID() != currentConnID {
|
||||
conn.Emit("watch", pageV.getCount())
|
||||
}
|
||||
|
||||
}
|
||||
}(c.ID())
|
||||
}
|
||||
|
||||
})
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
(function() {
|
||||
var socket = new Ws("ws://localhost:8080/my_endpoint");
|
||||
|
||||
socket.OnConnect(function () {
|
||||
socket.Emit("watch", PAGE_SOURCE);
|
||||
});
|
||||
|
||||
|
||||
socket.On("watch", function (onlineViews) {
|
||||
var text = "1 online view";
|
||||
if (onlineViews > 1) {
|
||||
text = onlineViews + " online views";
|
||||
}
|
||||
document.getElementById("online_views").innerHTML = text;
|
||||
});
|
||||
|
||||
socket.OnDisconnect(function () {
|
||||
document.getElementById("online_views").innerHTML = "you've been disconnected";
|
||||
});
|
||||
|
||||
})();
|
||||
43
_examples/tutorial/online-visitors/templates/index.html
Normal file
43
_examples/tutorial/online-visitors/templates/index.html
Normal file
@@ -0,0 +1,43 @@
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<title>Online visitors example</title>
|
||||
<style>
|
||||
body {
|
||||
margin: 0;
|
||||
font-family: -apple-system, "San Francisco", "Helvetica Neue", "Noto", "Roboto", "Calibri Light", sans-serif;
|
||||
color: #212121;
|
||||
font-size: 1.0em;
|
||||
line-height: 1.6;
|
||||
}
|
||||
|
||||
.container {
|
||||
max-width: 750px;
|
||||
margin: auto;
|
||||
padding: 15px;
|
||||
}
|
||||
|
||||
#online_views {
|
||||
font-weight: bold;
|
||||
font-size: 18px;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div class="container">
|
||||
<span id="online_views">1 online view</span>
|
||||
</div>
|
||||
|
||||
<script type="text/javascript">
|
||||
/* take the page source from our passed struct on .Render */
|
||||
var PAGE_SOURCE = {{ .PageID }}
|
||||
</script>
|
||||
|
||||
<script src="/iris-ws.js"></script>
|
||||
|
||||
<script src="/js/visitors.js"></script>
|
||||
|
||||
</body>
|
||||
|
||||
</html>
|
||||
29
_examples/tutorial/online-visitors/templates/other.html
Normal file
29
_examples/tutorial/online-visitors/templates/other.html
Normal file
@@ -0,0 +1,29 @@
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<title>Different page, different results</title>
|
||||
<style>
|
||||
#online_views {
|
||||
font-weight: bold;
|
||||
font-size: 18px;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
<span id="online_views">1 online view</span>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
/* take the page source from our passed struct on .Render */
|
||||
var PAGE_SOURCE = {{ .PageID }}
|
||||
</script>
|
||||
|
||||
<script src="/iris-ws.js"></script>
|
||||
|
||||
<script src="/js/visitors.js"></script>
|
||||
|
||||
</body>
|
||||
|
||||
</html>
|
||||
Reference in New Issue
Block a user