Products

English

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

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

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

Configuration.acceptHTTPTunnel()

Description

Appends an acceptHTTPTunnel filter to the current pipeline layout.

An acceptHTTPTunnel filter implements HTTP tunnel on the server side.

INPUT - Data stream received from the client with a leading HTTP CONNECT request Message.
OUTPUT - Data stream to send to the client with a leading HTTP CONNECT response Message.
SUB-INPUT - Data stream received from the client via HTTP tunnel.
SUB-OUTPUT - Data stream to send to the client via HTTP tunnel.

An acceptHTTPTunnel filter calls back a user handler for the input Message (expected to be an HTTP request) and outputs the Message returned from the callback as response. When the response status code is 1xx or 2xx, a sub-pipeline will be created to establish an HTTP tunnel and Data events after that initial request and response are sent back and forth between the acceptHTTPTunnel filter and the sub-pipeline.

Besides HTTP tunnel, this filter can also be used for a tunneling-like protocol upgraded from a regular HTTP session, such as WebSocket.

Syntax

pipy()
  .pipeline()
  .acceptHTTPTunnel(
    request => getResponse(request)
  ).to(
    subPipelineLayout
  )

Parameters

acceptHTTPTunnel(handler)

handler

A function that receives the starting request Message and returns a response Message.

Return Value

The same Configuration object.

Example

pipy({
  _target: '',
})

  .listen(8080)
  .demuxHTTP().to(
    $=>$.acceptHTTPTunnel(
      msg => (
        _target = msg.head.path, // Extracts the target from the URI
        new Message('OK')
      )
    ).to(
      $=>$.connect(() => _target)
    )
  )

See Also

Products

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