summaryrefslogtreecommitdiffstats
path: root/solec.ksy
diff options
context:
space:
mode:
authorbt <bt@rctt.net>2026-04-18 23:12:11 +0200
committerbt <bt@rctt.net>2026-04-18 23:12:33 +0200
commitd63176e22d21e347cf1c197084afe8eb1d5376b4 (patch)
tree501b77a9094dfa09acccaebd7698aee256309925 /solec.ksy
parente9aebac1a2a4732763c2f7e4428a23983d4eb6a3 (diff)
downloadsolec-0.2.0.tar.gz
solec-0.2.0.zip
[docs] Update protocol docsv0.2.0
Diffstat (limited to 'solec.ksy')
-rw-r--r--solec.ksy119
1 files changed, 0 insertions, 119 deletions
diff --git a/solec.ksy b/solec.ksy
deleted file mode 100644
index 7117413..0000000
--- a/solec.ksy
+++ /dev/null
@@ -1,119 +0,0 @@
-meta:
- id: solec
- file-extension: hex
- endian: be
-
-doc: SOLEC protocol
-doc-ref: https://git.rctt.net/solec/plain/docs/protocol.svg?h=main
-
-seq:
- - id: type_payload
- type: u1
- enum: payload_type
- - id: len_payload
- type: u2
- - id: payload
- size: len_payload
- type:
- switch-on: type_payload
- cases:
- 'payload_type::success': success
- 'payload_type::error': error
- 'payload_type::handshake': handshake
- 'payload_type::auth': auth
- 'payload_type::message': message
- 'payload_type::test': test
-
-enums:
- payload_type:
- 0x01: success
- 0x02: error
- 0x03: handshake
- 0x04: auth
- 0x05: message
- 0xFF: test
-
- error_type:
- 0x01: auth_failed
- 0x02: not_found
-
- conn_type:
- 0x01: user_conn
- 0x02: server_conn
-
-types:
- string:
- doc: UTF-8 encoded string.
- seq:
- - id: len_payload
- type: u2
- - id: payload
- type: str
- size: len_payload
- encoding: UTF-8
-
- success:
- doc: Send from server if operation succeded.
-
- error:
- doc: Senf from server if operation failed.
- seq:
- - id: error_code
- type: u1
- enum: error_type
-
- handshake:
- doc: |
- Handshake is sent by the client during connection initialization.
- If protocol_ver_major is different than version used by the server
- connection will be aborted.
- seq:
- - id: proto_ver_major
- type: u1
- - id: proto_ver_minor
- type: u1
- - id: conn_type
- type: u1
- enum: conn_type
-
- auth:
- seq:
- - id: name
- type: string
- - id: pass
- type: string
-
- message:
- doc: |
- Source and target fields are addresses in user@server format.
- seq:
- - id: source
- type: string
- - id: target
- type: string
- - id: timestamp
- doc: Set just before sending the message.
- type: u8
- - id: content
- type: string
-
- test:
- doc: Test payload, used for parsers testing
- seq:
- - id: num1
- type: u1
- - id: time1
- type: u8
- - id: str1
- type: string
- - id: num2
- type: u2
- - id: str2
- type: string
- - id: num3
- type: u4
- - id: str3
- type: string
- - id: num4
- type: u8
-