From 0dda05fd57ee73285767d4e830dec3136d346b78 Mon Sep 17 00:00:00 2001
From: Kevin Wan <wanjunfeng@gmail.com>
Date: Mon, 8 Feb 2021 11:10:55 +0800
Subject: [PATCH] add api doc (#449)

---
 core/load/adaptiveshedder.go | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/core/load/adaptiveshedder.go b/core/load/adaptiveshedder.go
index 30b3c3f3..afec3933 100644
--- a/core/load/adaptiveshedder.go
+++ b/core/load/adaptiveshedder.go
@@ -26,6 +26,7 @@ const (
 )
 
 var (
+	// ErrServiceOverloaded is returned by Shedder.Allow when the service is overloaded.
 	ErrServiceOverloaded = errors.New("service overloaded")
 
 	// default to be enabled
@@ -37,15 +38,22 @@ var (
 )
 
 type (
+	// A Promise interface is returned by Shedder.Allow to let callers tell
+	// whether the processing request is successful or not.
 	Promise interface {
+		// Pass lets the caller tell that the call is successful.
 		Pass()
+		// Fail lets the caller tell that the call is failed.
 		Fail()
 	}
 
+	// Shedder is the interface that wraps the Allow method.
 	Shedder interface {
+		// Allow returns the Promise if allowed, otherwise ErrServiceOverloaded.
 		Allow() (Promise, error)
 	}
 
+	// ShedderOption lets caller customize the Shedder.
 	ShedderOption func(opts *shedderOptions)
 
 	shedderOptions struct {
@@ -67,10 +75,13 @@ type (
 	}
 )
 
+// Disable lets callers disable load shedding.
 func Disable() {
 	enabled.Set(false)
 }
 
+// NewAdaptiveShedder returns an adaptive shedder.
+// opts can be used to customize the Shedder.
 func NewAdaptiveShedder(opts ...ShedderOption) Shedder {
 	if !enabled.True() {
 		return newNopShedder()
@@ -97,6 +108,7 @@ func NewAdaptiveShedder(opts ...ShedderOption) Shedder {
 	}
 }
 
+// Allow implements Shedder.Allow.
 func (as *adaptiveShedder) Allow() (Promise, error) {
 	if as.shouldDrop() {
 		as.dropTime.Set(timex.Now())
@@ -213,18 +225,21 @@ func (as *adaptiveShedder) systemOverloaded() bool {
 	return systemOverloadChecker(as.cpuThreshold)
 }
 
+// WithBuckets customizes the Shedder with given number of buckets.
 func WithBuckets(buckets int) ShedderOption {
 	return func(opts *shedderOptions) {
 		opts.buckets = buckets
 	}
 }
 
+// WithCpuThreshold customizes the Shedder with given cpu threshold.
 func WithCpuThreshold(threshold int64) ShedderOption {
 	return func(opts *shedderOptions) {
 		opts.cpuThreshold = threshold
 	}
 }
 
+// WithWindow customizes the Shedder with given
 func WithWindow(window time.Duration) ShedderOption {
 	return func(opts *shedderOptions) {
 		opts.window = window