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 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
|
package centrifuge
import (
"container/heap"
"sync"
"time"
"github.com/centrifugal/centrifuge/internal/memstream"
"github.com/centrifugal/centrifuge/internal/priority"
)
// MemoryBroker is builtin default Broker which allows to run Centrifuge-based
// server without any external broker. All data managed inside process memory.
//
// With this Broker you can only run single Centrifuge node. If you need to scale
// you should consider using another Broker implementation instead – for example
// RedisBroker.
//
// Running single node can be sufficient for many use cases especially when you
// need maximum performance and not too many online clients. Consider configuring
// your load balancer to have one backup Centrifuge node for HA in this case.
type MemoryBroker struct {
node *Node
historyHub *historyHub
eventHandler BrokerEventHandler
// pubLocks synchronize access to publishing. We have to sync publish
// to handle publications in the order of offset to prevent InsufficientState
// errors.
// TODO: maybe replace with sharded pool of workers with buffered channels.
pubLocks map[int]*sync.Mutex
}
var _ Broker = (*MemoryBroker)(nil)
// MemoryBrokerConfig is a memory broker config.
type MemoryBrokerConfig struct {
// HistoryMetaTTL sets a time of inactive stream meta information expiration.
// This information contains an epoch and offset of each stream. Having this
// meta information helps in message recovery process.
// Must have a reasonable value for application.
// At moment works with seconds precision.
// TODO v1: since we have epoch, things should also properly work without meta
// information at all (but we loose possibility of long-term recover in stream
// without new messages). We can make this optional and disabled by default at
// least.
HistoryMetaTTL time.Duration
}
const numPubLocks = 4096
// NewMemoryBroker initializes MemoryBroker.
func NewMemoryBroker(n *Node, c MemoryBrokerConfig) (*MemoryBroker, error) {
pubLocks := make(map[int]*sync.Mutex, numPubLocks)
for i := 0; i < numPubLocks; i++ {
pubLocks[i] = &sync.Mutex{}
}
b := &MemoryBroker{
node: n,
historyHub: newHistoryHub(c.HistoryMetaTTL),
pubLocks: pubLocks,
}
return b, nil
}
// Run runs memory broker.
func (b *MemoryBroker) Run(h BrokerEventHandler) error {
b.eventHandler = h
b.historyHub.runCleanups()
return nil
}
func (b *MemoryBroker) pubLock(ch string) *sync.Mutex {
return b.pubLocks[index(ch, numPubLocks)]
}
// Publish adds message into history hub and calls node method to handle message.
// We don't have any PUB/SUB here as Memory Engine is single node only.
func (b *MemoryBroker) Publish(ch string, data []byte, opts PublishOptions) (StreamPosition, error) {
mu := b.pubLock(ch)
mu.Lock()
defer mu.Unlock()
pub := &Publication{
Data: data,
Info: opts.ClientInfo,
}
if opts.HistorySize > 0 && opts.HistoryTTL > 0 {
streamTop, err := b.historyHub.add(ch, pub, opts)
if err != nil {
return StreamPosition{}, err
}
pub.Offset = streamTop.Offset
return streamTop, b.eventHandler.HandlePublication(ch, pub, streamTop)
}
return StreamPosition{}, b.eventHandler.HandlePublication(ch, pub, StreamPosition{})
}
// PublishJoin - see Broker interface description.
func (b *MemoryBroker) PublishJoin(ch string, info *ClientInfo) error {
return b.eventHandler.HandleJoin(ch, info)
}
// PublishLeave - see Broker interface description.
func (b *MemoryBroker) PublishLeave(ch string, info *ClientInfo) error {
return b.eventHandler.HandleLeave(ch, info)
}
// PublishControl - see Broker interface description.
func (b *MemoryBroker) PublishControl(data []byte, _ string) error {
return b.eventHandler.HandleControl(data)
}
// Subscribe is noop here.
func (b *MemoryBroker) Subscribe(_ string) error {
return nil
}
// Unsubscribe node from channel. Noop here.
func (b *MemoryBroker) Unsubscribe(_ string) error {
return nil
}
// History - see Broker interface description.
func (b *MemoryBroker) History(ch string, filter HistoryFilter) ([]*Publication, StreamPosition, error) {
return b.historyHub.get(ch, filter)
}
// RemoveHistory - see Broker interface description.
func (b *MemoryBroker) RemoveHistory(ch string) error {
return b.historyHub.remove(ch)
}
type historyHub struct {
sync.RWMutex
streams map[string]*memstream.Stream
nextExpireCheck int64
expireQueue priority.Queue
expires map[string]int64
historyMetaTTL time.Duration
nextRemoveCheck int64
removeQueue priority.Queue
removes map[string]int64
}
func newHistoryHub(historyMetaTTL time.Duration) *historyHub {
return &historyHub{
streams: make(map[string]*memstream.Stream),
expireQueue: priority.MakeQueue(),
expires: make(map[string]int64),
historyMetaTTL: historyMetaTTL,
removeQueue: priority.MakeQueue(),
removes: make(map[string]int64),
}
}
func (h *historyHub) runCleanups() {
go h.expireStreams()
if h.historyMetaTTL > 0 {
go h.removeStreams()
}
}
func (h *historyHub) removeStreams() {
var nextRemoveCheck int64
for {
time.Sleep(time.Second)
h.Lock()
if h.nextRemoveCheck == 0 || h.nextRemoveCheck > time.Now().Unix() {
h.Unlock()
continue
}
nextRemoveCheck = 0
for h.removeQueue.Len() > 0 {
item := heap.Pop(&h.removeQueue).(*priority.Item)
expireAt := item.Priority
if expireAt > time.Now().Unix() {
heap.Push(&h.removeQueue, item)
nextRemoveCheck = expireAt
break
}
ch := item.Value
exp, ok := h.removes[ch]
if !ok {
continue
}
if exp <= expireAt {
delete(h.removes, ch)
delete(h.streams, ch)
} else {
heap.Push(&h.removeQueue, &priority.Item{Value: ch, Priority: exp})
}
}
h.nextRemoveCheck = nextRemoveCheck
h.Unlock()
}
}
func (h *historyHub) expireStreams() {
var nextExpireCheck int64
for {
time.Sleep(time.Second)
h.Lock()
if h.nextExpireCheck == 0 || h.nextExpireCheck > time.Now().Unix() {
h.Unlock()
continue
}
nextExpireCheck = 0
for h.expireQueue.Len() > 0 {
item := heap.Pop(&h.expireQueue).(*priority.Item)
expireAt := item.Priority
if expireAt > time.Now().Unix() {
heap.Push(&h.expireQueue, item)
nextExpireCheck = expireAt
break
}
ch := item.Value
exp, ok := h.expires[ch]
if !ok {
continue
}
if exp <= expireAt {
delete(h.expires, ch)
if stream, ok := h.streams[ch]; ok {
stream.Clear()
}
} else {
heap.Push(&h.expireQueue, &priority.Item{Value: ch, Priority: exp})
}
}
h.nextExpireCheck = nextExpireCheck
h.Unlock()
}
}
func (h *historyHub) add(ch string, pub *Publication, opts PublishOptions) (StreamPosition, error) {
h.Lock()
defer h.Unlock()
var index uint64
var epoch string
expireAt := time.Now().Unix() + int64(opts.HistoryTTL.Seconds())
if _, ok := h.expires[ch]; !ok {
heap.Push(&h.expireQueue, &priority.Item{Value: ch, Priority: expireAt})
}
h.expires[ch] = expireAt
if h.nextExpireCheck == 0 || h.nextExpireCheck > expireAt {
h.nextExpireCheck = expireAt
}
if h.historyMetaTTL > 0 {
removeAt := time.Now().Unix() + int64(h.historyMetaTTL.Seconds())
if _, ok := h.removes[ch]; !ok {
heap.Push(&h.removeQueue, &priority.Item{Value: ch, Priority: removeAt})
}
h.removes[ch] = removeAt
if h.nextRemoveCheck == 0 || h.nextRemoveCheck > removeAt {
h.nextRemoveCheck = removeAt
}
}
if stream, ok := h.streams[ch]; ok {
index, _ = stream.Add(pub, opts.HistorySize)
epoch = stream.Epoch()
} else {
stream := memstream.New()
index, _ = stream.Add(pub, opts.HistorySize)
epoch = stream.Epoch()
h.streams[ch] = stream
}
pub.Offset = index
return StreamPosition{Offset: index, Epoch: epoch}, nil
}
// Lock must be held outside.
func (h *historyHub) createStream(ch string) StreamPosition {
stream := memstream.New()
h.streams[ch] = stream
streamPosition := StreamPosition{}
streamPosition.Offset = 0
streamPosition.Epoch = stream.Epoch()
return streamPosition
}
func getPosition(stream *memstream.Stream) StreamPosition {
streamPosition := StreamPosition{}
streamPosition.Offset = stream.Top()
streamPosition.Epoch = stream.Epoch()
return streamPosition
}
func (h *historyHub) get(ch string, filter HistoryFilter) ([]*Publication, StreamPosition, error) {
h.Lock()
defer h.Unlock()
if h.historyMetaTTL > 0 {
removeAt := time.Now().Unix() + int64(h.historyMetaTTL.Seconds())
if _, ok := h.removes[ch]; !ok {
heap.Push(&h.removeQueue, &priority.Item{Value: ch, Priority: removeAt})
}
h.removes[ch] = removeAt
if h.nextRemoveCheck == 0 || h.nextRemoveCheck > removeAt {
h.nextRemoveCheck = removeAt
}
}
stream, ok := h.streams[ch]
if !ok {
return nil, h.createStream(ch), nil
}
if filter.Since == nil {
if filter.Limit == 0 {
return nil, getPosition(stream), nil
}
items, _, err := stream.Get(0, filter.Limit)
if err != nil {
return nil, StreamPosition{}, err
}
pubs := make([]*Publication, 0, len(items))
for _, item := range items {
pub := item.Value.(*Publication)
pubs = append(pubs, pub)
}
return pubs, getPosition(stream), nil
}
since := filter.Since
streamPosition := getPosition(stream)
if streamPosition.Offset == since.Offset && since.Epoch == stream.Epoch() {
return nil, streamPosition, nil
}
streamOffset := since.Offset + 1
items, _, err := stream.Get(streamOffset, filter.Limit)
if err != nil {
return nil, StreamPosition{}, err
}
pubs := make([]*Publication, 0, len(items))
for _, item := range items {
pub := item.Value.(*Publication)
pubs = append(pubs, pub)
}
return pubs, streamPosition, nil
}
func (h *historyHub) remove(ch string) error {
h.Lock()
defer h.Unlock()
if stream, ok := h.streams[ch]; ok {
stream.Clear()
}
return nil
}
|