Skip to content

Commit 9152b60

Browse files
committed
Address review comments.
Signed-off-by: Michael Warres <[email protected]>
1 parent 2682cf1 commit 9152b60

File tree

3 files changed

+9
-31
lines changed

3 files changed

+9
-31
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Proxy-Wasm C++ SDK
1+
# WebAssembly for Proxies (C++ SDK)
22

33
[![Build Status][build-badge]][build-link]
44
[![Apache 2.0 License][license-badge]][license-link]

docs/building.md

Lines changed: 4 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ therefore use of a Docker image is recommended.
66

77
## Docker
88

9-
A Dockerfile for the C++ SDK is provided in [Dockerfile-sdk](Dockerfile-sdk).
9+
A Dockerfile for the C++ SDK is provided in [Dockerfile-sdk](../Dockerfile-sdk).
1010

11-
It can built in this directory by:
11+
It can built in this repository's root directory by:
1212

1313
```bash
1414
docker build -t wasmsdk:v2 -f Dockerfile-sdk .
@@ -75,30 +75,6 @@ docker commit `docker ps -l | grep wasmsdk:v2 | awk '{print $1}'` wasmsdk:v2
7575

7676
This will save time on subsequent compiles.
7777

78-
### Using the SDK from a newer/specific version of Envoy
79-
80-
To use a newer/specific version of the SDK (e.g. from the version of Envoy you
81-
are going to deploy the WebAssembly module to), bind that volume and use it in
82-
the Makefile.
83-
84-
Here is an example Makefile referencing the SDK at `../envoy/api/wasm/cpp` and
85-
mounted as `sdk` in the `/work` directory:
86-
87-
```makefile
88-
PROXY_WASM_CPP_SDK=/work/sdk
89-
90-
all: myproject.wasm
91-
92-
include ${PROXY_WASM_CPP_SDK}/Makefile.base_lite
93-
```
94-
95-
Run docker pointing to Envoy sources in a directory parallel (at the same level)
96-
as your project directory:
97-
98-
```bash
99-
docker run -v $PWD:/work -v $PWD/../envoy/api/wasm/cpp:/work/sdk -w /work wasmsdk:v2 bash /build_wasm.sh
100-
```
101-
10278
### Using Abseil from the Docker image
10379

10480
Abseil (optionally) is built in /root/abseil and can be used. Note that the
@@ -206,8 +182,8 @@ However 3.1.7 is known to work.
206182

207183
### Rebuilding the libprotobuf.a files
208184

209-
If want to rebuild the libprotobuf.a files or use a different version see the
210-
instructions at https://github.com/kwonoj/protobuf-wasm. Commit
185+
If want to rebuild the libprotobuf.a files using a version of protobuf prior to
186+
3.15, see the instructions at https://github.com/kwonoj/protobuf-wasm. Commit
211187
4bba8b2f38b5004f87489642b6ca4525ae72fe7f works for protobuf v3.9.x.
212188

213189
```bash

proxy_wasm_enums.h

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,14 @@ enum class FilterHeadersStatus : int32_t {
4444
Continue = 0,
4545
// The host should suspend further processing of headers until plugin code
4646
// unpauses the stream via a call to `continueRequest` or `continueResponse`.
47+
// Some host implementations may treat this equivalently to
48+
// `StopAllIterationAndWatermark`.
4749
StopIteration = 1,
4850
// The host should terminate the stream.
4951
ContinueAndEndStream = 2,
5052
// The host should suspend further processing of the stream until plugin code
5153
// unpauses the stream via a call to `continueRequest` or `continueResponse`,
52-
// in the meantime buffering all body bytes received.
54+
// in the meantime buffering all body bytes received, subject to host limits.
5355
StopAllIterationAndBuffer = 3,
5456
// The host should suspend further processing of the stream including reading
5557
// body data until plugin code unpauses the stream via a call to
@@ -81,7 +83,7 @@ enum class FilterDataStatus : int32_t {
8183
Continue = 0,
8284
// The host should suspend further processing of the stream until plugin code
8385
// unpauses the stream via a call to `continueRequest` or `continueResponse`,
84-
// in the meantime buffering all body bytes received.
86+
// in the meantime buffering all body bytes received, subject to host limits.
8587
StopIterationAndBuffer = 1,
8688
// The host should suspend further processing of the stream including reading
8789
// body data until plugin code unpauses the stream via a call to

0 commit comments

Comments
 (0)