task

package
v0.2.3-hf.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 3, 2023 License: GPL-3.0 Imports: 4 Imported by: 0

README

Task

Task is an abstract interface to describe the smallest unit of SP background service how to interact.

Task Type

There are three main types of task: ApprovalTask, ObjectTask and GCTask.

ApprovalTask is used to record approval information for users creating buckets and objects. Primary SP approval is required before serving the bucket and object. If SP approves the message, it will sign the approval message. The greenfield will verify the signature of the approval message to determine whether the SP accepts the bucket and object. When primary replicating pieces to secondary SPs, the approval message is broadcast to other SPs. If they approve the message, the primary SP will select some of them to replicate the pieces to. Before receiving the pieces, the selected SPs will verify the signature of the approval message. ApprovalTask includes ApprovalCreateBucketTask, ApprovalCreateBucketTask and ApprovalReplicatePieceTask.

ObjectTask is associated with an object and records information about its different stages. This includes UploadObjectTask, which uploads the object payload data to the primary SP, ReplicatePieceTask, which replicates the object pieces to the secondary SPs, and the ReceivePieceTask, which is exclusive to the secondary SP and records information about receiving the piece. The secondary SP uses this information to confirm whether the object was successfully sealed on the greenfield, ensuring a return of the secondary SP. SealObjectTask seals the object on Greenfield, while the DownloadObjectTask allows the user to download part or all of the object payload data. ChallengePieceTask provides the validator with challenge piece information, which they can use to challenge the SP if they suspect that the user's payload data was not stored correctly.

GCTask is an abstract interface that records information about garbage collection. This includes GCObjectTask, which collects piece store space by deleting payload data that has been deleted on the greenfield, GCZombiePieceTask, which collects piece store space by deleting zombie piece data that resulted from any exception where the piece data meta is not on Greenfield chain, and GCMetaTask, which collects the SP meta store space by deleting expired data.

Approval Task

ApprovalTask is an abstract interface to record the ask approval information, the approval task timeliness uses the block height, if reached expired height, the approval invalid.

ApprovalCreateBucketTask

ApprovalCreateBucketTask is an abstract interface to record the ask create bucket approval information. The user account will create MsgCreateBucket, the SP should decide whether approved the request based on the MsgCreateBucket. If so, the sp will SetExpiredHeight and signs the MsgCreateBucket.

ApprovalCreateObjectTask

ApprovalCreateObjectTask is an abstract interface to record the ask create object approval information. The user account will create MsgCreateObject, the SP should decide whether approved the request based on the MsgCreateObject. If so, the sp will SetExpiredHeight and signs the MsgCreateObject.

ApprovalReplicatePieceTask

ApprovalReplicatePieceTask is an abstract interface to record the ask replicate pieces to other SPs(as secondary SP for the object). It is initiated by the primary SP in the replicate pieces phase. Before the primary SP sends it to other SPs, the primary SP will sign the task, other SPs will verify it is sent by a legitimate SP. If other SPs approved the approval, they will SetExpiredHeight and signs the ApprovalReplicatePieceTask.

Object Task

The ObjectTask associated with an object and storage params, and records the information of different stages of the object. Considering the change of storage params on the greenfield, the storage params of each object should be determined when it is created, and it should not be queried during the task flow, which is inefficient and error-prone.

UploadObjectTask

The UploadObjectTask is an abstract interface to record the information for uploading object payload data to the primary SP.

ReplicatePieceTask

The ReplicatePieceTask is an abstract interface to record the information for replicating pieces of object payload data to secondary SPs.

ReceivePieceTask

The ReceivePieceTask is an abstract interface to record the information for receiving pieces of object payload data from primary SP, it exists only in secondary SP.

SealObjectTask

The SealObjectTask is an abstract interface to record the information for sealing object to the Greenfield chain.

DownloadObjectTask

The DownloadObjectTask is an abstract interface to record the information for downloading pieces of object payload data.

ChallengePieceTask

ChallengePieceTask is an abstract interface to record the information for get challenge piece info, the validator get challenge info to confirm whether the sp stores the user's data correctly.

GC Task
GCObjectTask

The GCObjectTask is an abstract interface to record the information for collecting the piece store space by deleting object payload data that the object has been deleted on Greenfield chain.

GCZombiePieceTask

The GCZombiePieceTask is an abstract interface to record the information for collecting the piece store space by deleting zombie pieces data that dues to any exception, the piece data meta is not on chain but the pieces has been store in piece store.

GCMetaTask

The GCMetaTask is an abstract interface to record the information for collecting the SP meta store space by deleting the expired data.

Task Priority

Each type of task has a priority, the range of priority is [0, 255], the higher the priority, the higher the urgency to be executed, the greater the probability of being executed by priority scheduling.

Task Priority Level

Task priority is divided into three levels, TLowPriorityLevel, TMediumPriorityLevel, THighPriorityLevel. The TLowPriorityLevel default priority range is [0, 85), The TMediumPriorityLevel default priority range is [85, 170), The THighPriorityLevel default priority range is [170, 256). When allocating for task execution resources from ResourceManager, the resources are allocated according to task priority level, but not task priority, because task priority up to 256 levels, the task priority level make resource management easier.

Example:
    the resource limit configuration of task execution node :
        [TasksHighPriority: 30, TasksMediumPriority: 20, TasksLowPriority: 2]
    the executor of the task can run 30 high level tasks at the same time that the
        task priority between [170, 255]
    the executor of the task can run 20 medium level tasks at the same time that the
        task priority between [85, 170)
    the executor of the task can run 2 medium level tasks at the same time that the
        task priority < 85

Task Init

Each task needs to call its InitXXXTask method before use. This method requires passing in the necessary parameters of each type of task. These parameters will not be changed in most cases and are necessary, such as task priority, timeout, max retries, and necessary information for resource estimation.

Any changes to initialization parameters during task execution may cause unpredictable consequences. For example, changes in parameters that affect resource estimation may cause OOM, etc.

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var TypeTaskMap = map[TType]string{
	TypeTaskUnknown:                "UnknownTask",
	TypeTaskCreateBucketApproval:   "CreateBucketApprovalTask",
	TypeTaskMigrateBucketApproval:  "MigrateBucketApprovalTask",
	TypeTaskCreateObjectApproval:   "CreateObjectApprovalTask",
	TypeTaskReplicatePieceApproval: "ReplicatePieceApprovalTask",
	TypeTaskUpload:                 "UploadObjectTask",
	TypeTaskReplicatePiece:         "ReplicatePieceTask",
	TypeTaskSealObject:             "SealObjectTask",
	TypeTaskReceivePiece:           "ReceivePieceTask",
	TypeTaskDownloadObject:         "DownloadObjectTask",
	TypeTaskChallengePiece:         "ChallengePieceTask",
	TypeTaskGCObject:               "GCObjectTask",
	TypeTaskGCZombiePiece:          "GCZombiePieceTask",
	TypeTaskGCMeta:                 "GCMetaTask",
	TypeTaskRecoverPiece:           "RecoverPieceTask",
	TypeTaskMigrateGVG:             "MigrateGVGTask",
}

Functions

func TaskTypeName 

func TaskTypeName(taskType TType) string

Types

type ApprovalCreateBucketTask 

type ApprovalCreateBucketTask interface {
	ApprovalTask
	// InitApprovalCreateBucketTask inits the ApprovalCreateBucketTask by
	// MsgCreateBucket and task priority. SP only fill the MsgCreateBucket's
	// PrimarySpApproval field, can not change other fields.
	InitApprovalCreateBucketTask(string, *storagetypes.MsgCreateBucket, TPriority)
	// GetCreateBucketInfo returns the user's MsgCreateBucket.
	GetCreateBucketInfo() *storagetypes.MsgCreateBucket
	// SetCreateBucketInfo sets the MsgCreateBucket. Should try to avoid calling
	// this method, it will change the approval information.
	SetCreateBucketInfo(*storagetypes.MsgCreateBucket)
}

ApprovalCreateBucketTask is an abstract interface to record the ask create bucket approval information. The user account will create MsgCreateBucket, SP should decide whether approved the request based on the MsgCreateBucket. If so, SP will SetExpiredHeight and signs the MsgCreateBucket.

type ApprovalCreateObjectTask 

type ApprovalCreateObjectTask interface {
	ApprovalTask
	// InitApprovalCreateObjectTask inits the ApprovalCreateObjectTask by
	// MsgCreateObject and task priority. SP only fill the MsgCreateObject's
	// PrimarySpApproval field, can not change other fields.
	InitApprovalCreateObjectTask(string, *storagetypes.MsgCreateObject, TPriority)
	// GetCreateObjectInfo returns the user's MsgCreateObject.
	GetCreateObjectInfo() *storagetypes.MsgCreateObject
	// SetCreateObjectInfo sets the MsgCreateObject. Should try to avoid calling
	// this method, it will change the approval information.
	SetCreateObjectInfo(*storagetypes.MsgCreateObject)
}

ApprovalCreateObjectTask is an abstract interface to record the ask create object approval information. The user account will create MsgCreateObject, SP should decide whether approved the request based on the MsgCreateObject. If so, SP will SetExpiredHeight and signs the MsgCreateObject.

type ApprovalMigrateBucketTask added in v0.2.3 

type ApprovalMigrateBucketTask interface {
	ApprovalTask
	// InitApprovalMigrateBucketTask inits the ApprovalMigrateBucketTask by
	// MsgCreateBucket and task priority. SP only fill the MsgCreateBucket's
	// PrimarySpApproval field, can not change other fields.
	InitApprovalMigrateBucketTask(*storagetypes.MsgMigrateBucket, TPriority)
	// GetMigrateBucketInfo returns the user's MsgCreateBucket.
	GetMigrateBucketInfo() *storagetypes.MsgMigrateBucket
	// SetMigrateBucketInfo sets the MsgCreateBucket. Should try to avoid calling
	// this method, it will change the approval information.
	SetMigrateBucketInfo(*storagetypes.MsgMigrateBucket)
}

ApprovalMigrateBucketTask is an abstract interface to record the ask migrate bucket approval information. The user account will migrate MsgMigrateBucket, SP should decide whether approved the request based on the MsgMigrateBucket. If so, SP will SetExpiredHeight and signs the MsgMigrateBucket.

type ApprovalReplicatePieceTask 

type ApprovalReplicatePieceTask interface {
	ObjectTask
	ApprovalTask
	// InitApprovalReplicatePieceTask inits the ApprovalReplicatePieceTask by ObjectInfo,
	// storage params, task priority and primary operator address. the storage params
	// can affect the size of the data accepted by secondary SP, so this is a necessary
	// and cannot be changed parameter.
	InitApprovalReplicatePieceTask(object *storagetypes.ObjectInfo, params *storagetypes.Params, priority TPriority, askOpAddress string)
	// GetAskSpOperatorAddress returns the operator address of SP that initiated the ask
	// replicate piece approval request.
	GetAskSpOperatorAddress() string
	// SetAskSpOperatorAddress sets the operator address of SP that initiated the ask
	// replicate piece approval request. Should try to avoid calling this method,
	// it will change the approval information.
	SetAskSpOperatorAddress(string)
	// GetAskSignature returns the initiated signature of SP signature by its operator private key.
	GetAskSignature() []byte
	// SetAskSignature sets the initiated signature of SP by its operator private key.
	SetAskSignature([]byte)
	// GetApprovedSpOperatorAddress returns the approved operator address of SP.
	GetApprovedSpOperatorAddress() string
	// SetApprovedSpOperatorAddress sets the approved operator address of SP.
	SetApprovedSpOperatorAddress(string)
	// GetApprovedSignature returns the approved signature of SP.
	GetApprovedSignature() []byte
	// SetApprovedSignature sets the approved signature of SP.
	SetApprovedSignature([]byte)
	// GetApprovedSpEndpoint returns the approved endpoint of SP. It is used to replicate
	// pieces to secondary SP.
	GetApprovedSpEndpoint() string
	// SetApprovedSpEndpoint sets the approved endpoint of SP.
	SetApprovedSpEndpoint(string)
	// GetApprovedSpApprovalAddress returns the approved approval address of SP. It is
	// used to seal object on greenfield.
	GetApprovedSpApprovalAddress() string
	// SetApprovedSpApprovalAddress sets the approved approval address of SP.
	SetApprovedSpApprovalAddress(string)
	// GetSignBytes returns the bytes from the task for initiated and approved SPs
	// to sign.
	GetSignBytes() []byte
}

ApprovalReplicatePieceTask is an abstract interface to record the ask replicate pieces to other SPs(as secondary SP for the object). It is initiated by the primary SP in the replicate pieces phase. Before the primary SP sends it to other SPs, the primary SP will sign the task, other SPs will verify it is sent by a legitimate SP. If other SPs approved the approval, they will SetExpiredHeight and signs the ApprovalReplicatePieceTask.

type ApprovalTask 

type ApprovalTask interface {
	Task
	// GetExpiredHeight returns the expired height of the approval.
	GetExpiredHeight() uint64
	// SetExpiredHeight sets the expired height of the approval, when SP
	// approved the approval, it should set the expired height to stands
	// the approval timeliness. This is one of the ways SP prevents being
	// attacked.
	SetExpiredHeight(uint64)
}

ApprovalTask is an abstract interface to record the ask approval information. ApprovalTask uses block height to verify whether the approval is expired. If reached expired height, the approval invalid.

type ChallengePieceTask 

type ChallengePieceTask interface {
	ObjectTask
	// InitChallengePieceTask inits InitChallengePieceTask.
	InitChallengePieceTask(object *storagetypes.ObjectInfo, bucket *storagetypes.BucketInfo, params *storagetypes.Params,
		priority TPriority, userAddress string, replicateIdx int32, segmentIdx uint32, timeout int64, retry int64)
	// GetBucketInfo returns the BucketInfo of challenging piece
	GetBucketInfo() *storagetypes.BucketInfo
	// SetBucketInfo sets the BucketInfo of challenging piece
	SetBucketInfo(*storagetypes.BucketInfo)
	// GetUserAddress returns the user account of challenging object.
	// It is used to record the read bucket information.
	GetUserAddress() string
	// SetUserAddress sets the user account of challenging object.
	SetUserAddress(string)
	// GetSegmentIdx returns the segment index of challenge piece.
	GetSegmentIdx() uint32
	// SetSegmentIdx sets the segment index of challenge piece.
	SetSegmentIdx(uint32)
	// GetRedundancyIdx returns the replicate index of challenge piece.
	GetRedundancyIdx() int32
	// SetRedundancyIdx sets the replicate index of challenge piece.
	SetRedundancyIdx(idx int32)
	// GetIntegrityHash returns the integrity hash of the object.
	GetIntegrityHash() []byte
	// SetIntegrityHash sets the integrity hash of the object.
	SetIntegrityHash([]byte)
	// GetPieceHash returns the hash of  challenge piece.
	GetPieceHash() [][]byte
	// SetPieceHash sets the hash of  challenge piece.
	SetPieceHash([][]byte)
	// GetPieceDataSize returns the data of challenge piece.
	GetPieceDataSize() int64
	// SetPieceDataSize sets the data of challenge piece.
	SetPieceDataSize(int64)
}

ChallengePieceTask is an abstract interface to record the information for get challenge piece info, the validator get challenge info to confirm whether the sp stores the user's data correctly.

type DownloadObjectTask 

type DownloadObjectTask interface {
	ObjectTask
	// InitDownloadObjectTask inits DownloadObjectTask.
	InitDownloadObjectTask(object *storagetypes.ObjectInfo, bucket *storagetypes.BucketInfo, params *storagetypes.Params,
		priority TPriority, userAddress string, low int64, high int64, timeout int64, retry int64)
	// GetBucketInfo returns the BucketInfo of the download object.
	// It is used to Query and calculate bucket read quota.
	GetBucketInfo() *storagetypes.BucketInfo
	// SetBucketInfo sets the BucketInfo of the download object.
	SetBucketInfo(*storagetypes.BucketInfo)
	// GetSize returns the download payload data size, high - low + 1.
	GetSize() int64
	// GetLow returns the start offset of download payload data.
	GetLow() int64
	// GetHigh returns the end offset of download payload data.
	GetHigh() int64
}

DownloadObjectTask is an abstract interface to record the information for downloading pieces of object payload data.

type DownloadPieceTask 

type DownloadPieceTask interface {
	ObjectTask
	// InitDownloadPieceTask inits DownloadPieceTask.
	InitDownloadPieceTask(object *storagetypes.ObjectInfo, bucket *storagetypes.BucketInfo, params *storagetypes.Params,
		priority TPriority, enableCheck bool, userAddress string, totalSize uint64, pieceKey string, pieceOffset uint64,
		pieceLength uint64, timeout int64, maxRetry int64)
	// GetBucketInfo returns the BucketInfo of the download object.
	// It is used to Query and calculate bucket read quota.
	GetBucketInfo() *storagetypes.BucketInfo
	// SetBucketInfo sets the BucketInfo of the download object.
	SetBucketInfo(*storagetypes.BucketInfo)
	// GetUserAddress returns the user account of downloading object.
	// It is used to record the read bucket information.
	GetUserAddress() string
	// SetUserAddress sets the user account of downloading object.
	SetUserAddress(string)
	// GetSize returns the download payload data size.
	GetSize() int64
	// GetEnableCheck returns enable_check flag.
	GetEnableCheck() bool
	// GetTotalSize returns total size.
	GetTotalSize() uint64
	// GetPieceKey returns piece key.
	GetPieceKey() string
	// GetPieceOffset returns piece offset.
	GetPieceOffset() uint64
	// GetPieceLength returns piece length.
	GetPieceLength() uint64
}

DownloadPieceTask is an abstract interface to record the information for downloading piece data.

type GCMetaTask 

type GCMetaTask interface {
	GCTask
	// GetGCMetaStatus returns the status of collecting metadata, returns the last
	// deleted object id and the number that has been deleted.
	GetGCMetaStatus() (uint64, uint64)
	// SetGCMetaStatus sets the status of collecting metadata, parma stands the last
	// deleted object id and the number that has been deleted.
	SetGCMetaStatus(uint64, uint64)
}

GCMetaTask is an abstract interface to record the information for collecting the SP meta store space by deleting the expired data.

type GCObjectTask 

type GCObjectTask interface {
	GCTask
	// InitGCObjectTask inits InitGCObjectTask.
	InitGCObjectTask(priority TPriority, start, end uint64, timeout int64)
	// SetStartBlockNumber sets start block number for collecting object.
	SetStartBlockNumber(uint64)
	// GetStartBlockNumber returns start block number for collecting object.
	GetStartBlockNumber() uint64
	// SetEndBlockNumber sets end block number for collecting object.
	SetEndBlockNumber(uint64)
	// GetEndBlockNumber returns end block number for collecting object.
	GetEndBlockNumber() uint64
	// SetCurrentBlockNumber sets the collecting block number.
	SetCurrentBlockNumber(uint64)
	// GetCurrentBlockNumber returns the collecting block number.
	GetCurrentBlockNumber() uint64
	// GetLastDeletedObjectId returns the last deleted ObjectID.
	GetLastDeletedObjectId() uint64
	// SetLastDeletedObjectId sets the last deleted ObjectID.
	SetLastDeletedObjectId(uint64)
	// GetGCObjectProgress returns the progress of collecting object, returns the
	// deleting block number and the last deleted object id.
	GetGCObjectProgress() (uint64, uint64)
	// SetGCObjectProgress sets the progress of collecting object, params stand
	// the deleting block number and the last deleted object id.
	SetGCObjectProgress(uint64, uint64)
}

GCObjectTask is an abstract interface to record the information for collecting the piece store space by deleting object payload data that the object has been deleted on Greenfield chain.

type GCTask 

type GCTask interface {
	Task
}

GCTask is an abstract interface to record the information of garbage collection.

type GCZombiePieceTask 

type GCZombiePieceTask interface {
	GCTask
	// GetGCZombiePieceStatus returns the status of collecting zombie pieces, returns
	// the last deleted object id and the number that has been deleted.
	GetGCZombiePieceStatus() (uint64, uint64)
	// SetGCZombiePieceStatus sets the status of collecting zombie pieces, param
	// stands the last deleted object id and the has been deleted pieces number.
	SetGCZombiePieceStatus(uint64, uint64)
}

GCZombiePieceTask is an abstract interface to record the information for collecting the piece store space by deleting zombie pieces data that dues to any exception, the piece data meta is not on chain but the pieces has been store in piece store.

type MigrateGVGTask added in v0.2.3 

type MigrateGVGTask interface {
	Task
	// InitMigrateGVGTask inits migrate gvg task by bucket id, gvg.
	InitMigrateGVGTask(priority TPriority, bucketID uint64, srcGvg *virtualgrouptypes.GlobalVirtualGroup,
		redundancyIndex int32, srcSP *sptypes.StorageProvider, timeout int64, retry int64)
	// GetSrcGvg returns the src global virtual group
	GetSrcGvg() *virtualgrouptypes.GlobalVirtualGroup
	// SetSrcGvg sets the src global virtual group
	SetSrcGvg(*virtualgrouptypes.GlobalVirtualGroup)
	// GetDestGvg returns the dest global virtual group
	GetDestGvg() *virtualgrouptypes.GlobalVirtualGroup
	// SetDestGvg sets the dest global virtual group
	SetDestGvg(*virtualgrouptypes.GlobalVirtualGroup)
	// GetSrcSp returns the src storage provider
	GetSrcSp() *sptypes.StorageProvider
	// SetSrcSp sets the src storage provider
	SetSrcSp(*sptypes.StorageProvider)
	// GetBucketID returns the bucketID
	GetBucketID() uint64
	// SetBucketID sets the bucketID
	SetBucketID(uint64)
	// GetRedundancyIdx returns the redundancy index
	GetRedundancyIdx() int32
	// SetRedundancyIdx sets the redundancy index
	SetRedundancyIdx(int32)
	// GetLastMigratedObjectID returns the last modified objectID
	GetLastMigratedObjectID() uint64
	// SetLastMigratedObjectID sets the last migrated objectID
	SetLastMigratedObjectID(uint64)
	// GetFinished returns the task whether finished
	GetFinished() bool
	// SetFinished sets the migrated gvg task status when finished
	SetFinished(bool)
}

MigrateGVGTask is an abstract interface to record migrate gvg information.

type NullTask 

type NullTask struct{}

func (NullTask) AppendLog added in v0.2.3 

func (NullTask) AppendLog(log string)

func (*NullTask) Error 

func (*NullTask) Error() error

func (*NullTask) EstimateLimit 

func (*NullTask) EstimateLimit() rcmgr.Limit

func (*NullTask) ExceedRetry 

func (*NullTask) ExceedRetry() bool

func (*NullTask) ExceedTimeout 

func (*NullTask) ExceedTimeout() bool

func (*NullTask) Expired 

func (*NullTask) Expired() bool

func (*NullTask) GetAddress 

func (*NullTask) GetAddress() string

func (*NullTask) GetApprovedSignature 

func (*NullTask) GetApprovedSignature() []byte

func (*NullTask) GetApprovedSpApprovalAddress 

func (*NullTask) GetApprovedSpApprovalAddress() string

func (*NullTask) GetApprovedSpEndpoint 

func (*NullTask) GetApprovedSpEndpoint() string

func (*NullTask) GetApprovedSpOperatorAddress 

func (*NullTask) GetApprovedSpOperatorAddress() string

func (*NullTask) GetAskSignature 

func (*NullTask) GetAskSignature() []byte

func (*NullTask) GetAskSpOperatorAddress 

func (*NullTask) GetAskSpOperatorAddress() string

func (*NullTask) GetBucketID added in v0.2.3 

func (*NullTask) GetBucketID() uint64

func (*NullTask) GetBucketInfo 

func (*NullTask) GetBucketInfo() *storagetypes.BucketInfo

func (*NullTask) GetBucketMigration added in v0.2.3 

func (*NullTask) GetBucketMigration() bool

func (*NullTask) GetCreateBucketInfo 

func (*NullTask) GetCreateBucketInfo() *storagetypes.MsgCreateBucket

func (*NullTask) GetCreateObjectInfo 

func (*NullTask) GetCreateObjectInfo() *storagetypes.MsgCreateObject

func (*NullTask) GetCreateTime 

func (*NullTask) GetCreateTime() int64

func (*NullTask) GetDestGvg added in v0.2.3 

func (*NullTask) GetDestGvg() *virtualgrouptypes.GlobalVirtualGroup

func (*NullTask) GetDestSp added in v0.2.3 

func (*NullTask) GetDestSp() *sptypes.StorageProvider

func (*NullTask) GetEcIdx added in v0.2.3 

func (*NullTask) GetEcIdx() int32

func (*NullTask) GetExpiredHeight 

func (*NullTask) GetExpiredHeight() uint64

func (*NullTask) GetFinished added in v0.2.3 

func (*NullTask) GetFinished() bool

func (*NullTask) GetGCMetaStatus 

func (*NullTask) GetGCMetaStatus() (uint64, uint64)

func (*NullTask) GetGCZombiePieceStatus 

func (*NullTask) GetGCZombiePieceStatus() (uint64, uint64)

func (*NullTask) GetGlobalVirtualGroupId added in v0.2.3 

func (*NullTask) GetGlobalVirtualGroupId() uint32

func (*NullTask) GetHigh 

func (*NullTask) GetHigh() int64

func (*NullTask) GetIntegrityHash 

func (*NullTask) GetIntegrityHash() []byte

func (*NullTask) GetLastMigratedObjectID added in v0.2.3 

func (*NullTask) GetLastMigratedObjectID() uint64

func (NullTask) GetLogs added in v0.2.3 

func (NullTask) GetLogs() string

func (*NullTask) GetLow 

func (*NullTask) GetLow() int64

func (*NullTask) GetMaxRetry 

func (*NullTask) GetMaxRetry() int64

func (*NullTask) GetObjectInfo 

func (*NullTask) GetObjectInfo() *storagetypes.ObjectInfo

func (*NullTask) GetPieceChecksum 

func (*NullTask) GetPieceChecksum() []byte

func (*NullTask) GetPieceDataSize 

func (*NullTask) GetPieceDataSize() int64

func (*NullTask) GetPieceHash 

func (*NullTask) GetPieceHash() [][]byte

func (*NullTask) GetPieceIdx 

func (*NullTask) GetPieceIdx() int32

func (*NullTask) GetPieceSize 

func (*NullTask) GetPieceSize() int64

func (*NullTask) GetPriority 

func (*NullTask) GetPriority() TPriority

func (*NullTask) GetRecovered added in v0.2.3 

func (*NullTask) GetRecovered() bool

func (*NullTask) GetRedundancyIdx 

func (*NullTask) GetRedundancyIdx() int32

func (*NullTask) GetReplicateIdx 

func (*NullTask) GetReplicateIdx() uint32

func (*NullTask) GetRetry 

func (*NullTask) GetRetry() int64

func (*NullTask) GetSealed 

func (*NullTask) GetSealed() bool

func (*NullTask) GetSecondaryAddresses 

func (*NullTask) GetSecondaryAddresses() []string

func (*NullTask) GetSecondaryEndpoints added in v0.2.3 

func (*NullTask) GetSecondaryEndpoints() []string

func (*NullTask) GetSecondarySignatures 

func (*NullTask) GetSecondarySignatures() [][]byte

func (*NullTask) GetSegmentIdx 

func (*NullTask) GetSegmentIdx() uint32

func (*NullTask) GetSignBytes 

func (*NullTask) GetSignBytes() []byte

func (*NullTask) GetSignature 

func (*NullTask) GetSignature() []byte

func (*NullTask) GetSize 

func (*NullTask) GetSize() int64

func (*NullTask) GetSrcGvg added in v0.2.3 

func (*NullTask) GetSrcGvg() *virtualgrouptypes.GlobalVirtualGroup

func (*NullTask) GetSrcSp added in v0.2.3 

func (*NullTask) GetSrcSp() *sptypes.StorageProvider

func (*NullTask) GetStorageParams 

func (*NullTask) GetStorageParams() *storagetypes.Params

func (*NullTask) GetTimeout 

func (*NullTask) GetTimeout() int64

func (*NullTask) GetUpdateTime 

func (*NullTask) GetUpdateTime() int64

func (*NullTask) GetUserAddress 

func (*NullTask) GetUserAddress() string

func (*NullTask) GetVirtualGroupFamilyId added in v0.2.3 

func (*NullTask) GetVirtualGroupFamilyId() uint32

func (*NullTask) IncRetry 

func (*NullTask) IncRetry()

func (*NullTask) Info 

func (*NullTask) Info() string

func (*NullTask) InitApprovalCreateBucketTask 

func (*NullTask) InitApprovalCreateBucketTask(string, *storagetypes.MsgCreateBucket, TPriority)

func (*NullTask) InitApprovalCreateObjectTask 

func (*NullTask) InitApprovalCreateObjectTask(string, *storagetypes.MsgCreateObject, TPriority)

func (*NullTask) InitApprovalReplicatePieceTask 

func (*NullTask) InitApprovalReplicatePieceTask(*storagetypes.ObjectInfo, *storagetypes.Params, TPriority, string)

func (*NullTask) InitChallengePieceTask 

func (*NullTask) InitChallengePieceTask(*storagetypes.ObjectInfo, *storagetypes.BucketInfo, *storagetypes.Params, TPriority, string, int32, uint32, int64, int64)

func (*NullTask) InitDownloadObjectTask 

func (*NullTask) InitDownloadObjectTask(*storagetypes.ObjectInfo, *storagetypes.BucketInfo, *storagetypes.Params, TPriority, string, int64, int64, int64, int64)

func (*NullTask) InitMigrateGVGTask added in v0.2.3 

func (*NullTask) InitMigrateGVGTask(priority TPriority, bucketID uint64, srcGvg *virtualgrouptypes.GlobalVirtualGroup,
	redundancyIndex int32, srcSP *sptypes.StorageProvider, timeout int64, retry int64)

func (*NullTask) InitReceivePieceTask 

func (*NullTask) InitReceivePieceTask(uint32, *storagetypes.ObjectInfo, *storagetypes.Params, TPriority, uint32, int32, int64)

func (*NullTask) InitRecoverPieceTask added in v0.2.3 

func (*NullTask) InitRecoverPieceTask(*storagetypes.ObjectInfo, *storagetypes.Params, TPriority, uint32, int32, uint64, int64, int64)

func (*NullTask) InitReplicatePieceTask 

func (*NullTask) InitReplicatePieceTask(*storagetypes.ObjectInfo, *storagetypes.Params, TPriority, int64, int64)

func (*NullTask) InitSealObjectTask 

func (*NullTask) InitSealObjectTask(uint32, *storagetypes.ObjectInfo, *storagetypes.Params, TPriority, []string, [][]byte, int64, int64)

func (*NullTask) InitUploadObjectTask 

func (*NullTask) InitUploadObjectTask(uint32, *storagetypes.ObjectInfo, *storagetypes.Params, int64)

func (*NullTask) Key 

func (*NullTask) Key() TKey

func (*NullTask) SetAddress 

func (*NullTask) SetAddress(string)

func (*NullTask) SetApprovedSignature 

func (*NullTask) SetApprovedSignature([]byte)

func (*NullTask) SetApprovedSpApprovalAddress 

func (*NullTask) SetApprovedSpApprovalAddress(string)

func (*NullTask) SetApprovedSpEndpoint 

func (*NullTask) SetApprovedSpEndpoint(string)

func (*NullTask) SetApprovedSpOperatorAddress 

func (*NullTask) SetApprovedSpOperatorAddress(string)

func (*NullTask) SetAskSignature 

func (*NullTask) SetAskSignature([]byte)

func (*NullTask) SetAskSpOperatorAddress 

func (*NullTask) SetAskSpOperatorAddress(string)

func (*NullTask) SetBucketID added in v0.2.3 

func (*NullTask) SetBucketID(uint64)

func (*NullTask) SetBucketInfo 

func (*NullTask) SetBucketInfo(*storagetypes.BucketInfo)

func (*NullTask) SetBucketMigration added in v0.2.3 

func (*NullTask) SetBucketMigration(migration bool)

func (*NullTask) SetCreateBucketInfo 

func (*NullTask) SetCreateBucketInfo(*storagetypes.MsgCreateBucket)

func (*NullTask) SetCreateObjectInfo 

func (*NullTask) SetCreateObjectInfo(*storagetypes.MsgCreateObject)

func (*NullTask) SetCreateTime 

func (*NullTask) SetCreateTime(int64)

func (*NullTask) SetDestGvg added in v0.2.3 

func (*NullTask) SetDestGvg(*virtualgrouptypes.GlobalVirtualGroup)

func (*NullTask) SetDestSp added in v0.2.3 

func (*NullTask) SetDestSp(*sptypes.StorageProvider)

func (*NullTask) SetError 

func (*NullTask) SetError(error)

func (*NullTask) SetExpiredHeight 

func (*NullTask) SetExpiredHeight(uint64)

func (*NullTask) SetFinished added in v0.2.3 

func (*NullTask) SetFinished(bool)

func (*NullTask) SetGCMetaStatus 

func (*NullTask) SetGCMetaStatus(uint64, uint64)

func (*NullTask) SetGCZombiePieceStatus 

func (*NullTask) SetGCZombiePieceStatus(uint64, uint64)

func (*NullTask) SetGlobalVirtualGroupID added in v0.2.3 

func (*NullTask) SetGlobalVirtualGroupID(uint32)

func (*NullTask) SetIntegrityHash 

func (*NullTask) SetIntegrityHash([]byte)

func (*NullTask) SetLastMigratedObjectID added in v0.2.3 

func (*NullTask) SetLastMigratedObjectID(uint64)

func (NullTask) SetLogs added in v0.2.3 

func (NullTask) SetLogs(logs string)

func (*NullTask) SetMaxRetry 

func (*NullTask) SetMaxRetry(int64)

func (*NullTask) SetObjectInfo 

func (*NullTask) SetObjectInfo(*storagetypes.ObjectInfo)

func (*NullTask) SetPieceChecksum 

func (*NullTask) SetPieceChecksum([]byte)

func (*NullTask) SetPieceDataSize 

func (*NullTask) SetPieceDataSize(int64)

func (*NullTask) SetPieceHash 

func (*NullTask) SetPieceHash([][]byte)

func (*NullTask) SetPieceIdx 

func (*NullTask) SetPieceIdx(int32)

func (*NullTask) SetPieceSize 

func (*NullTask) SetPieceSize(int64)

func (*NullTask) SetPriority 

func (*NullTask) SetPriority(TPriority)

func (*NullTask) SetRecoverDone added in v0.2.3 

func (*NullTask) SetRecoverDone()

func (*NullTask) SetRedundancyIdx 

func (*NullTask) SetRedundancyIdx(idx int32)

func (*NullTask) SetReplicateIdx 

func (*NullTask) SetReplicateIdx(uint32)

func (*NullTask) SetRetry 

func (*NullTask) SetRetry(int)

func (*NullTask) SetSealed 

func (*NullTask) SetSealed(bool)

func (*NullTask) SetSecondaryAddresses 

func (*NullTask) SetSecondaryAddresses([]string)

func (*NullTask) SetSecondarySignatures 

func (*NullTask) SetSecondarySignatures([][]byte)

func (*NullTask) SetSegmentIdx 

func (*NullTask) SetSegmentIdx(uint32)

func (*NullTask) SetSignature 

func (*NullTask) SetSignature([]byte)

func (*NullTask) SetSrcGvg added in v0.2.3 

func (*NullTask) SetSrcGvg(*virtualgrouptypes.GlobalVirtualGroup)

func (*NullTask) SetSrcSp added in v0.2.3 

func (*NullTask) SetSrcSp(*sptypes.StorageProvider)

func (*NullTask) SetStorageParams 

func (*NullTask) SetStorageParams(*storagetypes.Params)

func (*NullTask) SetTimeout 

func (*NullTask) SetTimeout(int64)

func (*NullTask) SetUpdateTime 

func (*NullTask) SetUpdateTime(int64)

func (*NullTask) SetUserAddress 

func (*NullTask) SetUserAddress(string)

func (*NullTask) Type 

func (*NullTask) Type() TType

type ObjectTask 

type ObjectTask interface {
	Task
	// GetObjectInfo returns the associated object.
	GetObjectInfo() *storagetypes.ObjectInfo
	// SetObjectInfo set the  associated object.
	SetObjectInfo(*storagetypes.ObjectInfo)
	// GetStorageParams returns the storage params.
	GetStorageParams() *storagetypes.Params
	// SetStorageParams sets the storage params.Should try to avoid calling this
	// method, it will change the task base information.
	// For example: it will change resource estimate for UploadObjectTask and so on.
	SetStorageParams(*storagetypes.Params)
}

ObjectTask associated with an object and storage params, and records the information of different stages of the object. Considering the change of storage params on the greenfield, the storage params of each object should be determined when it is created, and it should not be queried during the task flow, which is inefficient and error-prone.

type ReceivePieceTask 

type ReceivePieceTask interface {
	ObjectTask
	// InitReceivePieceTask init the ReceivePieceTask.
	InitReceivePieceTask(vgfID uint32, object *storagetypes.ObjectInfo, params *storagetypes.Params, priority TPriority,
		segmentIdx uint32, redundancyIdx int32, pieceSize int64)
	// GetSegmentIdx returns the piece index. The piece index identifies the serial number
	// of segment of object payload data for object piece copy.
	GetSegmentIdx() uint32
	// SetSegmentIdx sets the segment index.
	SetSegmentIdx(uint32)
	// GetRedundancyIdx returns the redundancy index. The redundancy index identifies the
	// serial number of the secondary SP for object piece copy.
	GetRedundancyIdx() int32
	// SetRedundancyIdx sets the redundancy index.
	SetRedundancyIdx(int32)
	// GetPieceSize returns the received piece data size, it is used to resource estimate.
	GetPieceSize() int64
	// SetPieceSize sets the received piece data size.
	SetPieceSize(int64)
	// GetPieceChecksum returns the checksum of received piece data, it is used to check
	// the piece data is correct.
	GetPieceChecksum() []byte
	// SetPieceChecksum set the checksum of received piece data.
	SetPieceChecksum([]byte)
	// GetSignature returns the primary signature of SP, because the InitReceivePieceTask
	// will be transfer to secondary SP, It is necessary to prove that the task was
	// sent by a legitimate SP.
	GetSignature() []byte
	// SetSignature sets the primary signature of SP.
	SetSignature([]byte)
	// GetSignBytes returns the bytes from the task for primary SP to sign.
	GetSignBytes() []byte
	// GetSealed returns an indicator whether the object of receiving piece data is
	// sealed on greenfield, the secondary SP has an incentive to confirm that otherwise
	// it wastes its storage resources
	GetSealed() bool
	// SetSealed sets the object of receiving piece data whether is successfully sealed.
	SetSealed(bool)
	// GetFinished returns whether replicate piece is done
	GetFinished() bool
	// SetFinished sets finished field
	SetFinished(bool)
	// GetGlobalVirtualGroupId returns the object's global virtual group id.
	GetGlobalVirtualGroupId() uint32
	// SetGlobalVirtualGroupId sets the object's global virtual group id.
	SetGlobalVirtualGroupID(uint32)
	// GetBucketMigration returns whether receiver does bucket migration
	GetBucketMigration() bool
	// SetBucketMigration sets the bucket migration
	SetBucketMigration(bool)
}

ReceivePieceTask is an abstract interface to record the information for receiving pieces of object payload data from primary SP, it exists only in secondary SP.

type RecoveryPieceTask added in v0.2.3 

type RecoveryPieceTask interface {
	ObjectTask
	// InitRecoverPieceTask inits the RecoveryPieceTask by ObjectInfo, params,
	// task priority, pieceIndex, timeout and max retry.
	InitRecoverPieceTask(object *storagetypes.ObjectInfo, params *storagetypes.Params,
		priority TPriority, pieceIdx uint32, ecIdx int32, pieceSize uint64, timeout int64, retry int64)

	// GetSegmentIdx return the segment index of recovery object segment
	GetSegmentIdx() uint32
	// GetEcIdx return the ec index of recovery ec chunk
	GetEcIdx() int32
	// GetSignature returns the primary SP's signature
	GetSignature() []byte
	// SetSignature sets the primary SP's signature.
	SetSignature([]byte)
	// GetSignBytes returns the bytes from the task for primary SP to sign.
	GetSignBytes() []byte
	GetRecovered() bool
	// SetRecoverDone set the recovery status as finish
	SetRecoverDone()
}

The RecoveryPieceTask is the interface to record the information for recovering TODO consider recovery secondary SP task

type ReplicatePieceTask 

type ReplicatePieceTask interface {
	ObjectTask
	// InitReplicatePieceTask inits the ReplicatePieceTask by ObjectInfo, params,
	// task priority, timeout and max retry.
	InitReplicatePieceTask(object *storagetypes.ObjectInfo, params *storagetypes.Params, priority TPriority, timeout int64, retry int64)
	// GetSealed returns an indicator whether successful seal object on greenfield
	// after replicate pieces, it is an optimization method. ReplicatePieceTask and
	// SealObjectTask are combined. Otherwise, the two tasks will be completed in
	// two stages. If the combination is successful and the seal object is successful,
	// the number of SealObjectTask can be reduced, saving resource overhead.
	GetSealed() bool
	// SetSealed sets the state successful seal object after replicating piece.
	SetSealed(bool)
	// GetSecondaryAddresses returns the secondary SP's addresses. It is used to
	// generate MsgSealObject.
	GetSecondaryAddresses() []string
	// SetSecondaryAddresses sets the secondary SP's addresses.
	SetSecondaryAddresses([]string)
	// GetSecondarySignatures returns the secondary SP's signatures. It is used to
	// generate MsgSealObject.
	GetSecondarySignatures() [][]byte
	// SetSecondarySignatures sets the secondary SP's signatures.
	SetSecondarySignatures([][]byte)
	// GetGlobalVirtualGroupId returns the object's global virtual group id.
	GetGlobalVirtualGroupId() uint32
	// GetSecondaryEndpoints return the secondary sp domain.
	GetSecondaryEndpoints() []string
}

The ReplicatePieceTask is the interface to record the information for replicating pieces of object pieces data to secondary SPs.

type ResumableUploadObjectTask added in v0.2.3 

type ResumableUploadObjectTask interface {
	ObjectTask
	// InitResumableUploadObjectTask inits the UploadObjectTask by ObjectInfo and Params.
	InitResumableUploadObjectTask(vgfID uint32, object *storagetypes.ObjectInfo, params *storagetypes.Params, timeout int64, complete bool, offset uint64)
	// GetVirtualGroupFamilyId returns the object's virtual group family which is bind in bucket.
	GetVirtualGroupFamilyId() uint32
	// GetResumeOffset return resumable offset user-supplied parameters
	GetResumeOffset() uint64
	// SetResumeOffset Set the `ResumeOffset` provided by the user for subsequent processing in the `HandleResumableUploadObjectTask`.
	SetResumeOffset(offset uint64)
	// GetCompleted The GetCompleted() function returns the value of completed set by the user in the request.
	// The completed parameter represents the last upload request in the resumable upload process,
	// after which integrity checks and replication procedures will be performed.
	GetCompleted() bool
	// SetCompleted sets the state from request in InitResumableUploadObjectTask
	SetCompleted(completed bool)
}

The ResumableUploadObjectTask is the interface to record the information for uploading object payload data to the primary SP.

type SealObjectTask 

type SealObjectTask interface {
	ObjectTask
	// InitSealObjectTask inits the SealObjectTask.
	InitSealObjectTask(vgfID uint32, object *storagetypes.ObjectInfo, params *storagetypes.Params, priority TPriority, addresses []string,
		signatures [][]byte, timeout int64, retry int64)
	// GetSecondaryAddresses return the secondary SP's addresses.
	GetSecondaryAddresses() []string
	// GetSecondarySignatures return the secondary SP's signature, it is used to generate
	// MsgSealObject.
	GetSecondarySignatures() [][]byte
	// GetGlobalVirtualGroupId returns the object's global virtual group id.
	GetGlobalVirtualGroupId() uint32
}

SealObjectTask is an abstract interface to record the information for sealing object on Greenfield chain.

type TKey 

type TKey string

TKey defines the type of task key that is the uniquely identify.

func (TKey) String 

func (k TKey) String() string

String transfer TKey to string type.

type TPriority 

type TPriority uint8

TPriority defines the type of task priority, the priority can be used as an important basis for task scheduling within the SP. The higher the priority, the faster it is expected to be executed, and the resources will be assigned priority for execution. The lower the priority, it can be executed later, and the resource requirements are not so urgent. 

const (
	// UnKnownTaskPriority defines the default task priority.
	UnKnownTaskPriority TPriority = 0
	// UnSchedulingPriority defines the task priority that should be never scheduled.
	UnSchedulingPriority TPriority = 0
	// MaxTaskPriority defines the max task priority.
	MaxTaskPriority TPriority = 255
	// DefaultLargerTaskPriority defines the larger task priority.
	DefaultLargerTaskPriority TPriority = 170
	// DefaultSmallerPriority defines the smaller task priority.
	DefaultSmallerPriority TPriority = 85
)

type TPriorityLevel 

type TPriorityLevel int32

TPriorityLevel defines the type of task priority level. The executor of the task will reserve the resources from the resource manager(rcmgr) before execution, and the rcmgr can limit the execution of concurrent tasks number according to the task priority level.

Example: 

	the configuration the rcmgr:
		[TasksHighPriority: 30, TasksMediumPriority: 20, TasksLowPriority: 2]
	the executor of the task can run 30 high level tasks at the same time that the
		task priority >= DefaultLargerTaskPriority
 	the executor of the task can run 20 medium level tasks at the same time that the
		task priority between (DefaultLargerTaskPriority, DefaultSmallerPriority]
	the executor of the task can run 2 medium level tasks at the same time that the
		task priority < DefaultSmallerPriority

const (
	// TLowPriorityLevel defines the low task priority level.
	TLowPriorityLevel TPriorityLevel = iota
	// TMediumPriorityLevel defines the medium task priority level.
	TMediumPriorityLevel
	// THighPriorityLevel defines the high task priority level.
	THighPriorityLevel
)

type TType 

type TType int32

TType is enum type, it defines the type of task. 

const (
	// TypeTaskUnknown defines the default task type.
	TypeTaskUnknown TType = iota
	// TypeTaskCreateBucketApproval defines the type of asking create bucket approval
	// to primary SP task
	TypeTaskCreateBucketApproval
	// TypeTaskMigrateBucketApproval defines the type of asking migrate bucket approval
	// to primary SP task
	TypeTaskMigrateBucketApproval
	// TypeTaskCreateObjectApproval defines the type of asking create object approval
	// to primary SP task
	TypeTaskCreateObjectApproval
	// TypeTaskReplicatePieceApproval defines the type of asking create object approval
	// to secondary SP task
	TypeTaskReplicatePieceApproval
	// TypeTaskUpload defines the type of uploading object to primary SP task.
	TypeTaskUpload
	// TypeTaskReplicatePiece defines the type of replicating pieces to secondary SPs task.
	TypeTaskReplicatePiece
	// TypeTaskSealObject defines the type of sealing object to the chain task.
	TypeTaskSealObject
	// TypeTaskReceivePiece defines the type of receiving pieces for secondary SP task.
	TypeTaskReceivePiece
	// TypeTaskDownloadObject defines the type of downloading object task.
	TypeTaskDownloadObject
	// TypeTaskDownloadPiece defines the type of downloading piece task.
	TypeTaskDownloadPiece
	// TypeTaskChallengePiece defines the type of challenging piece task.
	TypeTaskChallengePiece
	// TypeTaskGCObject defines the type of collecting object payload data task.
	TypeTaskGCObject
	// TypeTaskGCZombiePiece defines the type of collecting zombie piece task.
	TypeTaskGCZombiePiece
	// TypeTaskGCMeta defines the type of collecting SP metadata task.
	TypeTaskGCMeta
	// TypeTaskRecoverPiece defines the type of the recovering piece task.
	TypeTaskRecoverPiece
	// TypeTaskMigrateGVG defines the type of migrating gvg task.
	TypeTaskMigrateGVG
	// TypeTaskMigratePiece defines the type of migrating piece task.
	TypeTaskMigratePiece
)

type Task 

type Task interface {
	// Key returns the uniquely identify of the task. It is recommended that each task
	// has its own prefix. In addition, it should also include the information of the
	// task's own identity.
	// For example:
	// 1. ApprovalTask maybe includes the bucket name and object name,
	// 2. ObjectTask maybe includes the object ID,
	// 3. GCTask maybe includes the timestamp.
	Key() TKey
	// Type returns the type of the task. A task has a unique type, such as
	// TypeTaskCreateBucketApproval, TypeTaskUpload etc. has the only one TType
	// definition.
	Type() TType
	// GetAddress returns the task runner address. there is only one runner at the
	// same time, which will assist in quickly locating the running node of the task.
	GetAddress() string
	// SetAddress sets the runner address to the task.
	SetAddress(string)
	// GetCreateTime returns the creation time of the task. The creation time used to
	// judge task execution time.
	GetCreateTime() int64
	// SetCreateTime sets the creation time of the task.
	SetCreateTime(int64)
	// GetUpdateTime returns the last updated time of the task. The updated time used
	// to determine whether the task is expired with the timeout.
	GetUpdateTime() int64
	// SetUpdateTime sets last updated time of the task. Any changes in task information
	// requires to set the update time.
	SetUpdateTime(int64)
	// GetTimeout returns the timeout of the task, the timeout is a duration, if update
	// time adds timeout lesser now stands the task is expired.
	GetTimeout() int64
	// SetTimeout sets timeout duration of the task.
	SetTimeout(int64)
	// ExceedTimeout returns an indicator whether timeout, if update time adds timeout
	// lesser now returns true, otherwise returns false.
	ExceedTimeout() bool
	// GetMaxRetry returns the max retry times of the task. Each type of task has a
	// fixed max retry times.
	GetMaxRetry() int64
	// SetMaxRetry sets the max retry times of the task.
	SetMaxRetry(int64)
	// GetRetry returns the retry counter of the task.
	GetRetry() int64
	// SetRetry sets the retry counter of the task.
	SetRetry(int)
	// IncRetry increases the retry counter of the task. Each task has the max retry
	// times, if retry counter exceed the max retry, the task should be canceled.
	IncRetry()
	// ExceedRetry returns an indicator whether retry counter greater that max retry.
	ExceedRetry() bool
	// Expired returns an indicator whether ExceedTimeout and ExceedRetry.
	Expired() bool
	// GetPriority returns the priority of the task. Each type of task has a fixed
	// priority. The higher the priority, the higher the urgency of the task, and
	// it will be executed first.
	GetPriority() TPriority
	// SetPriority sets the priority of the task. In most cases, the priority of the
	// task does not need to be set, because the priority of the task corresponds to
	// the task type one by one. Once the task type is determined, the priority is
	// determined. But some scenarios need to dynamically adjust the priority of the
	// task type, then this interface is needed.
	SetPriority(TPriority)
	// EstimateLimit returns estimated resource will be consumed. It is used for
	// application resources to the rcmgr and decide whether it can be executed
	// immediately.
	EstimateLimit() rcmgr.Limit
	// SetLogs sets the event logs to task
	SetLogs(logs string)
	// GetLogs returns the logs of task
	GetLogs() string
	// GetUserAddress returns the user account of downloading object.
	// It is used to record the read bucket information.
	GetUserAddress() string
	// SetUserAddress sets the user account of downloading object.
	SetUserAddress(string)
	// AppendLog appends the event log to task
	AppendLog(log string)
	// Info returns the task detail info for log and debug.
	Info() string
	// Error returns the task error. if the task is normal, returns nil.
	Error() error
	// SetError sets the error to task. Any errors that occur during task execution
	// will be logged through the SetError method.
	SetError(error)
}

Task is an abstract interface to describe the smallest unit of SP service how to interact.

type UploadObjectTask 

type UploadObjectTask interface {
	ObjectTask
	// InitUploadObjectTask inits the UploadObjectTask by ObjectInfo and Params.
	InitUploadObjectTask(vgfID uint32, object *storagetypes.ObjectInfo, params *storagetypes.Params, timeout int64)
	// GetVirtualGroupFamilyId returns the object's virtual group family which is bind in bucket.
	GetVirtualGroupFamilyId() uint32
}

UploadObjectTask is an abstract interface to record the information for uploading object payload data to the primary SP.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.