blender/flamenco
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Cleanup, Manager: move some SocketIO room handling code and add docs

Browse Source 
Add some clarifications and move the `roomXXX()` functions into
`sio_rooms.go`.
This commit is contained in:
Sybren A. Stüvel 2022-05-20 11:41:06 +02:00
parent 34bccd9277
commit 4c18a19786
2 changed files with 19 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
internal/manager/webupdates/job_updates.go
View File

@ -67,13 +67,3 @@ func (b *BiDirComms) BroadcastTaskUpdate(taskUpdate api.SocketIOTaskUpdate) {
room := roomForJob(taskUpdate.JobId)
b.BroadcastTo(room, SIOEventTaskUpdate, taskUpdate)
}
// roomForJob will return the SocketIO room name for the given job. Clients in
// this room will receive info scoped to this job, so for example updates to all
// tasks of this job.
//
// Note that `api.SocketIOJobUpdate`s themselves are sent to all SocketIO clients, and
// not to this room.
func roomForJob(jobUUID string) SocketIORoomName {
return SocketIORoomName("job-" + jobUUID)
}

23
internal/manager/webupdates/sio_rooms.go
View File

@ -9,16 +9,21 @@ import (
gosocketio "github.com/graarh/golang-socketio"
)
type SocketIORoomName string
// Separate type aliases for room names and event types; it's otherwise too easy
// to confuse the two.
type (
SocketIORoomName string
SocketIOEventType string
)
const (
// Predefined SocketIO rooms.
// Predefined SocketIO rooms. There will be others, but those will have a
// dynamic name like `job-fa48930a-105c-4125-a7f7-0aa1651dcd57` and cannot be
// listed here as constants. See `roomXXX()` functions for those.
SocketIORoomChat SocketIORoomName = "Chat" // For chat messages.
SocketIORoomJobs SocketIORoomName = "Jobs" // For job updates.
)
type SocketIOEventType string
const (
// Predefined SocketIO event types.
SIOEventChatMessageRcv SocketIOEventType = "/chat" // clients send chat messages here
@ -78,3 +83,13 @@ func (b *BiDirComms) handleRoomSubscription(c *gosocketio.Channel, subs api.Sock
logger.Debug().Msg("socketIO: subscription")
return "ok"
}
// roomForJob will return the SocketIO room name for the given job. Clients in
// this room will receive info scoped to this job, so for example updates to all
// tasks of this job.
//
// Note that `api.SocketIOJobUpdate`s themselves are sent to all SocketIO clients, and
// not to this room.
func roomForJob(jobUUID string) SocketIORoomName {
return SocketIORoomName("job-" + jobUUID)
}