From aaf21e199ad9ebbc41f194c0af512b444ef33900 Mon Sep 17 00:00:00 2001 From: crykn Date: Thu, 13 Sep 2018 02:01:31 +0200 Subject: [PATCH] Updated the README. --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0f85bae2..42e8e3d6 100644 --- a/README.md +++ b/README.md @@ -5,26 +5,29 @@ A fork of [KryoNet](https://github.com/EsotericSoftware/kryonet/), a Java librar This fork was specifically made for [ProjektGG](https://github.com/eskalon/ProjektGG) but also adds the most demanded features on KryoNet's issue tracker. If you have a pull request for KryoNet also consider adding it here, as KryoNet doesn't seem to be actively maintained anymore. ## Key Changes +* [Kryo 5.0.0-RC1](https://github.com/EsotericSoftware/kryo/releases/tag/kryo-parent-5.0.0-RC1) is used for the serialization (for a list of changes and new features see [here](https://groups.google.com/forum/#!msg/kryo-users/sBZ10dwrwFQ/hb6FF5ZXCQAJ); takes care of [#77](https://github.com/EsotericSoftware/kryonet/issues/77) and [#123](https://github.com/EsotericSoftware/kryonet/issues/123)) * A TypeListener for easier message handling (see the example below; also fixes [#130](https://github.com/EsotericSoftware/kryonet/issues/130)) * Listener is now an interface ([#39](https://github.com/EsotericSoftware/kryonet/issues/39)) -* [Kryo 5.0.0-RC1](https://github.com/EsotericSoftware/kryo/releases/tag/kryo-parent-5.0.0-RC1) is used for the serialization ([#77](https://github.com/EsotericSoftware/kryonet/issues/77); also fixes [#123](https://github.com/EsotericSoftware/kryonet/issues/123)) -* Includes a fix for the common Android 5 crash ([#106](https://github.com/EsotericSoftware/kryonet/issues/106)) +* Includes a fix for the common Android 5.0 crash ([#106](https://github.com/EsotericSoftware/kryonet/issues/106), [#120](https://github.com/EsotericSoftware/kryonet/issues/106)) * The LAN Host Discovery is now available to Non-Kryo-Serializations ([#127](https://github.com/EsotericSoftware/kryonet/issues/127)) -* A few other changes to serializations (see the respective paragraph below) +* Serializers are now created by [factories](https://github.com/crykn/kryonet/blob/master/src/main/java/com/esotericsoftware/kryonet/serialization/SerializationFactory.java) (see the respective paragraph below) * Kryonet now uses a [gradle](https://gradle.org/) build setup +* Java 8 is supported * Various improvements to the documentation (also takes care of [#35](https://github.com/EsotericSoftware/kryonet/issues/35), [#44](https://github.com/EsotericSoftware/kryonet/issues/44), [#124](https://github.com/EsotericSoftware/kryonet/issues/124)) ## Usage of the TypeListener -The type listener takes care of distributing received messages to previously specified handlers. In the following example _con_ is the connection to the client and _msg_ is the received object - already cast to the right type: +The type listener takes care of distributing received messages to previously specified handlers. Especially with lambdas this allows for rather concise code: In the following example _con_ is the connection to the client and _msg_ is the received object - already cast to the right type: ```java TypeListener typeListener = new TypeListener(); - + +// add a type handler for SomeRequest.class typeListener.addTypeHandler(SomeRequest.class, (con, msg) -> { System.out.println(msg.getSomeData()); }); +// add another one for SomeOtherRequest.class typeListener.addTypeHandler(SomeOtherRequest.class, (con, msg) -> { con.sendTCP(new SomeResponse()); @@ -33,7 +36,7 @@ typeListener.addTypeHandler(SomeOtherRequest.class, server.addListener(typeListener); ``` -## Changes to (Custom) Serializations +## Changes to (custom) Serializations * The serialization objects are now created by [factories](https://github.com/crykn/kryonet/blob/master/src/main/java/com/esotericsoftware/kryonet/serialization/SerializationFactory.java): `SerializationFactory#newInstance(Connection)` * The in-built serializations still behave exactly the same (i.e. one serialization instance is used for the server)