-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathreadme
More file actions
139 lines (105 loc) · 4.17 KB
/
readme
File metadata and controls
139 lines (105 loc) · 4.17 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
#  Go Events
[](https://github.com/codemodify/systemkit-events/releases/latest)
[](https://github.com/codemodify/TheFreeLicense)
[](https://goreportcard.com/report/github.com/codemodify/systemkit-events)
[](https://godoc.org/github.com/codemodify/systemkit-events)
#### Robust events for Go. It takes `0.1` seconds to send/receive 1 Million events.
#  Install
```go
go get github.com/codemodify/systemkit-events
```
#  API
|
--- | ---
On(`event`, `handler`, `callOnce`) | Subscribe
OnWithData(`event`, `handler`, `callOnce`) | Subscribe with payload
Off(`event`, `handlerRef`) | Unsubscribe
OffWithData(`event`, `handlerRef`) | Unsubscribe with payload
Emit(`event`) | Emit
EmitWithData(`event`, `data`) | Emit with payload
#  Usage: Subscribe + Notify
```go
package main
import (
events "github.com/codemodify/systemkit-events"
)
func main() {
events.Events().On("PING", func() {
// FIMXE: will be called
})
events.Events().Emit("PING")
}
```
#  Usage: Subscribe (data) + Notify (data)
```go
package main
import (
events "github.com/codemodify/systemkit-events"
)
func main() {
events.Events().OnWithData("PING", func(data []byte) {
// FIMXE: will be called
})
events.Events().EmitWithData("PING", []byte("PING-DATA"))
}
```
#  Usage: Subscribe (yes-no-data) + Notify (data)
```go
package main
import (
events "github.com/codemodify/systemkit-events"
)
func main() {
events.Events().OnWithData("PING", func(data []byte) {
// FIMXE: will be called
})
events.Events().On("PING", func() {
// FIMXE: will be called
})
events.Events().EmitWithData("PING", []byte("PING-DATA"))
}
```
#  Usage: Subscribe (yes-no-data) + Notify
```go
package main
import (
events "github.com/codemodify/systemkit-events"
)
func main() {
events.Events().OnWithData("PING", func(data []byte) {
// FIMXE: will be called, data will be nil
})
events.Events().On("PING", func() {
// FIMXE: will be called
})
events.Events().Emit("PING")
}
```
#  Usage: Subscribe Once + Notify
```go
package main
import (
events "github.com/codemodify/systemkit-events"
)
func main() {
handler1CallOnce := true
events.Events().On("PING", func() {
// FIMXE: will be called ONCE
}, handler1CallOnce)
handler3CallOnce := false
events.Events().On("PING", func() {
// FIMXE: will be called UNTIL "events.Events().Off()" is called
}, handler3CallOnce)
events.Events().Emit("PING")
}
```