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

Configuration.replaceStreamStart()

Description

Appends a replaceStreamStart filter to the current pipeline layout.

A replaceStreamStart filter calls back user scripts to get a replacement for the first event in the input stream.

INPUT - Any types of Events.
OUTPUT - Any types of Events.

The user function will receive as parameter the first event in the input stream. The event will be removed from the stream. Whatever the function returns will be inserted into the output stream in place of the removed event. It can be an event or a Message, or an array of events or Messages. If the function returns nothing (null or undefined), no events will be inserted back into the stream.

You can also use a fixed replacement value instead of a function if the replacement is static.

Syntax

pipy()
  .pipeline()
  .replaceStreamStart(
    event => transform(event)
  )

Parameters

replaceStreamStart(handler?)

handler?

A callback function tha receives the first event passing through the filter and returns its replacement. The replacement can be an Event, a Message or an array of them.

Return Value

The same Configuration object.

See Also

Products

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