Add some docs to note on which message types a bootstrapped Channel w… #207
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Lukasa
requested changes
Mar 21, 2018
Sources/NIO/Bootstrap.swift
Outdated
| /// The returned `ServerSocketChannel` by `bind` is the server channel and will fire the accepted `SocketChannel`s through the `ChannelPipeline` via `fireChannelRead` | ||
| /// and so operate on `Channel` as inbound messages. Outbound messages are not supported by `ServerSocketChannel`, which means each write attempt will be failed. | ||
| /// | ||
| /// The accepted `SocketChannel` will operate on `ByteBuffer` as inbound and `IOData` as outbound messages. |
There was a problem hiding this comment.
Let's change this to: "The EventLoopFuture returned by bind will fire with a ServerSocketChannel. This is the channel that owns the listening socket. Each time it accepts a new connection it will fire a SocketChannel through the ChannelPipeline via fireChannelRead: as a result, the ServerSocketChannel operates on SocketChannels as inbound messages. Outbound messages are not supported on a ServerSocketChannel which means that each write attempt will fail.
Accepted SocketChannels operate on ByteBuffer as inbound data, and IOData as outbound data."
There was a problem hiding this comment.
@Lukasa I think we should still say: as a result, the ServerSocketChannel operates on Channels as inbound messages...
SocketChannel is not public so it may be confusing otherwise if the user tries to use it as InboundIn and can't. WDYT ?
Sources/NIO/Bootstrap.swift
Outdated
| @@ -410,6 +421,7 @@ public final class ClientBootstrap { | |||
| /// try channel.closeFuture.wait() // Wait until the channel un-binds. | |||
| /// ``` | |||
| /// | |||
| /// The `DatagramChannel` will operate on `AddressEnevelope<ByteBuffer>` as inbound and outbound messages. | |||
normanmaurer
force-pushed
the
channel_message_docs
branch
from
971d0c6 to
04b8003
Compare
|
@Lukasa PTAL again |
Lukasa
requested changes
Mar 21, 2018
Sources/NIO/Bootstrap.swift
Outdated
| /// the `ServerSocketChannel` operates on `Channel`s as inbound messages. Outbound messages are not supported on a `ServerSocketChannel` | ||
| /// which means that each write attempt will fail. | ||
| /// | ||
| /// Accepted `SocketChannel`s operate on `ByteBuffer` as inbound data, and IOData as outbound data. |
…ill operate. Motivation: It's not clear to a user which inbound / outbound messages is expected for the different Channel implementations. This can result into wrong code and confused users. Modifications: Add some docs to explain which messages are supported / expected by the different Channels that can be bootstrapped. Result: More clear docs.
normanmaurer
force-pushed
the
channel_message_docs
branch
from
a33dda4 to
d2f19f2
Compare
Lukasa
approved these changes
Mar 21, 2018
weissi
pushed a commit
to weissi/swift-nio
that referenced
this pull request
Jun 13, 2020
weissi
pushed a commit
to weissi/swift-nio
that referenced
this pull request
Feb 3, 2024
Motivation: Now that Swift 5.9 is GM we should update the supported versions and remove 5.6 Modifications: * Update `Package.swift` * Remove `#if swift(>=5.7)` guards * Delete the 5.6 docker compose file and make a 5.10 one * Update docs Result: Remove support for Swift 5.6, add 5.10
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
…ill operate.
Motivation:
It's not clear to a user which inbound / outbound messages is expected for the different Channel implementations. This can result into wrong code and confused users.
Modifications:
Add some docs to explain which messages are supported / expected by the different Channels that can be bootstrapped.
Result:
More clear docs.