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()

Message()

Description

Creates an instance of Message.

While constructing a Message, 3 parameters can be provided to initialize the message's content: head, body and tail. All 3 parameters are optional.

The head parameter is an object holding varying content according to the protocol being used. See For each protocol.

The tail parameter is also an object holding varying content according to the protocol being used. See For each protocol.

The body parameter can be a Data or a string. When it is a string, it'll be UTF-8 encoded into Data.

Syntax

new Message()
new Message(head)
new Message(body)
new Message(head, body)
new Message(head, body, tail)

Parameters

new Message(body?)

body?

A string or a Data object for the message body.

Return Value

A Message object containing the specified body.

new Message(head, body?, tail?)

Creates an instance of Message.

head

An object containing protocol-dependent message header.

body?

A string or a Data object for the message body.

tail?

An object containing protocol-dependent message footer.

Return Value

A Message object containing the specified header, footer and body.

See Also

Products

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