Upstream/harbor
1
0
Fork 0
mirror of https://github.com/goharbor/harbor.git synced 2025-02-17 04:11:24 +01:00
Code Issues Projects Releases Wiki Activity

Update commnets of exported methods and structs

Browse Source
This commit is contained in:
Steven Zou 2017-07-05 17:57:20 +08:00
parent 2bc557b559
commit 5a5eb1d377
4 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/common/scheduler/policy/alternate_policy.go
View File

@ -6,18 +6,18 @@ import "time"
//AlternatePolicyConfiguration store the related configurations for alternate policy. //AlternatePolicyConfiguration store the related configurations for alternate policy.
type AlternatePolicyConfiguration struct { type AlternatePolicyConfiguration struct {
//The interval of executing attached tasks. //Duration is the interval of executing attached tasks.
Duration time.Duration Duration time.Duration
//The execution time point of each turn //OffsetTime is the execution time point of each turn
//It's a number to indicate the seconds offset to the 00:00 of UTC time. //It's a number to indicate the seconds offset to the 00:00 of UTC time.
OffsetTime int64 OffsetTime int64
//Time should be later than start time. //StartTimestamp is the time should be later than start time.
//If set <=0 value, no limitation. //If set <=0 value, no limitation.
StartTimestamp int64 StartTimestamp int64
//Time should be earlier than end time. //EndTimestamp is the time should be earlier than end time.
//If set <=0 value, no limitation. //If set <=0 value, no limitation.
EndTimestamp int64 EndTimestamp int64
} }

6
src/common/scheduler/policy/policy.go
View File

@ -12,13 +12,13 @@ import "github.com/vmware/harbor/src/common/scheduler/task"
//Please be aware that policy with no tasks will be treated as invalid. //Please be aware that policy with no tasks will be treated as invalid.
// //
type Policy interface { type Policy interface {
//Return the name of the policy. //Name will return the name of the policy.
Name() string Name() string
//Return the attached tasks with this policy. //Tasks will return the attached tasks with this policy.
Tasks() []task.Task Tasks() []task.Task
//Attach tasks to this policy //AttachTasks is to attach tasks to this policy
AttachTasks(...task.Task) error AttachTasks(...task.Task) error
//Done will setup a channel for other components to check whether or not //Done will setup a channel for other components to check whether or not

6
src/common/scheduler/scheduler_store.go
View File

@ -15,7 +15,7 @@ type Store interface {
//Get the corresponding policy with the key. //Get the corresponding policy with the key.
Get(key string) *Watcher Get(key string) *Watcher
//Check if the key existing in the store. //Exists is to check if the key existing in the store.
Exists(key string) bool Exists(key string) bool
//Remove the specified policy and return its reference. //Remove the specified policy and return its reference.
@ -24,7 +24,7 @@ type Store interface {
//Size return the total count of items in store. //Size return the total count of items in store.
Size() uint32 Size() uint32
//Get all the items in the store. //GetAll is to get all the items in the store.
GetAll() []*Watcher GetAll() []*Watcher
//Clear store. //Clear store.
@ -112,7 +112,7 @@ func (cs *ConcurrentStore) Size() uint32 {
return (uint32)(len(cs.data)) return (uint32)(len(cs.data))
} }
//Get all the items of store. //GetAll to get all the items of store.
func (cs *ConcurrentStore) GetAll() []*Watcher { func (cs *ConcurrentStore) GetAll() []*Watcher {
all := []*Watcher{} all := []*Watcher{}

2
src/common/scheduler/task/task.go
View File

@ -2,7 +2,7 @@ package task
//Task is used to synchronously run specific action(s). //Task is used to synchronously run specific action(s).
type Task interface { type Task interface {
//Name of the task. //TaskName should return the name of the task.
TaskName() string TaskName() string
//Run the concrete code here //Run the concrete code here