Products

中文

中文

Pipy 文档

Introduction

概述
概念

Getting Started

构建和安装
快速入门
获取帮助

Release

发布历史

0.10.0-1
0.22.0-31
0.30.0
0.50.0

Tutorial

01 你好
02 回显
03 代理
04 路由
05 负载均衡
06 配置
07 插件

Operating

开发控制台
CLI
Pipy Repo

介绍
快速开始
演示
REST API

Reference

API

Configuration

Data

from()
Data()
push()
shift()
shiftTo()
shiftWhile()
size
toArray()

Hessian

decode()
encode()

JSON

decode()
encode()
parse()
stringify()

Message

body
head
Message()
tail

MessageEnd

MessageEnd()
payload
tail

MessageStart

head
MessageStart()

Netmask

base
bitmask
broadcast
contains()
decompose()
first
hostmask
ip
last
mask
Netmask()
next()
size
version

StreamEnd

error
StreamEnd()

URL

auth
hash
host
hostname
href
URL()
origin
password
path
pathname
port
protocol
query
search
searchParams
username

URLSearchParams

get()
getAll()
URLSearchParams()
set()
toObject()

XML

Node

attributes
children
name
Node()

decode()
encode()
parse()
stringify()

algo

Cache

clear()
get()
Cache()
remove()
set()

HashingLoadBalancer

add()
HashingLoadBalancer()
next()

LeastWorkLoadBalancer

LeastWorkLoadBalancer()
next()
set()

LoadBalancer

allocate()
LoadBalancer()
provision()
schedule()

LoadBalancerResource

free()
target

Quota

consume()
current
initial
Quota()
produce()
reset()

RoundRobinLoadBalancer

RoundRobinLoadBalancer()
next()
set()

URLRouter

add()
find()
URLRouter()

hash()
uuid()

console

debug()
error()
info()
log()
warn()

crypto

Certificate

issuer
Certificate()
subject
subjectAltNames

CertificateChain

CertificateChain()

Cipher

final()
Cipher()
update()

Decipher

final()
Decipher()
update()

Hash

digest()
Hash()
update()

Hmac

digest()
Hmac()
update()

JWK

isValid
JWK()

JWT

header
isValid
JWT()
payload
verify()

PrivateKey

PrivateKey()

PublicKey

PublicKey()

Sign

Sign()
sign()
update()

Verify

Verify()
update()
verify()

http

Agent

new()
request()

Directory

new()
serve()

logging

BinaryLogger

log()
BinaryLogger()
toFile()
toHTTP()
toStderr()
toStdout()
toSyslog()

JSONLogger

log()
JSONLogger()
toFile()
toHTTP()
toStderr()
toStdout()
toSyslog()

TextLogger

log()
TextLogger()
toFile()
toHTTP()
toStderr()
toStdout()
toSyslog()

os

env
readDir()
readFile()
stat()
unlink()
writeFile()

pipy()

exit()
load()
restart()
solve()

stats

Counter

decrease()
increase()
Counter()
withLabels()
zero()

Gauge

decrease()
increase()
Gauge()
set()
withLabels()
zero()

Histogram

Histogram()
observe()
withLabels()
zero()

algo.Cache()

Description

Creates an instance of Cache.

You can provide two optional callbacks:

add - Will be called with the key when a requested entry cannot be found and its return value will be used to fill in that entry
remove - Will be called with the key and value when an entry is about to be erased

You can set the maximum number of entries by option size in the options parameter. When entries are more than that number, old entries will be purged on the LRU (least recently used) basis.

You can also specify the TTL (time to live) for all entries by option ttl in the options parameter.

Syntax

new algo.Cache()

new algo.Cache(
  (k) => getEntryValue(k)
)

new algo.Cache(
  (k) => getEntryValue(k),
  (k, v) => onRemoveEntry(k, v),
  {
    size,
    ttl,
  }
)

Parameters

new algo.Cache(onAllocate?, onFree?, options?)

onAllocate?

A function to be called when a queried entry does not exist. It receives the key of the entry and is supposed to return the value of that entry.

onFree?

A function to be called when an entry is deleted. It receives 2 parameters: the key and the value of the entry being deleted.

options?

Options including:

size - Maximum number of entries allowed in the cache.
ttl - Time-to-live for the entries in the cache. Can be a number in seconds or a string with one of the time unit suffixes such as 's', 'm' and 'h'.

Return Value

An empty Cache object.

See Also

algo.Cache

Products

© 2024, Flomesh Team. ICP备案/许可证号：辽ICP备2023014827号