Skip to content
This repository has been archived by the owner on Oct 10, 2018. It is now read-only.

fix: use correct id sequence (dialer even/listener odd) #3

Merged
merged 3 commits into from
Oct 1, 2018
Merged

fix: use correct id sequence (dialer even/listener odd) #3

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2aa08b9
fix: use correct id sequence (dialer even/listener odd)
dryajov Apr 11, 2018
506fb65
clarify even/odd tag ussage
dryajov Apr 23, 2018
ec210bd
fix: corrections based on review
dryajov May 30, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,11 @@ necessarily send the first packet, this distinction is just made to make the all

### Opening a new stream
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the section above ^^, we should also get rid of all information about stream IDs, initiators, and receivers.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should also get rid of all information about stream IDs, initiators, and receivers.

There is one part where mentioning initiators makes sense - when talking about flag's oddness.


To open a new stream, first allocate a new unique stream ID; the session initiator allocates odd IDs and the session receiver allocates even IDs. Then, send a message with the flag set to `NewStream`, the ID set to the newly
allocated stream ID, and the data of the message set to the name of the stream.
To open a new stream, first allocate a new stream ID. Then, send a message with the flag set to `NewStream`, the ID set to the newly allocated stream ID, and the data of the message set to the name of the stream.

Stream names are purely for interfaces and are not otherwise considered by the protocol. An empty string may also be used for the stream name, and they may also be repeated (using the same stream name for every stream is valid). Reusing
a stream ID after closing a stream may result in undefined behaviour.
Stream names are purely for interfaces and are not otherwise considered by the protocol. An empty string may also be used for the stream name, and they may also be repeated (using the same stream name for every stream is valid). Reusing a stream ID after closing a stream may result in undefined behaviour.

The party that opens a stream is called the stream initiator. This is used for numbering the streams.
The party that opens a stream is called the stream initiator. This is used to identify whether the message comes from a channel opened locally or remotely. Thus, the stream initiator always uses even flags and stream receivers uses odd flags.

### Writing to a stream

Expand Down