Skip to content
Snippets Groups Projects
Verified Commit bbd0aa68 authored by Janne Mareike Koschinski's avatar Janne Mareike Koschinski
Browse files

Cleanup docs

parent bb5e5920
No related branches found
No related tags found
No related merge requests found
# Protocol Overview
!!! danger
The documentation is still being worked on.
\ No newline at end of file
Our protocol is a multi-layered protocol.
As bottom most layer we have the [Framing Layer](layers/framing.md). This
does the most basic feature negotiation, compression/encryption, and allows
splitting the stream into separate message frames.
On top of that rests the [Message Layer](layers/message.md). It handles
handshaking, core setup, login, and afterwards provides the ability to request
objects, initialize them, and run sync/rpc calls on them.
For our serialization, we describe the basic most functionality in
[Primitive Objects](serialization/primitive_objects.md), and for the different
layers on top, in [Handshake Messages](serialization/handshake_messages.md) and
[Signalproxy Messages](serialization/signalproxy_messages.md).
Features for the Message Layer level feature negotation are specified in
[Features](serialization/features.md).
The sync calls, the sync object serialization, and rpc calls are specified in
[SignalProxy Objects](serialization/signalproxy_objects.md) and
[SignalProxy RPC Calls](serialization/signalproxy_rpc.md).
Our business logic is based solely on these sync, init, and rpc calls. It will
be described at a later time.
\ No newline at end of file
......@@ -507,31 +507,6 @@ interface CoreInfo {
}
```
## DccConfig
!!! danger
This part is still unfinished.
**ObjectName**
As this object is a singleton, the objectName is always `DccConfig`
**Runtime**
```typescript
interface DccConfig {
}
```
**Network**
```typescript
interface DccConfig {
}
```
## HighlightRuleManager
**ObjectName**
......@@ -902,17 +877,26 @@ As this object is a singleton, the objectName is always ``
```typescript
interface IrcListHelper {
}
```
**Network**
// C->S calls
```typescript
interface IrcListHelper {
requestChannelList(netId: NetworkId, channelFilters: QStringList)
// S->C calls
receiveChannelList(netId: NetworkId, channelFilters: QStringList, channels: QVariantList)
reportError(error: QString)
reportFinishedList(netId: NetworkId)
}
```
**Network**
Its network representation is an empty `QVariantMap`, as it has no syncable
fields. For the same reason it also does **not** support the otherwise standard
`update` call.
## IrcUser
**ObjectName**
......
# SignalProxy RPC calls
# SignalProxy RPC Calls
For RPC calls, the full name – e.g. "2createIdentity(Identity,QVariantMap)" has
to be transmitted, including the number at the beginning and the arglist.
......
......@@ -22,7 +22,7 @@ nav:
- "Handshake Messages": protocol/serialization/handshake_messages.md
- "SignalProxy Messages": protocol/serialization/signalproxy_messages.md
- "SignalProxy Objects": protocol/serialization/signalproxy_objects.md
- "SignalProxy RPC calls": protocol/serialization/signalproxy_rpc.md
- "SignalProxy RPC Calls": protocol/serialization/signalproxy_rpc.md
extra:
social:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment