-
Notifications
You must be signed in to change notification settings - Fork 4
docs: add a doc about Channel #93
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
Open
majecty
wants to merge
1
commit into
zeroFruit:main
Choose a base branch
from
majecty:borre/doc-channel
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| # Channel | ||
|
|
||
| A Channel is a class that abstracts an object that exchanges data with the outside like a TCP socket. In addition to TCP, it can support functions such as UDP sockets and Unix domain sockets. | ||
| In order to handle events that occur in Channel, el uses ChannelPipeline, ChannelHandlerContext, and ChannelHandler. | ||
|
|
||
|  | ||
|
|
||
| Each Channel has a ChannelPipeline. ChannelPipeline manages ChannelHandler functions, and calls the functions when events occur. ChannelPipeline uses ChannelHandlerContext to manage ChannelHandlers by creating an doubly linked list. | ||
|
|
||
| ## ChannelPipeline | ||
|
|
||
| When a Channel receives an event(like receiving data from a network), it passes it to a ChannelPipeline. The ChannelPipeline calls the first handler. When each handler finishes handling the event, it calls the next handler. | ||
|
|
||
| If we send a message to a TCP channel, the invocation order of the handlers is reversed. | ||
|
|
||
| --- | ||
| TODO: Add an image that explains the order of invocation of handlers. | ||
| --- | ||
|
|
||
| ## ChannelHandler | ||
|
|
||
| A ChannelHandler is an event listener that listens events from a Channel. A ChannelHandler can listen all types of event from a Channel at a time. You can use the ChannelHandler to parse a message, to log the message, or to write business logic. | ||
|
|
||
| ## ChannelHandlerContext | ||
|
|
||
| A ChannelHandlerContext is a wrapping class who is used by a ChannelPipeline to manage ChannelHandlers. | ||
|
|
||
| ## LocalChannel | ||
|
|
||
| A LocalChannel is a Channel that should be used only for test purpose. We can connect two LocalChannel in a process's memory. We cannot use the LocalChannel to communicate with other process or other machine. | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to resolve this TODO before merging