Skip to content

Commit

Permalink
new: runtime and transport-module doc skeleton (#2)
Browse files Browse the repository at this point in the history
Signed-off-by: Gaukas Wang <[email protected]>
  • Loading branch information
gaukas authored Feb 29, 2024
1 parent c130bde commit 5cf1004
Show file tree
Hide file tree
Showing 6 changed files with 74 additions and 0 deletions.
10 changes: 10 additions & 0 deletions runtime/go.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
layout: default
title: Runtime Library in Go
parent: Runtime Library
nav_order: 1
---

# Runtime Library in Go

WATER Runtime Library for Go (a.k.a. `water-go`).
19 changes: 19 additions & 0 deletions runtime/runtime.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
layout: default
title: Runtime Library
nav_order: 1
has_children: true
permalink: /runtime.html
---

# Runtime Library

WATER provides runtime libraries in multiple programming languages to support the execution of [WebAssembly Transport Modules](/transport-module.html) (WATM) in different applications. A WATER runtime library includes a set of APIs providing a network programming interface for the integrating application to communicate with the WATM, and a WebAssembly runtime to compile/interpret and execute the WATM.

## Available Runtime Libraries

Currently, we offer the following runtime libraries:
- Go: [water](https://github.com/refraction-networking/water)
- Rust: [water-rs](https://github.com/refraction-networking/water-rs)

Please see the documentation for each runtime library for more details.
10 changes: 10 additions & 0 deletions runtime/rust.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
layout: default
title: Runtime Library in Rust
parent: Runtime Library
nav_order: 1
---

# Runtime Library in Rust

WATER Runtime Library for Rust (a.k.a. `water-rs`).
9 changes: 9 additions & 0 deletions transport-module/go.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
layout: default
title: WebAssembly Transport Module in Go
parent: WebAssembly Transport Module
nav_order: 1
---

# WebAssembly Transport Module (WATM) in Go

9 changes: 9 additions & 0 deletions transport-module/rust.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
layout: default
title: WebAssembly Transport Module in Rust
parent: WebAssembly Transport Module
nav_order: 2
---

# WebAssembly Transport Module (WATM) in Rust

17 changes: 17 additions & 0 deletions transport-module/transport-module.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
layout: default
title: WebAssembly Transport Module
nav_order: 2
has_children: true
permalink: /transport-module.html
---

# WebAssembly Transport Module (WATM)

WebAssembly Transport Module (WATM) is a WebAssembly module that provides a set of APIs and act as a transport layer for applications integrating WATER. With the standardized WATM API, it is designed to be a lightweight and portable module that can be easily executed in any WATER Runtime.

## Build a WATM

Theoretically, you can write a WATM in any programming language that compiles to WebAssembly, since a WATM that fully implements the WATM API can be executed in any properly implemented WATER Runtime.

For reference, we provide simple examples of WATMs written in Go and Rust, as well as helper libraries to simplify the development of WATMs in these languages. The ultimate goal is to provide a way to build a WebAssembly-agnostic transport protocol into a WATM without requiring the developer to understand the details of WebAssembly.

0 comments on commit 5cf1004

Please sign in to comment.