Skip to content

Commit

Permalink
Fix dmsg documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
林志宇 committed Jun 19, 2019
1 parent 25f677d commit a6d9680
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions pkg/dmsg/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,12 +77,12 @@ The following is a summary of the frame types:
Transports are represented by transport IDs and facilitate duplex communication between two `dmsg.Client`s which are connected to a common `dmsg.Server`.

Transport IDs are assigned in such a manner:
- A `dmsg.Client` manages the assignment of positive transport IDs between itself and each connected `dmsg.Server`. The set of transport IDs will be unique between itself and each `dmsg.Server`.
- A `dmsg.Server` manages the assignment of negative transport IDs between itself and each connected `dmsg.Client`. The set of transport IDs will be unique between itself and each `dmsg.Client`.
- A `dmsg.Client` manages the assignment of even transport IDs between itself and each connected `dmsg.Server`. The set of transport IDs will be unique between itself and each `dmsg.Server`.
- A `dmsg.Server` manages the assignment of odd transport IDs between itself and each connected `dmsg.Client`. The set of transport IDs will be unique between itself and each `dmsg.Client`.

For a given transport:
- Between the initiating client and the common server - the transport ID is always a positive value.
- Between the responding client and the common server - the transport ID is always a negative value.
- Between the initiating client and the common server - the transport ID is always a even value.
- Between the responding client and the common server - the transport ID is always a odd value.

Hence, a transport in it's entirety, is represented by 2 transport IDs.

Expand Down

0 comments on commit a6d9680

Please sign in to comment.