-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
20 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,20 @@ | ||
# protobuf-definitions | ||
Protobuf definitions for function to host callbacks | ||
# Tarmac Protobuf Definitions | ||
|
||
This repository contains the protobuf definitions for the Tarmac project. | ||
|
||
The protobuf definitions are used by Tarmac SDKs or functions directly to perform host calls to the Tarmac server. | ||
Communication between the Tarmac server and functions/SDKs is via [waPC](https://wapc.io/) WebAssembly Procedure Calls. | ||
|
||
## Structure | ||
|
||
| Proto File | Description | | ||
|------------|-------------| | ||
| `tarmac.proto` | Contains common messages used for various message types. | | ||
| `kvstore.proto` | Protobuf definitions for KVStore related messages. | | ||
| `metrics.proto` | Protobuf definitions for Metrics related messages. | | ||
| `http.proto` | Protobuf definitions for HTTP client related messages. | | ||
| `sql.proto` | Protobuf definitions for SQL query related messages. | | ||
|
||
## Contributing | ||
|
||
Contributions are welcome please open an issue or submit a pull request for any changes or improvements. |