├── README.md ├── Makefile ├── .gitignore ├── timer_test.go ├── timer.go └── LICENSE /README.md: -------------------------------------------------------------------------------- 1 | # goTimer 2 | Timer framework in Golang 3 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | all: 2 | go build 3 | 4 | test: 5 | go test . 6 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled Object files, Static and Dynamic libs (Shared Objects) 2 | *.o 3 | *.a 4 | *.so 5 | 6 | # Folders 7 | _obj 8 | _test 9 | 10 | # Architecture specific extensions/prefixes 11 | *.[568vq] 12 | [568vq].out 13 | 14 | *.cgo1.go 15 | *.cgo2.c 16 | _cgo_defun.c 17 | _cgo_gotypes.go 18 | _cgo_export.* 19 | 20 | _testmain.go 21 | 22 | *.exe 23 | *.test 24 | *.prof 25 | 26 | *~ 27 | -------------------------------------------------------------------------------- /timer_test.go: -------------------------------------------------------------------------------- 1 | package timer_test 2 | 3 | import ( 4 | "fmt" 5 | "testing" 6 | "time" 7 | 8 | "math/rand" 9 | 10 | "log" 11 | 12 | "runtime/pprof" 13 | 14 | "os" 15 | 16 | "github.com/xiaonanln/goTimer" 17 | ) 18 | 19 | func init() { 20 | timer.StartTicks(time.Millisecond) 21 | } 22 | 23 | func TestCallback(t *testing.T) { 24 | INTERVAL := 100 * time.Millisecond 25 | for i := 0; i < 10; i++ { 26 | x := false 27 | timer.AddCallback(INTERVAL, func() { 28 | fmt.Println("callback!") 29 | x = true 30 | }) 31 | time.Sleep(INTERVAL * 2) 32 | if !x { 33 | t.Fatalf("x should be true, but it's false") 34 | } 35 | } 36 | } 37 | 38 | func TestTimer(t *testing.T) { 39 | INTERVAL := 100 * time.Millisecond 40 | x := 0 41 | px := x 42 | now := time.Now() 43 | nextTime := now.Add(INTERVAL) 44 | fmt.Printf("now is %s, next time should be %s\n", time.Now(), nextTime) 45 | 46 | timer.AddTimer(INTERVAL, func() { 47 | x += 1 48 | fmt.Printf("timer %s x %v px %v\n", time.Now(), x, px) 49 | }) 50 | //time.Sleep(time.Second) 51 | 52 | for i := 0; i < 10; i++ { 53 | time.Sleep(nextTime.Add(INTERVAL / 2).Sub(time.Now())) 54 | fmt.Printf("Check x %v px %v @ %s\n", x, px, time.Now()) 55 | if x != px+1 { 56 | t.Fatalf("x should be %d, but it's %d", px+1, x) 57 | } 58 | px = x 59 | nextTime = nextTime.Add(INTERVAL) 60 | fmt.Printf("now is %s, next time should be %s\n", time.Now(), nextTime) 61 | } 62 | } 63 | 64 | func TestCallbackSeq(t *testing.T) { 65 | a := 0 66 | d := time.Second 67 | 68 | for i := 0; i < 100; i++ { 69 | i := i 70 | timer.AddCallback(d, func() { 71 | if a != i { 72 | t.Error(i, a) 73 | } 74 | 75 | a += 1 76 | }) 77 | } 78 | time.Sleep(d + time.Second*1) 79 | } 80 | 81 | func TestCancelCallback(t *testing.T) { 82 | INTERVAL := 20 * time.Millisecond 83 | x := 0 84 | 85 | timer := timer.AddCallback(INTERVAL, func() { 86 | x = 1 87 | }) 88 | if !timer.IsActive() { 89 | t.Fatalf("timer should be active") 90 | } 91 | timer.Cancel() 92 | if timer.IsActive() { 93 | t.Fatalf("timer should be inactive") 94 | } 95 | time.Sleep(INTERVAL * 2) 96 | if x != 0 { 97 | t.Fatalf("x should be 0, but is %v", x) 98 | } 99 | } 100 | 101 | func TestCancelTimer(t *testing.T) { 102 | INTERVAL := 20 * time.Millisecond 103 | x := 0 104 | timer := timer.AddTimer(INTERVAL, func() { 105 | x += 1 106 | }) 107 | if !timer.IsActive() { 108 | t.Fatalf("timer should be active") 109 | } 110 | timer.Cancel() 111 | if timer.IsActive() { 112 | t.Fatalf("timer should be inactive") 113 | } 114 | time.Sleep(INTERVAL * 2) 115 | if x != 0 { 116 | t.Fatalf("x should be 0, but is %v", x) 117 | } 118 | } 119 | 120 | func TestTimerPerformance(t *testing.T) { 121 | f, err := os.Create("TestTimerPerformance.cpuprof") 122 | if err != nil { 123 | panic(err) 124 | } 125 | 126 | pprof.StartCPUProfile(f) 127 | duration := 10 * time.Second 128 | 129 | for i := 0; i < 400000; i++ { 130 | if rand.Float32() < 0.5 { 131 | d := time.Duration(rand.Int63n(int64(duration))) 132 | timer.AddCallback(d, func() {}) 133 | } else { 134 | d := time.Duration(rand.Int63n(int64(time.Second))) 135 | timer.AddTimer(d, func() {}) 136 | } 137 | } 138 | 139 | log.Println("Waiting for", duration, "...") 140 | time.Sleep(duration) 141 | pprof.StopCPUProfile() 142 | } 143 | -------------------------------------------------------------------------------- /timer.go: -------------------------------------------------------------------------------- 1 | package timer 2 | 3 | import ( 4 | "container/heap" 5 | "fmt" 6 | "os" 7 | "runtime/debug" 8 | "sync" 9 | "time" 10 | ) 11 | 12 | const ( 13 | MIN_TIMER_INTERVAL = 1 * time.Millisecond 14 | ) 15 | 16 | var ( 17 | nextAddSeq uint = 1 18 | ) 19 | 20 | type Timer struct { 21 | fireTime time.Time 22 | interval time.Duration 23 | callback CallbackFunc 24 | repeat bool 25 | addseq uint 26 | } 27 | 28 | func (t *Timer) Cancel() { 29 | t.callback = nil 30 | } 31 | 32 | func (t *Timer) IsActive() bool { 33 | return t.callback != nil 34 | } 35 | 36 | type _TimerHeap struct { 37 | timers []*Timer 38 | } 39 | 40 | func (h *_TimerHeap) Len() int { 41 | return len(h.timers) 42 | } 43 | 44 | func (h *_TimerHeap) Less(i, j int) bool { 45 | //log.Println(h.timers[i].fireTime, h.timers[j].fireTime) 46 | t1, t2 := h.timers[i].fireTime, h.timers[j].fireTime 47 | if t1.Before(t2) { 48 | return true 49 | } 50 | 51 | if t1.After(t2) { 52 | return false 53 | } 54 | // t1 == t2, making sure Timer with same deadline is fired according to their add order 55 | return h.timers[i].addseq < h.timers[j].addseq 56 | } 57 | 58 | func (h *_TimerHeap) Swap(i, j int) { 59 | var tmp *Timer 60 | tmp = h.timers[i] 61 | h.timers[i] = h.timers[j] 62 | h.timers[j] = tmp 63 | } 64 | 65 | func (h *_TimerHeap) Push(x interface{}) { 66 | h.timers = append(h.timers, x.(*Timer)) 67 | } 68 | 69 | func (h *_TimerHeap) Pop() (ret interface{}) { 70 | l := len(h.timers) 71 | h.timers, ret = h.timers[:l-1], h.timers[l-1] 72 | return 73 | } 74 | 75 | // Type of callback function 76 | type CallbackFunc func() 77 | 78 | var ( 79 | timerHeap _TimerHeap 80 | timerHeapLock sync.Mutex 81 | ) 82 | 83 | func init() { 84 | heap.Init(&timerHeap) 85 | } 86 | 87 | // Add a callback which will be called after specified duration 88 | func AddCallback(d time.Duration, callback CallbackFunc) *Timer { 89 | t := &Timer{ 90 | fireTime: time.Now().Add(d), 91 | interval: d, 92 | callback: callback, 93 | repeat: false, 94 | } 95 | timerHeapLock.Lock() 96 | t.addseq = nextAddSeq // set addseq when locked 97 | nextAddSeq += 1 98 | 99 | heap.Push(&timerHeap, t) 100 | timerHeapLock.Unlock() 101 | return t 102 | } 103 | 104 | // Add a timer which calls callback periodly 105 | func AddTimer(d time.Duration, callback CallbackFunc) *Timer { 106 | if d < MIN_TIMER_INTERVAL { 107 | d = MIN_TIMER_INTERVAL 108 | } 109 | 110 | t := &Timer{ 111 | fireTime: time.Now().Add(d), 112 | interval: d, 113 | callback: callback, 114 | repeat: true, 115 | } 116 | timerHeapLock.Lock() 117 | t.addseq = nextAddSeq // set addseq when locked 118 | nextAddSeq += 1 119 | 120 | heap.Push(&timerHeap, t) 121 | timerHeapLock.Unlock() 122 | return t 123 | } 124 | 125 | // Tick once for timers 126 | func Tick() { 127 | now := time.Now() 128 | timerHeapLock.Lock() 129 | 130 | for { 131 | if timerHeap.Len() <= 0 { 132 | break 133 | } 134 | 135 | nextFireTime := timerHeap.timers[0].fireTime 136 | //fmt.Printf(">>> nextFireTime %s, now is %s\n", nextFireTime, now) 137 | if nextFireTime.After(now) { 138 | break 139 | } 140 | 141 | t := heap.Pop(&timerHeap).(*Timer) 142 | 143 | callback := t.callback 144 | if callback == nil { 145 | continue 146 | } 147 | 148 | if !t.repeat { 149 | t.callback = nil 150 | } 151 | // unlock the lock to run callback, because callback may add more callbacks / timers 152 | timerHeapLock.Unlock() 153 | runCallback(callback) 154 | timerHeapLock.Lock() 155 | 156 | if t.repeat { 157 | // add Timer back to heap 158 | t.fireTime = t.fireTime.Add(t.interval) 159 | if !t.fireTime.After(now) { // might happen when interval is very small 160 | t.fireTime = now.Add(t.interval) 161 | } 162 | t.addseq = nextAddSeq 163 | nextAddSeq += 1 164 | heap.Push(&timerHeap, t) 165 | } 166 | } 167 | timerHeapLock.Unlock() 168 | } 169 | 170 | // Start the self-ticking routine, which ticks per tickInterval 171 | func StartTicks(tickInterval time.Duration) { 172 | go selfTickRoutine(tickInterval) 173 | } 174 | 175 | func selfTickRoutine(tickInterval time.Duration) { 176 | for { 177 | time.Sleep(tickInterval) 178 | Tick() 179 | } 180 | } 181 | 182 | func runCallback(callback CallbackFunc) { 183 | defer func() { 184 | err := recover() 185 | if err != nil { 186 | fmt.Fprintf(os.Stderr, "Callback %v paniced: %v\n", callback, err) 187 | debug.PrintStack() 188 | } 189 | }() 190 | callback() 191 | } 192 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------