andreacavalli/netty5
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
1c9fe6cb38
netty5/README.md

67 lines
2.6 KiB
Markdown
Raw Normal View History

Update README Motivation: We can add some status badge and also should clarify requirements. Modifictations: - Add status badge - Clarify requirements Result: Cleanup docs
2020-12-27 10:14:08 +01:00
![Build project](https://github.com/netty/netty/workflows/Build%20project/badge.svg)
Update README.md
2013-02-27 01:21:49 +01:00
# Netty Project
Added README
2012-03-12 05:13:41 +01:00
Update README.md
2014-01-16 06:33:00 +01:00
Netty is an asynchronous event-driven network application framework for rapid development of maintainable high performance protocol servers & clients.
Added README
2012-03-12 05:13:41 +01:00
## Links
Change the netty.io homepage scheme(http -> https) (#9344) Motivation: Netty homepage(netty.io) serves both "http" and "https". It's recommended to use https than http. Modification: I changed from "http://netty.io" to "https://netty.io" Result: No effects.
2019-07-09 21:09:42 +02:00
* [Web Site](https://netty.io/)
* [Downloads](https://netty.io/downloads.html)
* [Documentation](https://netty.io/wiki/)
Update README.md
2013-02-27 01:21:49 +01:00
* [@netty_project](https://twitter.com/netty_project)
Added README
2012-03-12 05:13:41 +01:00
Update README.md
2013-02-27 01:21:49 +01:00
## How to build
Added README
2012-03-12 05:13:41 +01:00
Change the netty.io homepage scheme(http -> https) (#9344) Motivation: Netty homepage(netty.io) serves both "http" and "https". It's recommended to use https than http. Modification: I changed from "http://netty.io" to "https://netty.io" Result: No effects.
2019-07-09 21:09:42 +02:00
For the detailed information about building and developing Netty, please visit [the developer guide](https://netty.io/wiki/developer-guide.html). This page only gives very basic information.
update README.md
2013-02-27 01:28:24 +01:00
Update README.md
2013-02-27 01:21:49 +01:00
You require the following to build Netty:
Added README
2012-03-12 05:13:41 +01:00
Fix url in README.md (#10915) Motivation: We had a typo in the markdown Modification: Fix typo Result: Corect markdown
2021-01-11 07:48:58 +01:00
* Latest stable [OpenJDK 8](https://adoptopenjdk.net)
Enable nohttp check during the build (#10708) Motivation: HTTP is a plaintext protocol which means that someone may be able to eavesdrop the data. To prevent this, HTTPS should be used whenever possible. However, maintaining using https:// in all URLs may be difficult. The nohttp tool can help here. The tool scans all the files in a repository and reports where http:// is used. Modifications: - Added nohttp (via checkstyle) into the build process. - Suppressed findings for the websites that don't support HTTPS or that are not reachable Result: - Prevent using HTTP in the future. - Encourage users to use HTTPS when they follow the links they found in the code.
2020-10-23 14:44:18 +02:00
* Latest stable [Apache Maven](https://maven.apache.org/)
Change the netty.io homepage scheme(http -> https) (#9344) Motivation: Netty homepage(netty.io) serves both "http" and "https". It's recommended to use https than http. Modification: I changed from "http://netty.io" to "https://netty.io" Result: No effects.
2019-07-09 21:09:42 +02:00
* If you are on Linux, you need [additional development packages](https://netty.io/wiki/native-transports.html) installed on your system, because you'll build the native transport.
Added README
2012-03-12 05:13:41 +01:00
Update README Motivation: We can add some status badge and also should clarify requirements. Modifictations: - Add status badge - Clarify requirements Result: Cleanup docs
2020-12-27 10:14:08 +01:00
Note that this is build-time requirement. JDK 5 (for 3.x) or 6 (for 4.0+ / 4.1+) is enough to run your Netty-based application.
Added README
2012-03-12 05:13:41 +01:00
Update README.md
2014-01-16 06:33:00 +01:00
## Branches to look
Added README
2012-03-12 05:13:41 +01:00
Update README Motivation: We can add some status badge and also should clarify requirements. Modifictations: - Add status badge - Clarify requirements Result: Cleanup docs
2020-12-27 10:14:08 +01:00
Development of all versions takes place in each branch whose name is identical to `<majorVersion>.<minorVersion>`. For example, the development of 3.9 and 4.1 resides in [the branch '3.9'](https://github.com/netty/netty/tree/3.9) and [the branch '4.1'](https://github.com/netty/netty/tree/4.1) respectively.
Adding stable JDK9 module names that follow reverse-DNS style Automatic-Module-Name entry provides a stable JDK9 module name, when Netty is used in a modular JDK9 applications. More info: http://blog.joda.org/2017/05/java-se-9-jpms-automatic-modules.html When Netty migrates to JDK9 in the future, the entry can be replaced by actual module-info descriptor. Modification: The POM-s are configured to put the correct module names to the manifest. Result: Fixes #7218.
2017-09-23 08:52:39 +02:00
Update README Motivation: We can add some status badge and also should clarify requirements. Modifictations: - Add status badge - Clarify requirements Result: Cleanup docs
2020-12-27 10:14:08 +01:00
## Usage with JDK 9+
Adding stable JDK9 module names that follow reverse-DNS style Automatic-Module-Name entry provides a stable JDK9 module name, when Netty is used in a modular JDK9 applications. More info: http://blog.joda.org/2017/05/java-se-9-jpms-automatic-modules.html When Netty migrates to JDK9 in the future, the entry can be replaced by actual module-info descriptor. Modification: The POM-s are configured to put the correct module names to the manifest. Result: Fixes #7218.
2017-09-23 08:52:39 +02:00
Update README Motivation: We can add some status badge and also should clarify requirements. Modifictations: - Add status badge - Clarify requirements Result: Cleanup docs
2020-12-27 10:14:08 +01:00
Netty can be used in modular JDK9+ applications as a collection of automatic modules. The module names follow the
Adding stable JDK9 module names that follow reverse-DNS style Automatic-Module-Name entry provides a stable JDK9 module name, when Netty is used in a modular JDK9 applications. More info: http://blog.joda.org/2017/05/java-se-9-jpms-automatic-modules.html When Netty migrates to JDK9 in the future, the entry can be replaced by actual module-info descriptor. Modification: The POM-s are configured to put the correct module names to the manifest. Result: Fixes #7218.
2017-09-23 08:52:39 +02:00
reverse-DNS style, and are derived from subproject names rather than root packages due to historical reasons. They
are listed below:
Provide an Automatic-Module-Name for the netty-all artifact fixes #7644 Motivation: The netty-all artifact doesn't have a Automatic-Module-Name defined in the manifest like the rest of the projects do, resulting in requires netty.all. Modification: Add Automatic-Module-Name Result: Correctly work as java9 module.
2018-01-27 10:47:25 +01:00
* `io.netty.all`
Adding stable JDK9 module names that follow reverse-DNS style Automatic-Module-Name entry provides a stable JDK9 module name, when Netty is used in a modular JDK9 applications. More info: http://blog.joda.org/2017/05/java-se-9-jpms-automatic-modules.html When Netty migrates to JDK9 in the future, the entry can be replaced by actual module-info descriptor. Modification: The POM-s are configured to put the correct module names to the manifest. Result: Fixes #7218.
2017-09-23 08:52:39 +02:00
* `io.netty.buffer`
* `io.netty.codec`
* `io.netty.codec.dns`
* `io.netty.codec.haproxy`
* `io.netty.codec.http`
* `io.netty.codec.http2`
* `io.netty.codec.memcache`
* `io.netty.codec.mqtt`
* `io.netty.codec.redis`
* `io.netty.codec.smtp`
* `io.netty.codec.socks`
* `io.netty.codec.stomp`
* `io.netty.codec.xml`
* `io.netty.common`
* `io.netty.handler`
* `io.netty.handler.proxy`
* `io.netty.resolver`
* `io.netty.resolver.dns`
* `io.netty.transport`
* `io.netty.transport.epoll` (`native` omitted - reserved keyword in Java)
* `io.netty.transport.kqueue` (`native` omitted - reserved keyword in Java)
* `io.netty.transport.unix.common` (`native` omitted - reserved keyword in Java)
* `io.netty.transport.rxtx`
* `io.netty.transport.sctp`
* `io.netty.transport.udt`
Automatic modules do not provide any means to declare dependencies, so you need to list each used module separately
in your `module-info` file.
Reference in New Issue Copy Permalink