mirror of
https://github.com/falk-werner/webfuse
synced 2026-03-02 03:40:24 +00:00
implemented basic request
This commit is contained in:
36
doc/protocol.md
Normal file
36
doc/protocol.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# Webufse 2 Protocol
|
||||
|
||||
## Endianness
|
||||
|
||||
All numeric data types are transferred in [Big Endian](https://en.wikipedia.org/wiki/Endianness).
|
||||
For instance, the uint32 value 1 will be transferred as
|
||||
|
||||
00 00 00 01
|
||||
|
||||
## Data Types
|
||||
|
||||
### Basic data types
|
||||
|
||||
| Data | Width | Description |
|
||||
| ---- | ------ | ----------- |
|
||||
| bool | 8 bit | Represents a boolean value |
|
||||
| i32 | 32 bit |
|
||||
|
||||
## Message
|
||||
|
||||
|
||||
|
||||
## Methods
|
||||
|
||||
### access
|
||||
|
||||
| Field | Data Type | Description |
|
||||
| ----- | ---------------- | ----------- |
|
||||
| | uint32 | message id |
|
||||
| type | uint8 | message type (0x00) |
|
||||
| path | string | |
|
||||
| mode | access_mode (i8) |
|
||||
|
||||
#### Response
|
||||
|
||||
| Field |
|
||||
Reference in New Issue
Block a user