Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write narrative documentation to explain what Inbound/Outbound mean #138

Closed
Lukasa opened this issue Mar 13, 2018 · 0 comments
Closed

Write narrative documentation to explain what Inbound/Outbound mean #138

Lukasa opened this issue Mar 13, 2018 · 0 comments
Assignees
Milestone

Comments

@Lukasa
Copy link
Contributor

Lukasa commented Mar 13, 2018

Given that channelRead is the most prominent ChannelInboundHandler method, and that write is the most prominent ChannelOutboundHandler method, it's easy for users to assume that inbound means reads, and outbound means writes. This will cause user confusion when they discover that channelWritabilityChanged is an Inbound method, and that read is an Outbound one!

We should write some narrative docs for these two protocols to make it clear that this is not actually how they work: instead, that inbound/outbound is about causality. Specifically, Inbound events are things the socket tells the pipeline, while Outbound events are things the pipeline tells the socket. From that construction it becomes clear why read is Outbound (the pipeline tells the socket to do a read), and why channelWritabilityChanged is Inbound (the socket tells the pipeline whether it's writable or not).

@Lukasa Lukasa self-assigned this Mar 13, 2018
@normanmaurer normanmaurer added this to the 1.3.0 milestone Mar 19, 2018
weissi pushed a commit to weissi/swift-nio that referenced this issue Feb 3, 2024
Changes made:

Removed CI config for 5.0 ad 5.1
Changed 5.2 to be based on 16.04 so we have some coverage there
Converted Package.swift to the latest syntax
Added a description to supported Swift versions in the README
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants