2016-05-13 06:51:48 +03:00
|
|
|
// Copyright 2015 The etcd Authors
|
2015-01-25 06:19:16 +03:00
|
|
|
//
|
|
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
// you may not use this file except in compliance with the License.
|
|
|
|
// You may obtain a copy of the License at
|
|
|
|
//
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
//
|
|
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
// See the License for the specific language governing permissions and
|
|
|
|
// limitations under the License.
|
2013-10-07 20:44:51 +04:00
|
|
|
|
2013-09-29 03:26:19 +04:00
|
|
|
package store
|
2013-09-03 22:30:42 +04:00
|
|
|
|
2014-09-09 03:56:10 +04:00
|
|
|
type Watcher interface {
|
|
|
|
EventChan() chan *Event
|
2014-09-26 22:34:11 +04:00
|
|
|
StartIndex() uint64 // The EtcdIndex at which the Watcher was created
|
2014-09-09 03:56:10 +04:00
|
|
|
Remove()
|
|
|
|
}
|
|
|
|
|
|
|
|
type watcher struct {
|
|
|
|
eventChan chan *Event
|
2014-01-09 11:28:33 +04:00
|
|
|
stream bool
|
2013-09-16 17:16:22 +04:00
|
|
|
recursive bool
|
|
|
|
sinceIndex uint64
|
2014-09-26 22:34:11 +04:00
|
|
|
startIndex uint64
|
2014-02-15 04:16:55 +04:00
|
|
|
hub *watcherHub
|
2014-01-09 11:28:33 +04:00
|
|
|
removed bool
|
2014-01-09 09:29:04 +04:00
|
|
|
remove func()
|
2013-09-07 06:05:11 +04:00
|
|
|
}
|
|
|
|
|
2014-09-09 03:56:10 +04:00
|
|
|
func (w *watcher) EventChan() chan *Event {
|
|
|
|
return w.eventChan
|
|
|
|
}
|
|
|
|
|
2014-09-26 22:34:11 +04:00
|
|
|
func (w *watcher) StartIndex() uint64 {
|
|
|
|
return w.startIndex
|
|
|
|
}
|
|
|
|
|
2013-10-08 09:17:58 +04:00
|
|
|
// notify function notifies the watcher. If the watcher interests in the given path,
|
|
|
|
// the function will return true.
|
2014-09-09 03:56:10 +04:00
|
|
|
func (w *watcher) notify(e *Event, originalPath bool, deleted bool) bool {
|
2013-10-08 09:17:58 +04:00
|
|
|
// watcher is interested the path in three cases and under one condition
|
|
|
|
// the condition is that the event happens after the watcher's sinceIndex
|
2013-09-07 06:05:11 +04:00
|
|
|
|
2013-10-08 09:17:58 +04:00
|
|
|
// 1. the path at which the event happens is the path the watcher is watching at.
|
|
|
|
// For example if the watcher is watching at "/foo" and the event happens at "/foo",
|
|
|
|
// the watcher must be interested in that event.
|
2013-09-07 06:05:11 +04:00
|
|
|
|
2013-10-08 09:17:58 +04:00
|
|
|
// 2. the watcher is a recursive watcher, it interests in the event happens after
|
|
|
|
// its watching path. For example if watcher A watches at "/foo" and it is a recursive
|
|
|
|
// one, it will interest in the event happens at "/foo/bar".
|
2013-09-30 09:06:18 +04:00
|
|
|
|
2013-10-08 09:17:58 +04:00
|
|
|
// 3. when we delete a directory, we need to force notify all the watchers who watches
|
|
|
|
// at the file we need to delete.
|
|
|
|
// For example a watcher is watching at "/foo/bar". And we deletes "/foo". The watcher
|
|
|
|
// should get notified even if "/foo" is not the path it is watching.
|
2013-11-10 08:49:19 +04:00
|
|
|
if (w.recursive || originalPath || deleted) && e.Index() >= w.sinceIndex {
|
2014-09-09 03:56:10 +04:00
|
|
|
// We cannot block here if the eventChan capacity is full, otherwise
|
|
|
|
// etcd will hang. eventChan capacity is full when the rate of
|
2014-01-09 14:26:21 +04:00
|
|
|
// notifications are higher than our send rate.
|
|
|
|
// If this happens, we close the channel.
|
2014-01-09 11:28:33 +04:00
|
|
|
select {
|
2014-09-09 03:56:10 +04:00
|
|
|
case w.eventChan <- e:
|
2014-01-09 11:28:33 +04:00
|
|
|
default:
|
2014-02-15 04:16:55 +04:00
|
|
|
// We have missed a notification. Remove the watcher.
|
2014-09-09 03:56:10 +04:00
|
|
|
// Removing the watcher also closes the eventChan.
|
2014-02-15 04:16:55 +04:00
|
|
|
w.remove()
|
2014-01-09 11:28:33 +04:00
|
|
|
}
|
2013-10-08 09:17:58 +04:00
|
|
|
return true
|
2013-09-29 04:41:02 +04:00
|
|
|
}
|
2013-10-08 09:17:58 +04:00
|
|
|
return false
|
2013-09-29 03:58:57 +04:00
|
|
|
}
|
2014-01-09 09:29:04 +04:00
|
|
|
|
|
|
|
// Remove removes the watcher from watcherHub
|
2014-01-09 11:28:33 +04:00
|
|
|
// The actual remove function is guaranteed to only be executed once
|
2014-09-09 03:56:10 +04:00
|
|
|
func (w *watcher) Remove() {
|
2014-02-15 04:16:55 +04:00
|
|
|
w.hub.mutex.Lock()
|
|
|
|
defer w.hub.mutex.Unlock()
|
|
|
|
|
2014-09-09 03:56:10 +04:00
|
|
|
close(w.eventChan)
|
2014-07-15 20:45:54 +04:00
|
|
|
if w.remove != nil {
|
|
|
|
w.remove()
|
|
|
|
}
|
2014-01-09 09:29:04 +04:00
|
|
|
}
|
2016-01-04 22:24:49 +03:00
|
|
|
|
|
|
|
// nopWatcher is a watcher that receives nothing, always blocking.
|
|
|
|
type nopWatcher struct{}
|
|
|
|
|
|
|
|
func NewNopWatcher() Watcher { return &nopWatcher{} }
|
|
|
|
func (w *nopWatcher) EventChan() chan *Event { return nil }
|
|
|
|
func (w *nopWatcher) StartIndex() uint64 { return 0 }
|
|
|
|
func (w *nopWatcher) Remove() {}
|