handlers

package

v1.0.14 Latest Latest Go to latest Published: Sep 27, 2023 License: MIT Imports: 22 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/bitleak/lmstfy

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func AddLimiter(c *gin.Context)
func CheckPoolExists(c *gin.Context)
func CollectMetrics(c *gin.Context)
func Consume(c *gin.Context)
func Delete(c *gin.Context)
func DeleteDeadLetter(c *gin.Context)
func DeleteLimiter(c *gin.Context)
func DeleteToken(c *gin.Context)
func DestroyQueue(c *gin.Context)
func EngineMetaInfo(c *gin.Context)
func GetAccessLogStatus(c *gin.Context)
func GetDeadLetterSize(c *gin.Context)
func GetHTTPLogger(c *gin.Context) *logrus.Entry
func GetLimiter(c *gin.Context)
func ListLimiters(c *gin.Context)
func ListPools(c *gin.Context)
func ListTokens(c *gin.Context)
func NewToken(c *gin.Context)
func PProf(c *gin.Context)
func PeekDeadLetter(c *gin.Context)
func PeekJob(c *gin.Context)
func PeekQueue(c *gin.Context)
func PrometheusMetrics(c *gin.Context)
func Publish(c *gin.Context)
func PublishBulk(c *gin.Context)
func RespawnDeadLetter(c *gin.Context)
func SetLimiter(c *gin.Context)
func Setup(l *logrus.Logger)
func SetupParamDefaults(conf *config.Config)
func SetupQueueEngine(c *gin.Context)
func Size(c *gin.Context)
func Throttle(action string) gin.HandlerFunc
func UpdateAccessLogStatus(c *gin.Context)
func ValidateMultiConsume(c *gin.Context)
func ValidateParams(c *gin.Context)
func ValidateToken(c *gin.Context)
func Version(c *gin.Context)
type PerformanceMetrics

Constants ¶

View Source

const (
	ThrottleActionConsume = "consume"
	ThrottleActionProduce = "produce"
)

Variables ¶

View Source

var (
	DefaultTTL     string
	DefaultDelay   string
	DefaultTries   string
	DefaultTTR     string
	DefaultTimeout string
)

Functions ¶

func AddLimiter ¶

func AddLimiter(c *gin.Context)

POST /token/:namespace/:token/limit

func CheckPoolExists ¶ added in v1.0.4

func CheckPoolExists(c *gin.Context)

func CollectMetrics ¶

func CollectMetrics(c *gin.Context)

func Consume ¶

func Consume(c *gin.Context)

GET /:namespace/:queue[,:queue]* @query:

ttr: uint32
timeout: uint32
count: uint32

NOTE: according to RFC3986, the URL path part can contain comma(",") , so I decide to use "," as the separator of queue names

func Delete ¶

func Delete(c *gin.Context)

DELETE /:namespace/:queue/job/:job_id

func DeleteDeadLetter ¶

func DeleteDeadLetter(c *gin.Context)

DELETE /:namespace/:queue/deadletter Delete job(s) in the deadletter

func DeleteLimiter ¶

func DeleteLimiter(c *gin.Context)

DELETE /token/:namespace/:token/limit

func DeleteToken ¶

func DeleteToken(c *gin.Context)

DELETE /token/:namespace/:token

func DestroyQueue ¶

func DestroyQueue(c *gin.Context)

func EngineMetaInfo ¶

func EngineMetaInfo(c *gin.Context)

GET /info?pool= List all namespaces and queues

func GetAccessLogStatus ¶

func GetAccessLogStatus(c *gin.Context)

GetAccessLogStatus return whether the accesslog was enabled or not GET /accesslog

func GetDeadLetterSize ¶

func GetDeadLetterSize(c *gin.Context)

GetDeadLetterSize return the size of dead letter GET /:namespace/:queue/deadletter/size

func GetHTTPLogger ¶

func GetHTTPLogger(c *gin.Context) *logrus.Entry

func GetLimiter ¶

func GetLimiter(c *gin.Context)

GET /token/:namespace/:token/limit

func ListLimiters ¶

func ListLimiters(c *gin.Context)

GET /limiters

func ListPools ¶

func ListPools(c *gin.Context)

GET /pools/

func ListTokens ¶

func ListTokens(c *gin.Context)

GET /token/:namespace

func NewToken ¶

func NewToken(c *gin.Context)

POST /token/:namespace

func PProf ¶

func PProf(c *gin.Context)

func PeekDeadLetter ¶

func PeekDeadLetter(c *gin.Context)

GET /:namespace/:queue/deadletter Get the first job in the deadletter

func PeekJob ¶

func PeekJob(c *gin.Context)

GET /:namespace/:queue/job/:job_id

func PeekQueue ¶

func PeekQueue(c *gin.Context)

GET /:namespace/:queue/peek

func PrometheusMetrics ¶

func PrometheusMetrics(c *gin.Context)

GET /metrics

func Publish ¶

func Publish(c *gin.Context)

PUT /:namespace/:queue @query:

delay: uint32
ttl: uint32
tries: uint16

func PublishBulk ¶ added in v1.0.3

func PublishBulk(c *gin.Context)

PUT /:namespace/:queue/bulk @query:

delay: uint32
ttl: uint32
tries: uint16

func RespawnDeadLetter ¶

func RespawnDeadLetter(c *gin.Context)

PUT /:namespace/:queue/deadletter Respawn job(s) in the deadletter

func SetLimiter ¶

func SetLimiter(c *gin.Context)

PUT /token/:namespace/:token/limit

func Setup ¶

func Setup(l *logrus.Logger)

func SetupParamDefaults ¶

func SetupParamDefaults(conf *config.Config)

func SetupQueueEngine ¶

func SetupQueueEngine(c *gin.Context)

func Size ¶

func Size(c *gin.Context)

GET /:namespace/:queue/size

func Throttle ¶

func Throttle(action string) gin.HandlerFunc

func UpdateAccessLogStatus ¶

func UpdateAccessLogStatus(c *gin.Context)

UpdateAccessLogStatus update the accesslog status POST /accesslog

func ValidateMultiConsume ¶

func ValidateMultiConsume(c *gin.Context)

func ValidateParams ¶

func ValidateParams(c *gin.Context)

Validate namespace and queue names don't contain any illegal characters

func ValidateToken ¶

func ValidateToken(c *gin.Context)

func Version ¶

func Version(c *gin.Context)

GET /version

Types ¶

type PerformanceMetrics ¶

type PerformanceMetrics struct {
	Latencies  *prometheus.HistogramVec
	HTTPCodes  *prometheus.CounterVec
	RateLimits *prometheus.CounterVec
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL