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

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

Configuration.decodeMQTT()

Description

Appends a decodeMQTT filter to the current pipeline layout.

A decodeMQTT filter decodes MQTT packets from a raw byte stream.

INPUT - Data stream to decode MQTT packets from.
OUTPUT - MQTT packets (Messages) decoded from the input Data stream.

After decoding, the output Message has:

head
- type - Type of the packet such as "SUBSCRIBE" and "PUBLISH"
- qos - PUBLISH Quality of Service
- dup - Duplicate delivery of a PUBLISH packet
- retain - PUBLISH retained message flag
- Other properties defined in the specification
body - Payload of a PUBLISH packet

Protocol level

By default, the decoder works in protocol level 4 (MQTT v3.1.1). When decoding MQTT packets sending to the broker, the first packet would be a CONNECT packet, which includes the protocol level being used. The decoder can then switch to the correct protocol level.

However, when decoding packets returning from the broker, there's no such information in the packets themselves, so you need to provide the correct protocol level by option protocolLevel in the options parameter. It can be a number, or a function that returns a number.

The following protocol levels are supported:

When protocolLevel is 4, works in MQTT v3.1.1
When protocolLevel is 5, works in MQTT v5.0

Syntax

pipy()
  .pipeline()
  .decodeMQTT()

pipy()
  .pipeline()
  .decodeMQTT({
    protocolLevel
  })

Parameters

decodeMQTT()

Return Value

The same Configuration object.

See Also

Products

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