Home

Products

Docs

Blog

English

Download

English

Pipy Documentation

Introduction

Overview
Concepts

Getting Started

Build and Install
Quick Start
Getting help

Release

Release History

0.10.0-1
0.22.0-31
0.30.0
0.50.0

Tutorial

Part 1: Hello
Part 2: Echo
Part 3: Proxy
Part 4: Routing
Part 5: Loading Balancing
Part 6: Configuration
Part 7: Plugins

Operating

Admin GUI
CLI
Pipy Repo

Introduction
Quick Start
Demo
REST API

Statistics

Reference

API

Configuration

acceptHTTPTunnel()
acceptProxyProtocol()
acceptSOCKS()
acceptTLS()
admin()
branch()
branchMessage()
branchMessageStart()
chain()
compress()
compressHTTP()
connect()
connectHTTPTunnel()
connectProxyProtocol()
connectSOCKS()
connectTLS()
decodeBGP()
decodeDubbo()
decodeHTTPRequest()
decodeHTTPResponse()
decodeMQTT()
decodeMultipart()
decodeRESP()
decodeThrift()
decodeWebSocket()
decompress()
decompressHTTP()
deframe()
demux()
demuxHTTP()
detectProtocol()
dummy()
dump()
encodeBGP()
encodeDubbo()
encodeHTTPRequest()
encodeHTTPResponse()
encodeMQTT()
encodeRESP()
encodeThrift()
encodeWebSocket()
exec()
exit()
export()
fork()
handleData()
handleMessage()
handleMessageBody()
handleMessageEnd()
handleMessageStart()
handleStreamEnd()
handleStreamStart()
handleTLSClientHello()
import()
insert()
link()
listen()
loop()
mux()
muxHTTP()
onEnd()
onStart()
pack()
pipeline()
print()
read()
repeat()
replaceData()
replaceMessage()
replaceMessageBody()
replaceMessageEnd()
replaceMessageStart()
replaceStreamEnd()
replaceStreamStart()
replay()
serveHTTP()
split()
task()
tee()
throttleConcurrency()
throttleDataRate()
throttleMessageRate()
to()
use()
wait()
watch()

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

PipyJS

Language
Builtin Objects
NMI

StreamEnd()

Description

Creates an instance of MessageEnd.

Syntax

new StreamEnd()
new StreamEnd(error)

Parameters

new StreamEnd(error?)

error?

Error type. Available error types include:

"" (default)
"Replay" (used with replay filter)
"RuntimeError"
"ReadError"
"WriteError"
"CannotResolve"
"ConnectionAborted"
"ConnectionReset"
"ConnectionRefused"
"ConnectionTimeout"
"ReadTimeout"
"WriteTimeout"
"IdleTimeout"
"BufferOverflow"
"ProtocolError"
"Unauthorized"

Return Value

A StreamEnd object with the specified error if any.

StreamEnd()

Description

Syntax

Parameters

See Also

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