Skip to content

feat: add expire time #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 2, 2025
Merged

feat: add expire time #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions task.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,28 @@ func (t *Task) Activated() bool {
return t.taskEntry != nil && t.taskEntry.activated()
}

// Expiry return the milliseconds as a Unix time when the task will be expired.
// the number of milliseconds elapsed since January 1, 1970 UTC.
// the value -1 indicate the task not activated.
func (t *Task) Expiry() int64 {
t.rw.RLock()
defer t.rw.RUnlock()
if t.taskEntry != nil && t.taskEntry.activated() {
return t.taskEntry.ExpirationMs()
}
return -1
}

// ExpiryAt return the local time when the task will be expired.
// the zero time indicate the task not activated.
func (t *Task) ExpiryAt() time.Time {
if ms := t.Expiry(); ms < 0 {
return time.Time{}
} else {
return time.UnixMilli(ms)
}
}

// setBelongTo set the task belongs to the task entry.
func (t *Task) setBelongTo(te *taskEntry) {
t.rw.Lock()
Expand Down
2 changes: 1 addition & 1 deletion task_entry.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ type taskEntry struct {
func newTaskEntry(task *Task) *taskEntry {
te := &taskEntry{
task: task,
expirationMs: int64(task.Delay()/timeUnit) + time.Now().UnixMilli(),
expirationMs: int64(task.Delay()/time.Millisecond) + time.Now().UnixMilli(),
}
task.setBelongTo(te)
return te
Expand Down
32 changes: 31 additions & 1 deletion task_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,36 @@ func Test_Task_RecoverPanic(t *testing.T) {
}

func Test_Task_Activated(t *testing.T) {
task := NewTask(100 * time.Millisecond)
tm := NewTimer()
tm.Start()
task := NewTask(10 * time.Millisecond)
require.False(t, task.Activated())
err := tm.AddTask(task)
require.Nil(t, err)
require.True(t, task.Activated())
time.Sleep(time.Millisecond * 20)
require.False(t, task.Activated())
}

func Test_Task_Expiry(t *testing.T) {
delayMs := 10 * time.Millisecond

tm := NewTimer()
tm.Start()
task := NewTask(delayMs)
require.Equal(t, int64(-1), task.Expiry())
require.True(t, task.ExpiryAt().IsZero())

expiryAt := time.Now().Add(delayMs)
err := tm.AddTask(task)
require.Nil(t, err)

wantExpiryMs := expiryAt.UnixMilli()
wantExpiryAt := time.UnixMilli(wantExpiryMs)
require.Equal(t, wantExpiryMs, task.Expiry())
require.Equal(t, wantExpiryAt, task.ExpiryAt())

time.Sleep(time.Millisecond * 20)
require.Equal(t, int64(-1), task.Expiry())
require.True(t, task.ExpiryAt().IsZero())
}
2 changes: 0 additions & 2 deletions timer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ const (
DefaultTickMs = 1
// DefaultWheelSize default wheel size.
DefaultWheelSize = 512
// timeUnit time unit is milliseconds.
timeUnit = time.Millisecond
)

// ErrClosed is returned when the timer is closed.
Expand Down
Loading