├── src
    └── test
    │   ├── resources
    │       ├── index.html
    │       └── logback.xml
    │   └── java
    │       └── io
    │           └── spring
    │               └── workshop
    │                   └── reactornetty
    │                       ├── http
    │                           ├── HttpCompressionTests.java
    │                           ├── HttpEchoPathParamTests.java
    │                           └── HttpEncodeAndDecodeJsonTests.java
    │                       ├── udp
    │                           ├── UdpSupportsReceivingDatagramTests.java
    │                           └── UdpEchoTests.java
    │                       └── tcp
    │                           └── TcpSendFileTests.java
├── .mvn
    └── wrapper
    │   ├── maven-wrapper.jar
    │   └── maven-wrapper.properties
├── .gitignore
├── README.md
├── pom.xml
├── mvnw.cmd
├── mvnw
└── docs
    ├── README.adoc
    └── index.html


/src/test/resources/index.html:
--------------------------------------------------------------------------------
1 | HELLO


--------------------------------------------------------------------------------
/.mvn/wrapper/maven-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/violetagg/reactor-netty-workshop/HEAD/.mvn/wrapper/maven-wrapper.jar


--------------------------------------------------------------------------------
/.mvn/wrapper/maven-wrapper.properties:
--------------------------------------------------------------------------------
1 | distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.4/apache-maven-3.8.4-bin.zip
2 | wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar
3 | 


--------------------------------------------------------------------------------
/src/test/resources/logback.xml:
--------------------------------------------------------------------------------
 1 | <configuration>
 2 | 
 3 |     <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
 4 |         <encoder>
 5 |             <pattern>
 6 |                 %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n
 7 |             </pattern>
 8 |         </encoder>
 9 |     </appender>
10 | 
11 |     <logger name="reactor.netty" level="DEBUG" />
12 | 
13 |     <root level="info">
14 |         <appender-ref ref="stdout"/>
15 |     </root>
16 | 
17 | </configuration>
18 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | HELP.md
 2 | target/
 3 | !.mvn/wrapper/maven-wrapper.jar
 4 | !**/src/main/**/target/
 5 | !**/src/test/**/target/
 6 | 
 7 | ### STS ###
 8 | .apt_generated
 9 | .classpath
10 | .factorypath
11 | .project
12 | .settings
13 | .springBeans
14 | .sts4-cache
15 | 
16 | ### IntelliJ IDEA ###
17 | .idea
18 | *.iws
19 | *.iml
20 | *.ipr
21 | 
22 | ### NetBeans ###
23 | /nbproject/private/
24 | /nbbuild/
25 | /dist/
26 | /nbdist/
27 | /.nb-gradle/
28 | build/
29 | !**/src/main/**/build/
30 | !**/src/test/**/build/
31 | 
32 | ### VS Code ###
33 | .vscode/
34 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Reactor Netty Workshop
 2 | 
 3 | This repository hosts a complete workshop on `Reactor Netty`.
 4 | 
 5 | ## Prerequisites
 6 | 
 7 | * `Java 8`
 8 | * `Java IDE` installed with `Maven` support
 9 | 
10 | ## How to start
11 | 
12 | * Clone this repository (or fork it)
13 | * Import the project as `Maven` one in your `IDE`
14 | * Make sure that the language level is set to `Java 8` in your `IDE` project settings
15 | * [Follow the script](https://violetagg.github.io/reactor-netty-workshop/)
16 | (the source document is in the `docs` folder) to create `HTTP`/`TCP`/`UDP` server and client
17 | * Fix the `TODO` one by one in the tests under `io.spring.workshop.reactornetty`
18 | package in order to make the unit tests green
19 | * The solution is available in the `complete` branch for comparison. Each step of this workshop
20 | has its companion commit in the git history with a detailed commit message.
21 | 


--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 3 |          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
 4 |     <modelVersion>4.0.0</modelVersion>
 5 | 
 6 |     <groupId>io.spring.workshop</groupId>
 7 |     <artifactId>reactor-netty</artifactId>
 8 |     <version>1.0.0-SNAPSHOT</version>
 9 | 
10 |     <properties>
11 |         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
12 |         <maven.compiler.source>8</maven.compiler.source>
13 |         <maven.compiler.target>8</maven.compiler.target>
14 |     </properties>
15 | 
16 |     <dependencies>
17 |         <dependency>
18 |             <groupId>io.projectreactor.netty</groupId>
19 |             <artifactId>reactor-netty-core</artifactId>
20 |             <version>1.3.0</version>
21 |         </dependency>
22 |         <dependency>
23 |             <groupId>io.projectreactor.netty</groupId>
24 |             <artifactId>reactor-netty-http</artifactId>
25 |             <version>1.3.0</version>
26 |         </dependency>
27 |         <dependency>
28 |             <groupId>com.fasterxml.jackson.core</groupId>
29 |             <artifactId>jackson-databind</artifactId>
30 |             <version>2.20.1</version>
31 |         </dependency>
32 |         <dependency>
33 |             <groupId>ch.qos.logback</groupId>
34 |             <artifactId>logback-classic</artifactId>
35 |             <version>1.2.13</version>
36 |         </dependency>
37 |         <dependency>
38 |             <groupId>ch.qos.logback</groupId>
39 |             <artifactId>logback-core</artifactId>
40 |             <version>1.2.13</version>
41 |         </dependency>
42 |         <dependency>
43 |             <groupId>org.junit.jupiter</groupId>
44 |             <artifactId>junit-jupiter-api</artifactId>
45 |             <version>5.14.1</version>
46 |         </dependency>
47 |         <dependency>
48 |             <groupId>io.netty</groupId>
49 |             <artifactId>netty-pkitesting</artifactId>
50 |             <version>4.2.7.Final</version>
51 |         </dependency>
52 |     </dependencies>
53 | 
54 | </project>
55 | 


--------------------------------------------------------------------------------
/src/test/java/io/spring/workshop/reactornetty/http/HttpCompressionTests.java:
--------------------------------------------------------------------------------
 1 | package io.spring.workshop.reactornetty.http;
 2 | 
 3 | import org.junit.jupiter.api.Test;
 4 | import reactor.netty.DisposableServer;
 5 | 
 6 | import static org.junit.jupiter.api.Assertions.assertEquals;
 7 | import static org.junit.jupiter.api.Assertions.assertNotNull;
 8 | 
 9 | /**
10 |  * Learn how to create HTTP server and client
11 |  *
12 |  * @author Violeta Georgieva
13 |  * @see <a href="https://projectreactor.io/docs/netty/release/api/reactor/netty/http/server/HttpServer.html">HttpServer javadoc</a>
14 |  * @see <a href="https://projectreactor.io/docs/netty/release/api/reactor/netty/http/client/HttpClient.html">HttpClient javadoc</a>
15 |  */
16 | public class HttpCompressionTests {
17 | 
18 |     @Test
19 |     public void httpCompressionTest() {
20 |         // TODO
21 |         // Task 1:
22 |         // 1.1. Prepare the HTTP server
23 |         // 1.2. Configure the port to which this server should bind
24 |         // 1.3. Start the server in a blocking fashion and wait for it
25 |         //      to finish initializing
26 |         //
27 |         // Task 3:
28 |         // 3.3. Apply a wire logger configuration
29 |         // 3.4. Enable compression
30 |         //
31 |         // Task 4:
32 |         // 4.1. Attach an IO handler to react on connected client
33 |         // 4.2. As a response send some string
34 |         DisposableServer server = null;
35 | 
36 |         assertNotNull(server);
37 | 
38 |         // TODO
39 |         // Task 5:
40 |         // 5.1. Prepare the HTTP client
41 |         // 5.2. Obtain the server's port and provide it as a port to which this
42 |         //      client should connect
43 |         // 5.3. Apply a wire logger configuration
44 |         // 5.4. Enable compression
45 |         // 5.5. Prepare a GET request
46 |         // 5.6. Specify the path
47 |         // 5.7. Receive the response, aggregate it and transform it to string
48 |         // 5.8. Subscribe to the returned Mono<String> and block
49 |         String response = null;
50 | 
51 |         assertEquals("compressed response", response);
52 | 
53 |         // TODO
54 |         // Task 2:
55 |         // 2.1. Close the underlying channel opened by the HTTP server
56 |     }
57 | }
58 | 


--------------------------------------------------------------------------------
/src/test/java/io/spring/workshop/reactornetty/http/HttpEchoPathParamTests.java:
--------------------------------------------------------------------------------
 1 | package io.spring.workshop.reactornetty.http;
 2 | 
 3 | import org.junit.jupiter.api.Test;
 4 | import reactor.netty.DisposableServer;
 5 | 
 6 | import static org.junit.jupiter.api.Assertions.assertEquals;
 7 | import static org.junit.jupiter.api.Assertions.assertNotNull;
 8 | 
 9 | /**
10 |  * Learn how to create HTTP server and client
11 |  *
12 |  * @author Violeta Georgieva
13 |  * @see <a href="https://projectreactor.io/docs/netty/release/api/reactor/netty/http/server/HttpServer.html">HttpServer javadoc</a>
14 |  * @see <a href="https://projectreactor.io/docs/netty/release/api/reactor/netty/http/client/HttpClient.html">HttpClient javadoc</a>
15 |  */
16 | public class HttpEchoPathParamTests {
17 | 
18 |     @Test
19 |     public void echoPathParamTest() {
20 |         // TODO
21 |         // Task 1:
22 |         // 1.1. Prepare the HTTP server
23 |         // 1.2. Configure the port to which this server should bind
24 |         // 1.3. Start the server in a blocking fashion and wait for it
25 |         //      to finish initializing
26 |         //
27 |         // Task 3:
28 |         // 3.3. Apply a wire logger configuration
29 |         //
30 |         // Task 4:
31 |         // 4.1. Define that the server will respond to POST requests
32 |         // 4.2. Define the expected URI
33 |         // 4.3. Define path parameter
34 |         // 4.4. As a response send the received request body, which
35 |         //      is transformed to string and concatenated with the path parameter
36 |         DisposableServer server = null;
37 | 
38 |         assertNotNull(server);
39 | 
40 |         // TODO
41 |         // Task 5:
42 |         // 5.1. Prepare the HTTP client
43 |         // 5.2. Obtain the server's port and provide it as a port to which this
44 |         //      client should connect
45 |         // 5.3. Apply a wire logger configuration
46 |         // 5.4. As specify header 'Content-Type: text/plain'
47 |         // 5.5. Prepare a POST request
48 |         // 5.6. Specify the path and include path parameter
49 |         // 5.7. Send some string as a request body
50 |         // 5.8. Receive the response, aggregate it and transform it to string
51 |         // 5.9. Subscribe to the returned Mono<String> and block
52 |         String response = null;
53 | 
54 |         assertEquals("Hello World!", response);
55 | 
56 |         // TODO
57 |         // Task 2:
58 |         // 2.1. Close the underlying channel opened by the HTTP server
59 |     }
60 | }
61 | 


--------------------------------------------------------------------------------
/src/test/java/io/spring/workshop/reactornetty/udp/UdpSupportsReceivingDatagramTests.java:
--------------------------------------------------------------------------------
 1 | package io.spring.workshop.reactornetty.udp;
 2 | 
 3 | import org.junit.jupiter.api.Test;
 4 | import reactor.netty.Connection;
 5 | import reactor.netty.resources.LoopResources;
 6 | 
 7 | import java.util.concurrent.CountDownLatch;
 8 | import java.util.concurrent.TimeUnit;
 9 | 
10 | import static org.junit.jupiter.api.Assertions.assertNotNull;
11 | import static org.junit.jupiter.api.Assertions.assertTrue;
12 | 
13 | 
14 | /**
15 |  * Learn how to create UDP server
16 |  *
17 |  * @author Violeta Georgieva
18 |  * @see <a href="https://projectreactor.io/docs/netty/release/api/reactor/netty/udp/UdpServer.html">UdpServer javadoc</a>
19 |  */
20 | public class UdpSupportsReceivingDatagramTests {
21 | 
22 |     @Test
23 |     public void supportsReceivingDatagramTest() throws Exception {
24 |         // TODO
25 |         // Task 1:
26 |         // 1.1. Prepare the UDP server
27 |         // 1.2. Configure the port to which this server should bind
28 |         // 1.3. Bind the server
29 |         // 1.4. Subscribe to the returned Mono<Connection> and block
30 |         // 1.5. Create a new simple LoopResources
31 |         // 1.6. Configure the UDP server to run on this newly created LoopResources
32 |         // 1.7. Apply a wire logger configuration
33 |         //
34 |         // Task 6:
35 |         // 6.1. Attach an IO handler
36 |         // 6.2. When receive a package, transform it to byte array
37 |         // 6.3. On every emitted byte array, inspect the byte array's length
38 |         //      and if it is the expected size, decrement the count of the latch
39 |         LoopResources loopResources = null;
40 |         CountDownLatch latch = new CountDownLatch(4);
41 |         Connection server1 = null;
42 | 
43 |         assertNotNull(server1);
44 | 
45 |         // TODO
46 |         // Task 3:
47 |         // 3.1. Prepare the UDP server
48 |         // 3.2. Configure the port to which this server should bind
49 |         // 3.3. Bind the server
50 |         // 3.4. Subscribe to the returned Mono<Connection> and block
51 |         // 3.5. Create a new simple LoopResources
52 |         // 3.6. Configure the UDP server to run on this newly created LoopResources
53 |         // 3.7. Apply a wire logger configuration
54 |         //
55 |         // Task 5:
56 |         // 5.1. As soon as bind operation completed successfully, open a DatagramChannel,
57 |         //      connect to the server1's port, send data and close the channel
58 |         Connection server2 = null;
59 | 
60 |         assertNotNull(server2);
61 | 
62 |         assertTrue(latch.await(30, TimeUnit.SECONDS));
63 | 
64 |         // TODO
65 |         // Task 2:
66 |         // 2.1. Close the underlying channel opened by the UDP server
67 | 
68 |         // TODO
69 |         // Task 4:
70 |         // 4.1. Close the underlying channel opened by the UDP server
71 |     }
72 | }
73 | 


--------------------------------------------------------------------------------
/src/test/java/io/spring/workshop/reactornetty/udp/UdpEchoTests.java:
--------------------------------------------------------------------------------
 1 | package io.spring.workshop.reactornetty.udp;
 2 | 
 3 | import org.junit.jupiter.api.Test;
 4 | import reactor.netty.Connection;
 5 | import reactor.netty.resources.LoopResources;
 6 | 
 7 | import java.util.concurrent.CountDownLatch;
 8 | import java.util.concurrent.TimeUnit;
 9 | 
10 | import static org.junit.jupiter.api.Assertions.assertNotNull;
11 | import static org.junit.jupiter.api.Assertions.assertTrue;
12 | 
13 | 
14 | /**
15 |  * Learn how to create UDP server and client
16 |  *
17 |  * @author Violeta Georgieva
18 |  * @see <a href="https://projectreactor.io/docs/netty/release/api/reactor/netty/udp/UdpServer.html">UdpServer javadoc</a>
19 |  * @see <a href="https://projectreactor.io/docs/netty/release/api/reactor/netty/udp/UdpClient.html">UdpClient javadoc</a>
20 |  */
21 | public class UdpEchoTests {
22 | 
23 |     @Test
24 |     public void echoTest() throws Exception {
25 |         // TODO
26 |         // Task 1:
27 |         // 1.1. Prepare the UDP server
28 |         // 1.2. Configure the port to which this server should bind
29 |         // 1.3. Bind the server
30 |         // 1.4. Subscribe to the returned Mono<Connection> and block
31 |         //
32 |         // Task 3:
33 |         // 3.1. Create a new simple LoopResources
34 |         // 3.2. Configure the UDP server to run on this newly created LoopResources
35 |         // 3.3. Apply a wire logger configuration
36 |         //
37 |         // Task 4:
38 |         // 4.1. Attach an IO handler to react on connected client
39 |         // 4.2. When receive an object (io.netty.channel.socket.DatagramPacket),
40 |         //      transform it and send the new object to the client
41 |         LoopResources loopResources = null;
42 |         Connection server = null;
43 | 
44 |         assertNotNull(server);
45 | 
46 |         // TODO
47 |         // Task 5:
48 |         // 5.1. Prepare the UDP client
49 |         // 5.2. Obtain the server's address and provide it as an address to which this
50 |         //      client should connect
51 |         // 5.3. Connect the client
52 |         // 5.4. Subscribe to the returned Mono<Connection> and block
53 |         //
54 |         // Task 7:
55 |         // 7.1. Create a new simple LoopResources
56 |         // 7.2. Configure the UDP client to run on this newly created LoopResources
57 |         // 7.3. Apply a wire logger configuration
58 |         //
59 |         // Task 8:
60 |         // 8.1. Attach an IO handler
61 |         // 8.2. Send a string over the wire
62 |         // 8.3. When receive an object (io.netty.channel.socket.DatagramPacket),
63 |         //      inspect whether is it the expected reply and decrements the count of the latch
64 |         CountDownLatch latch = new CountDownLatch(1);
65 |         Connection client = null;
66 | 
67 |         assertNotNull(client);
68 | 
69 |         assertTrue(latch.await(30, TimeUnit.SECONDS));
70 | 
71 |         // TODO
72 |         // Task 2:
73 |         // 2.1. Close the underlying channel opened by the UDP server
74 | 
75 |         // TODO
76 |         // Task 6:
77 |         // 6.1. Close the underlying channel opened by the UDP client
78 |     }
79 | }
80 | 


--------------------------------------------------------------------------------
/src/test/java/io/spring/workshop/reactornetty/tcp/TcpSendFileTests.java:
--------------------------------------------------------------------------------
 1 | package io.spring.workshop.reactornetty.tcp;
 2 | 
 3 | import org.junit.jupiter.api.Test;
 4 | import reactor.netty.Connection;
 5 | import reactor.netty.DisposableServer;
 6 | 
 7 | import java.util.concurrent.CountDownLatch;
 8 | import java.util.concurrent.TimeUnit;
 9 | 
10 | import static org.junit.jupiter.api.Assertions.assertNotNull;
11 | import static org.junit.jupiter.api.Assertions.assertTrue;
12 | 
13 | 
14 | /**
15 |  * Learn how to create TCP server and client
16 |  *
17 |  * @author Violeta Georgieva
18 |  * @see <a href="https://projectreactor.io/docs/netty/release/api/reactor/netty/tcp/TcpServer.html">TcpServer javadoc</a>
19 |  * @see <a href="https://projectreactor.io/docs/netty/release/api/reactor/netty/tcp/TcpClient.html">TcpClient javadoc</a>
20 |  */
21 | public class TcpSendFileTests {
22 | 
23 |     @Test
24 |     public void sendFileTest() throws Exception {
25 |         // TODO
26 |         // Task 1:
27 |         // 1.1. Prepare the TCP server
28 |         // 1.2. Configure the port to which this server should bind
29 |         // 1.3. Start the server in a blocking fashion and wait for it
30 |         //      to finish initializing
31 |         //
32 |         // Task 3:
33 |         // 3.1. Enable SSL configuration with self singed certificate.
34 |         // 3.3. Apply a wire logger configuration
35 |         //
36 |         // Task 4:
37 |         // 4.1. Attach an IO handler to react on connected client
38 |         // 4.2. When receive an object, transform it to string
39 |         //      (this will be name of the requested file)
40 |         // 4.3. As a response send the requested file to the client
41 |         DisposableServer server = null;
42 | 
43 |         assertNotNull(server);
44 | 
45 |         // TODO
46 |         // Task 5:
47 |         // 5.1. Prepare the TCP client
48 |         // 5.2. Obtain the server's address and provide it as an address to which this
49 |         //      client should connect
50 |         // 5.3. Block the client and return a Connection
51 |         //
52 |         // Task 7:
53 |         // 7.1. Apply an SSL configuration customization via a preconfigured SslContext,
54 |         //      use SslContextBuilder for building SslContext, as a trust manager
55 |         //      use InsecureTrustManagerFactory
56 |         // 7.3. Apply a wire logger configuration
57 |         //
58 |         // Task 8:
59 |         // 8.1. Attach an IO handler
60 |         // 8.2. Send the file name as string over the wire
61 |         // 8.3. When receive a package, transform it to byte array
62 |         // 8.4. Compare the received byte array with file's bytes
63 |         //      and if they are the same, decrement the count of the latch
64 |         CountDownLatch latch = new CountDownLatch(1);
65 |         Connection client = null;
66 | 
67 |         assertNotNull(client);
68 | 
69 |         assertTrue(latch.await(30, TimeUnit.SECONDS));
70 | 
71 |         // TODO
72 |         // Task 2:
73 |         // 2.1. Close the underlying channel opened by the TCP server
74 | 
75 |         // TODO
76 |         // Task 6:
77 |         // 6.1. Close the underlying channel opened by the TCP client
78 |     }
79 | }
80 | 


--------------------------------------------------------------------------------
/src/test/java/io/spring/workshop/reactornetty/http/HttpEncodeAndDecodeJsonTests.java:
--------------------------------------------------------------------------------
  1 | package io.spring.workshop.reactornetty.http;
  2 | 
  3 | import com.fasterxml.jackson.databind.ObjectMapper;
  4 | import io.netty.buffer.ByteBuf;
  5 | import io.netty.buffer.Unpooled;
  6 | import org.junit.jupiter.api.BeforeEach;
  7 | import org.junit.jupiter.api.Test;
  8 | import reactor.netty.DisposableServer;
  9 | 
 10 | import java.io.ByteArrayOutputStream;
 11 | import java.util.List;
 12 | import java.util.function.Function;
 13 | 
 14 | import static org.junit.jupiter.api.Assertions.assertEquals;
 15 | import static org.junit.jupiter.api.Assertions.assertNotNull;
 16 | 
 17 | /**
 18 |  * Learn how to create HTTP server and client
 19 |  *
 20 |  * @author Violeta Georgieva
 21 |  * @see <a href="https://projectreactor.io/docs/netty/release/api/reactor/netty/http/server/HttpServer.html">HttpServer javadoc</a>
 22 |  * @see <a href="https://projectreactor.io/docs/netty/release/api/reactor/netty/http/client/HttpClient.html">HttpClient javadoc</a>
 23 |  */
 24 | public class HttpEncodeAndDecodeJsonTests {
 25 |     private Function<List<Pojo>, ByteBuf> jsonEncoder;
 26 |     private Function<String, Pojo[]> jsonDecoder;
 27 | 
 28 |     @BeforeEach
 29 |     public void setUp() {
 30 |         ObjectMapper mapper = new ObjectMapper();
 31 | 
 32 |         jsonEncoder = pojo -> {
 33 |             try {
 34 |                 ByteArrayOutputStream out = new ByteArrayOutputStream();
 35 |                 mapper.writeValue(out, pojo);
 36 |                 return Unpooled.copiedBuffer(out.toByteArray());
 37 |             } catch(Exception e) {
 38 |                 throw new RuntimeException(e);
 39 |             }
 40 |         };
 41 | 
 42 |         jsonDecoder = s -> {
 43 |             try {
 44 |                 return mapper.readValue(s, Pojo[].class);
 45 |             } catch(Exception e) {
 46 |                 throw new RuntimeException(e);
 47 |             }
 48 |         };
 49 |     }
 50 | 
 51 |     @Test
 52 |     public void encodeAndDecodeJsonTest() {
 53 |         // TODO
 54 |         // Task 1:
 55 |         // 1.1. Prepare the HTTP server
 56 |         // 1.2. Configure the port to which this server should bind
 57 |         // 1.3. Start the server in a blocking fashion and wait for it
 58 |         //      to finish initializing
 59 |         //
 60 |         // Task 3:
 61 |         // 3.3. Apply a wire logger configuration
 62 |         //
 63 |         // Task 4:
 64 |         // 4.1. Add to the request pipeline a new handler 'JsonObjectDecoder'
 65 |         // 4.2. When receive the request body, transform it to string
 66 |         // 4.3. Use the snippet below to do JSON decoding, prepare response as batches
 67 |         //      and do JSON encoding
 68 |         // ----
 69 |         //    out.send(in.withConnection(c -> c.addHandler(new JsonObjectDecoder()))
 70 |         //               .receive()
 71 |         //               .asString()
 72 |         //               .map(jsonDecoder)
 73 |         //               .concatMap(Flux::fromArray)
 74 |         //               .window(5)
 75 |         //               .concatMap(w -> w.collectList().map(jsonEncoder))))
 76 |         // ----
 77 |         // 4.4. Send the response
 78 |         DisposableServer server = null;
 79 | 
 80 |         assertNotNull(server);
 81 | 
 82 |         // TODO
 83 |         // Task 5:
 84 |         // 5.1. Prepare the HTTP client
 85 |         // 5.2. Obtain the server's port and provide it as a port to which this
 86 |         //      client should connect
 87 |         // 5.3. Apply a wire logger configuration
 88 |         // 5.4. Add to the request pipeline a new handler 'JsonObjectDecoder'
 89 |         // 5.5. Prepare a POST request
 90 |         // 5.6. Specify the path
 91 |         // 5.7. Send the snippet below as a request body. It will do JSON encoding
 92 |         // ----
 93 |         //      Flux.range(1, 10)
 94 |         //          .map(i -> new Pojo("test " + i))
 95 |         //          .collectList()
 96 |         //          .map(jsonEncoder)
 97 |         // ----
 98 |         // 5.8. Receive the response, transform it to string and do JSON decoding
 99 |         // ----
100 |         //      <response-bytes>.asString()
101 |         //                      .map(jsonDecoder)
102 |         //                      .concatMap(Flux::fromArray)
103 |         // ----
104 |         // 5.9. Subscribe to the returned Flux<Pojo> and block the last element
105 |         Pojo response = null;
106 | 
107 |         assertEquals("test 10", response.getName());
108 | 
109 |         // TODO
110 |         // Task 2:
111 |         // 2.1. Close the underlying channel opened by the HTTP server
112 |     }
113 | 
114 |     private static final class Pojo {
115 |         private String name;
116 | 
117 |         Pojo() {
118 |         }
119 | 
120 |         Pojo(String name) {
121 |             this.name = name;
122 |         }
123 | 
124 |         public String getName() {
125 |             return name;
126 |         }
127 | 
128 |         public void setName(String name) {
129 |             this.name = name;
130 |         }
131 | 
132 |         @Override
133 |         public String toString() {
134 |             return "Pojo {" + "name='" + name + '\'' + '}';
135 |         }
136 |     }
137 | }
138 | 


--------------------------------------------------------------------------------
/mvnw.cmd:
--------------------------------------------------------------------------------
  1 | @REM ----------------------------------------------------------------------------
  2 | @REM Licensed to the Apache Software Foundation (ASF) under one
  3 | @REM or more contributor license agreements.  See the NOTICE file
  4 | @REM distributed with this work for additional information
  5 | @REM regarding copyright ownership.  The ASF licenses this file
  6 | @REM to you under the Apache License, Version 2.0 (the
  7 | @REM "License"); you may not use this file except in compliance
  8 | @REM with the License.  You may obtain a copy of the License at
  9 | @REM
 10 | @REM    https://www.apache.org/licenses/LICENSE-2.0
 11 | @REM
 12 | @REM Unless required by applicable law or agreed to in writing,
 13 | @REM software distributed under the License is distributed on an
 14 | @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 15 | @REM KIND, either express or implied.  See the License for the
 16 | @REM specific language governing permissions and limitations
 17 | @REM under the License.
 18 | @REM ----------------------------------------------------------------------------
 19 | 
 20 | @REM ----------------------------------------------------------------------------
 21 | @REM Maven Start Up Batch script
 22 | @REM
 23 | @REM Required ENV vars:
 24 | @REM JAVA_HOME - location of a JDK home dir
 25 | @REM
 26 | @REM Optional ENV vars
 27 | @REM M2_HOME - location of maven2's installed home dir
 28 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands
 29 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending
 30 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven
 31 | @REM     e.g. to debug Maven itself, use
 32 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
 33 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files
 34 | @REM ----------------------------------------------------------------------------
 35 | 
 36 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on'
 37 | @echo off
 38 | @REM set title of command window
 39 | title %0
 40 | @REM enable echoing by setting MAVEN_BATCH_ECHO to 'on'
 41 | @if "%MAVEN_BATCH_ECHO%" == "on"  echo %MAVEN_BATCH_ECHO%
 42 | 
 43 | @REM set %HOME% to equivalent of $HOME
 44 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%")
 45 | 
 46 | @REM Execute a user defined script before this one
 47 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre
 48 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending
 49 | if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %*
 50 | if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %*
 51 | :skipRcPre
 52 | 
 53 | @setlocal
 54 | 
 55 | set ERROR_CODE=0
 56 | 
 57 | @REM To isolate internal variables from possible post scripts, we use another setlocal
 58 | @setlocal
 59 | 
 60 | @REM ==== START VALIDATION ====
 61 | if not "%JAVA_HOME%" == "" goto OkJHome
 62 | 
 63 | echo.
 64 | echo Error: JAVA_HOME not found in your environment. >&2
 65 | echo Please set the JAVA_HOME variable in your environment to match the >&2
 66 | echo location of your Java installation. >&2
 67 | echo.
 68 | goto error
 69 | 
 70 | :OkJHome
 71 | if exist "%JAVA_HOME%\bin\java.exe" goto init
 72 | 
 73 | echo.
 74 | echo Error: JAVA_HOME is set to an invalid directory. >&2
 75 | echo JAVA_HOME = "%JAVA_HOME%" >&2
 76 | echo Please set the JAVA_HOME variable in your environment to match the >&2
 77 | echo location of your Java installation. >&2
 78 | echo.
 79 | goto error
 80 | 
 81 | @REM ==== END VALIDATION ====
 82 | 
 83 | :init
 84 | 
 85 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn".
 86 | @REM Fallback to current working directory if not found.
 87 | 
 88 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR%
 89 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir
 90 | 
 91 | set EXEC_DIR=%CD%
 92 | set WDIR=%EXEC_DIR%
 93 | :findBaseDir
 94 | IF EXIST "%WDIR%"\.mvn goto baseDirFound
 95 | cd ..
 96 | IF "%WDIR%"=="%CD%" goto baseDirNotFound
 97 | set WDIR=%CD%
 98 | goto findBaseDir
 99 | 
100 | :baseDirFound
101 | set MAVEN_PROJECTBASEDIR=%WDIR%
102 | cd "%EXEC_DIR%"
103 | goto endDetectBaseDir
104 | 
105 | :baseDirNotFound
106 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR%
107 | cd "%EXEC_DIR%"
108 | 
109 | :endDetectBaseDir
110 | 
111 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig
112 | 
113 | @setlocal EnableExtensions EnableDelayedExpansion
114 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a
115 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS%
116 | 
117 | :endReadAdditionalConfig
118 | 
119 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe"
120 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar"
121 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
122 | 
123 | set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar"
124 | 
125 | FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO (
126 |     IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B
127 | )
128 | 
129 | @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
130 | @REM This allows using the maven wrapper in projects that prohibit checking in binary data.
131 | if exist %WRAPPER_JAR% (
132 |     if "%MVNW_VERBOSE%" == "true" (
133 |         echo Found %WRAPPER_JAR%
134 |     )
135 | ) else (
136 |     if not "%MVNW_REPOURL%" == "" (
137 |         SET DOWNLOAD_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar"
138 |     )
139 |     if "%MVNW_VERBOSE%" == "true" (
140 |         echo Couldn't find %WRAPPER_JAR%, downloading it ...
141 |         echo Downloading from: %DOWNLOAD_URL%
142 |     )
143 | 
144 |     powershell -Command "&{"^
145 | 		"$webclient = new-object System.Net.WebClient;"^
146 | 		"if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^
147 | 		"$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^
148 | 		"}"^
149 | 		"[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')"^
150 | 		"}"
151 |     if "%MVNW_VERBOSE%" == "true" (
152 |         echo Finished downloading %WRAPPER_JAR%
153 |     )
154 | )
155 | @REM End of extension
156 | 
157 | @REM Provide a "standardized" way to retrieve the CLI args that will
158 | @REM work with both Windows and non-Windows executions.
159 | set MAVEN_CMD_LINE_ARGS=%*
160 | 
161 | %MAVEN_JAVA_EXE% ^
162 |   %JVM_CONFIG_MAVEN_PROPS% ^
163 |   %MAVEN_OPTS% ^
164 |   %MAVEN_DEBUG_OPTS% ^
165 |   -classpath %WRAPPER_JAR% ^
166 |   "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^
167 |   %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %*
168 | if ERRORLEVEL 1 goto error
169 | goto end
170 | 
171 | :error
172 | set ERROR_CODE=1
173 | 
174 | :end
175 | @endlocal & set ERROR_CODE=%ERROR_CODE%
176 | 
177 | if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost
178 | @REM check for post script, once with legacy .bat ending and once with .cmd ending
179 | if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat"
180 | if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd"
181 | :skipRcPost
182 | 
183 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on'
184 | if "%MAVEN_BATCH_PAUSE%"=="on" pause
185 | 
186 | if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE%
187 | 
188 | cmd /C exit /B %ERROR_CODE%
189 | 


--------------------------------------------------------------------------------
/mvnw:
--------------------------------------------------------------------------------
  1 | #!/bin/sh
  2 | # ----------------------------------------------------------------------------
  3 | # Licensed to the Apache Software Foundation (ASF) under one
  4 | # or more contributor license agreements.  See the NOTICE file
  5 | # distributed with this work for additional information
  6 | # regarding copyright ownership.  The ASF licenses this file
  7 | # to you under the Apache License, Version 2.0 (the
  8 | # "License"); you may not use this file except in compliance
  9 | # with the License.  You may obtain a copy of the License at
 10 | #
 11 | #    https://www.apache.org/licenses/LICENSE-2.0
 12 | #
 13 | # Unless required by applicable law or agreed to in writing,
 14 | # software distributed under the License is distributed on an
 15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 16 | # KIND, either express or implied.  See the License for the
 17 | # specific language governing permissions and limitations
 18 | # under the License.
 19 | # ----------------------------------------------------------------------------
 20 | 
 21 | # ----------------------------------------------------------------------------
 22 | # Maven Start Up Batch script
 23 | #
 24 | # Required ENV vars:
 25 | # ------------------
 26 | #   JAVA_HOME - location of a JDK home dir
 27 | #
 28 | # Optional ENV vars
 29 | # -----------------
 30 | #   M2_HOME - location of maven2's installed home dir
 31 | #   MAVEN_OPTS - parameters passed to the Java VM when running Maven
 32 | #     e.g. to debug Maven itself, use
 33 | #       set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
 34 | #   MAVEN_SKIP_RC - flag to disable loading of mavenrc files
 35 | # ----------------------------------------------------------------------------
 36 | 
 37 | if [ -z "$MAVEN_SKIP_RC" ] ; then
 38 | 
 39 |   if [ -f /usr/local/etc/mavenrc ] ; then
 40 |     . /usr/local/etc/mavenrc
 41 |   fi
 42 | 
 43 |   if [ -f /etc/mavenrc ] ; then
 44 |     . /etc/mavenrc
 45 |   fi
 46 | 
 47 |   if [ -f "$HOME/.mavenrc" ] ; then
 48 |     . "$HOME/.mavenrc"
 49 |   fi
 50 | 
 51 | fi
 52 | 
 53 | # OS specific support.  $var _must_ be set to either true or false.
 54 | cygwin=false;
 55 | darwin=false;
 56 | mingw=false
 57 | case "`uname`" in
 58 |   CYGWIN*) cygwin=true ;;
 59 |   MINGW*) mingw=true;;
 60 |   Darwin*) darwin=true
 61 |     # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home
 62 |     # See https://developer.apple.com/library/mac/qa/qa1170/_index.html
 63 |     if [ -z "$JAVA_HOME" ]; then
 64 |       if [ -x "/usr/libexec/java_home" ]; then
 65 |         export JAVA_HOME="`/usr/libexec/java_home`"
 66 |       else
 67 |         export JAVA_HOME="/Library/Java/Home"
 68 |       fi
 69 |     fi
 70 |     ;;
 71 | esac
 72 | 
 73 | if [ -z "$JAVA_HOME" ] ; then
 74 |   if [ -r /etc/gentoo-release ] ; then
 75 |     JAVA_HOME=`java-config --jre-home`
 76 |   fi
 77 | fi
 78 | 
 79 | if [ -z "$M2_HOME" ] ; then
 80 |   ## resolve links - $0 may be a link to maven's home
 81 |   PRG="$0"
 82 | 
 83 |   # need this for relative symlinks
 84 |   while [ -h "$PRG" ] ; do
 85 |     ls=`ls -ld "$PRG"`
 86 |     link=`expr "$ls" : '.*-> \(.*\)$'`
 87 |     if expr "$link" : '/.*' > /dev/null; then
 88 |       PRG="$link"
 89 |     else
 90 |       PRG="`dirname "$PRG"`/$link"
 91 |     fi
 92 |   done
 93 | 
 94 |   saveddir=`pwd`
 95 | 
 96 |   M2_HOME=`dirname "$PRG"`/..
 97 | 
 98 |   # make it fully qualified
 99 |   M2_HOME=`cd "$M2_HOME" && pwd`
100 | 
101 |   cd "$saveddir"
102 |   # echo Using m2 at $M2_HOME
103 | fi
104 | 
105 | # For Cygwin, ensure paths are in UNIX format before anything is touched
106 | if $cygwin ; then
107 |   [ -n "$M2_HOME" ] &&
108 |     M2_HOME=`cygpath --unix "$M2_HOME"`
109 |   [ -n "$JAVA_HOME" ] &&
110 |     JAVA_HOME=`cygpath --unix "$JAVA_HOME"`
111 |   [ -n "$CLASSPATH" ] &&
112 |     CLASSPATH=`cygpath --path --unix "$CLASSPATH"`
113 | fi
114 | 
115 | # For Mingw, ensure paths are in UNIX format before anything is touched
116 | if $mingw ; then
117 |   [ -n "$M2_HOME" ] &&
118 |     M2_HOME="`(cd "$M2_HOME"; pwd)`"
119 |   [ -n "$JAVA_HOME" ] &&
120 |     JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`"
121 | fi
122 | 
123 | if [ -z "$JAVA_HOME" ]; then
124 |   javaExecutable="`which javac`"
125 |   if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then
126 |     # readlink(1) is not available as standard on Solaris 10.
127 |     readLink=`which readlink`
128 |     if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then
129 |       if $darwin ; then
130 |         javaHome="`dirname \"$javaExecutable\"`"
131 |         javaExecutable="`cd \"$javaHome\" && pwd -P`/javac"
132 |       else
133 |         javaExecutable="`readlink -f \"$javaExecutable\"`"
134 |       fi
135 |       javaHome="`dirname \"$javaExecutable\"`"
136 |       javaHome=`expr "$javaHome" : '\(.*\)/bin'`
137 |       JAVA_HOME="$javaHome"
138 |       export JAVA_HOME
139 |     fi
140 |   fi
141 | fi
142 | 
143 | if [ -z "$JAVACMD" ] ; then
144 |   if [ -n "$JAVA_HOME"  ] ; then
145 |     if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
146 |       # IBM's JDK on AIX uses strange locations for the executables
147 |       JAVACMD="$JAVA_HOME/jre/sh/java"
148 |     else
149 |       JAVACMD="$JAVA_HOME/bin/java"
150 |     fi
151 |   else
152 |     JAVACMD="`\\unset -f command; \\command -v java`"
153 |   fi
154 | fi
155 | 
156 | if [ ! -x "$JAVACMD" ] ; then
157 |   echo "Error: JAVA_HOME is not defined correctly." >&2
158 |   echo "  We cannot execute $JAVACMD" >&2
159 |   exit 1
160 | fi
161 | 
162 | if [ -z "$JAVA_HOME" ] ; then
163 |   echo "Warning: JAVA_HOME environment variable is not set."
164 | fi
165 | 
166 | CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher
167 | 
168 | # traverses directory structure from process work directory to filesystem root
169 | # first directory with .mvn subdirectory is considered project base directory
170 | find_maven_basedir() {
171 | 
172 |   if [ -z "$1" ]
173 |   then
174 |     echo "Path not specified to find_maven_basedir"
175 |     return 1
176 |   fi
177 | 
178 |   basedir="$1"
179 |   wdir="$1"
180 |   while [ "$wdir" != '/' ] ; do
181 |     if [ -d "$wdir"/.mvn ] ; then
182 |       basedir=$wdir
183 |       break
184 |     fi
185 |     # workaround for JBEAP-8937 (on Solaris 10/Sparc)
186 |     if [ -d "${wdir}" ]; then
187 |       wdir=`cd "$wdir/.."; pwd`
188 |     fi
189 |     # end of workaround
190 |   done
191 |   echo "${basedir}"
192 | }
193 | 
194 | # concatenates all lines of a file
195 | concat_lines() {
196 |   if [ -f "$1" ]; then
197 |     echo "$(tr -s '\n' ' ' < "$1")"
198 |   fi
199 | }
200 | 
201 | BASE_DIR=`find_maven_basedir "$(pwd)"`
202 | if [ -z "$BASE_DIR" ]; then
203 |   exit 1;
204 | fi
205 | 
206 | ##########################################################################################
207 | # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
208 | # This allows using the maven wrapper in projects that prohibit checking in binary data.
209 | ##########################################################################################
210 | if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then
211 |     if [ "$MVNW_VERBOSE" = true ]; then
212 |       echo "Found .mvn/wrapper/maven-wrapper.jar"
213 |     fi
214 | else
215 |     if [ "$MVNW_VERBOSE" = true ]; then
216 |       echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..."
217 |     fi
218 |     if [ -n "$MVNW_REPOURL" ]; then
219 |       jarUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar"
220 |     else
221 |       jarUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar"
222 |     fi
223 |     while IFS="=" read key value; do
224 |       case "$key" in (wrapperUrl) jarUrl="$value"; break ;;
225 |       esac
226 |     done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties"
227 |     if [ "$MVNW_VERBOSE" = true ]; then
228 |       echo "Downloading from: $jarUrl"
229 |     fi
230 |     wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar"
231 |     if $cygwin; then
232 |       wrapperJarPath=`cygpath --path --windows "$wrapperJarPath"`
233 |     fi
234 | 
235 |     if command -v wget > /dev/null; then
236 |         if [ "$MVNW_VERBOSE" = true ]; then
237 |           echo "Found wget ... using wget"
238 |         fi
239 |         if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then
240 |             wget "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath"
241 |         else
242 |             wget --http-user=$MVNW_USERNAME --http-password=$MVNW_PASSWORD "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath"
243 |         fi
244 |     elif command -v curl > /dev/null; then
245 |         if [ "$MVNW_VERBOSE" = true ]; then
246 |           echo "Found curl ... using curl"
247 |         fi
248 |         if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then
249 |             curl -o "$wrapperJarPath" "$jarUrl" -f
250 |         else
251 |             curl --user $MVNW_USERNAME:$MVNW_PASSWORD -o "$wrapperJarPath" "$jarUrl" -f
252 |         fi
253 | 
254 |     else
255 |         if [ "$MVNW_VERBOSE" = true ]; then
256 |           echo "Falling back to using Java to download"
257 |         fi
258 |         javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java"
259 |         # For Cygwin, switch paths to Windows format before running javac
260 |         if $cygwin; then
261 |           javaClass=`cygpath --path --windows "$javaClass"`
262 |         fi
263 |         if [ -e "$javaClass" ]; then
264 |             if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then
265 |                 if [ "$MVNW_VERBOSE" = true ]; then
266 |                   echo " - Compiling MavenWrapperDownloader.java ..."
267 |                 fi
268 |                 # Compiling the Java class
269 |                 ("$JAVA_HOME/bin/javac" "$javaClass")
270 |             fi
271 |             if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then
272 |                 # Running the downloader
273 |                 if [ "$MVNW_VERBOSE" = true ]; then
274 |                   echo " - Running MavenWrapperDownloader.java ..."
275 |                 fi
276 |                 ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR")
277 |             fi
278 |         fi
279 |     fi
280 | fi
281 | ##########################################################################################
282 | # End of extension
283 | ##########################################################################################
284 | 
285 | export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}
286 | if [ "$MVNW_VERBOSE" = true ]; then
287 |   echo $MAVEN_PROJECTBASEDIR
288 | fi
289 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS"
290 | 
291 | # For Cygwin, switch paths to Windows format before running java
292 | if $cygwin; then
293 |   [ -n "$M2_HOME" ] &&
294 |     M2_HOME=`cygpath --path --windows "$M2_HOME"`
295 |   [ -n "$JAVA_HOME" ] &&
296 |     JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"`
297 |   [ -n "$CLASSPATH" ] &&
298 |     CLASSPATH=`cygpath --path --windows "$CLASSPATH"`
299 |   [ -n "$MAVEN_PROJECTBASEDIR" ] &&
300 |     MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"`
301 | fi
302 | 
303 | # Provide a "standardized" way to retrieve the CLI args that will
304 | # work with both Windows and non-Windows executions.
305 | MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@"
306 | export MAVEN_CMD_LINE_ARGS
307 | 
308 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
309 | 
310 | exec "$JAVACMD" \
311 |   $MAVEN_OPTS \
312 |   $MAVEN_DEBUG_OPTS \
313 |   -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \
314 |   "-Dmaven.home=${M2_HOME}" \
315 |   "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \
316 |   ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@"
317 | 


--------------------------------------------------------------------------------
/docs/README.adoc:
--------------------------------------------------------------------------------
  1 | = Reactor Netty Workshop
  2 | Violeta Georgieva - VMware
  3 | :sectanchors: true
  4 | :source-highlighter: prettify
  5 | :icons: font
  6 | :toc:
  7 | :reactor-core: 3.8.0
  8 | :reactor-netty: 1.3.0
  9 | 
 10 | This repository hosts a complete workshop on `Reactor Netty`.
 11 | 
 12 | When finishing the workshop one will know how to create and utilize:
 13 | 
 14 | * `UDP` server and client
 15 | * `TCP` server and client
 16 | * `HTTP` server and client
 17 | 
 18 | Reference documentation can be useful while creating those servers and clients:
 19 | 
 20 | * https://projectreactor.io/docs/netty/release/api/[Reactor Netty javadoc]
 21 | * https://projectreactor.io/docs/core/release/api/[Reactor Core javadoc]
 22 | * https://netty.io/wiki/index.html[Netty documentation] (Reactor Netty uses Netty 4.2.x)
 23 | 
 24 | == Prerequisites
 25 | 
 26 | * `Java 8`
 27 | * `Java IDE` installed with `Maven` support
 28 | 
 29 | == How to start
 30 | 
 31 | * Clone/fork this repository https://github.com/violetagg/reactor-netty-workshop
 32 | * Import the project as `Maven` one in your `IDE`
 33 | * Make sure that the language level is set to `Java 8` in your `IDE` project settings
 34 | * Follow this script to create `HTTP`/`TCP`/`UDP` server and client
 35 | * Fix the `TODO` one by one in the tests under `io.spring.workshop.reactornetty`
 36 | package in order to make the unit tests green
 37 | * The solution is available in the `complete` branch for comparison. Each step of this workshop
 38 | has its companion commit in the git history with a detailed commit message.
 39 | 
 40 | == UDP server and client
 41 | If one wants to utilize the `UDP` protocol one will need to create a `UDP` servers that can send packages
 42 | to each other or even `UDP` clients that can connect to specific `UDP` servers.
 43 | `Reactor Netty` provides easy to use and configure `UdpServer` and `UdpClient`, they hide most of the
 44 | `Netty` functionality that is needed in order to create `UDP` server and client, and in addition add
 45 | `Reactive Streams` backpressure.
 46 | 
 47 | === Creating UDP server
 48 | `UdpServer` allows to build, configure and materialize a `UDP` server.
 49 | Invoking `UdpServer.create()` one can prepare the `UDP` server for configuration. Having already a `UdpServer`
 50 | instance, one can start configuring the host, port, the IO handler etc.
 51 | For configuration purposes, an immutable builder pattern is used.
 52 | In the example below the `UDP` server will be bound on port `8080` and will not use a random port.
 53 | 
 54 | [source, java]
 55 | ----
 56 | UdpServer.create()  // Prepares a UDP server for configuration.
 57 |          .port(0)   // Configures the port number as zero, this will let the system
 58 |                     // pick up an ephemeral port when binding the server.
 59 |          .port(8080)// Configures the port number as 8080.
 60 |          .bind()    // Binds the UDP server and returns a Mono<Connection>.
 61 |          .block();  // Blocks and waits the server to finish initialising.
 62 | ----
 63 | 
 64 | When finished with the server configuration, invoking `UdpServer.bind()`, one will bind the server
 65 | and `Mono<Connection>` will be return, subscribing to this `Publisher` one can react
 66 | on a successfully finished operation or handle issues that might happen. On the other hand
 67 | cancelling this `Mono`, the underlying binding will be aborted. If one do not need to interact with the `Mono`,
 68 | there is `UdpServer.bindNow(Duration)` which is a convenient method for binding the server and obtaining the
 69 | `Connection`.
 70 | The `Connection` that is emitted as a result of a successfully bound server, holds contextual information
 71 | for the underlying channel and provides a non-blocking resource disposing API.
 72 | Disposing resource is very important so once the server is not necessary anymore, it must be disposed
 73 | by the user via `Connection.dispose()` or `Connection.disposeNow()`. The difference between these two methods is
 74 | that the second one will release the resources and close the underlying channel in a blocking fashion.
 75 | 
 76 | === Configuring UDP server
 77 | ==== Configuring the Wire Logger
 78 | There are use case when one wants to enable a wire logger in order to understand what's wrong with the server.
 79 | For that purposes `UdpServer.wiretap` can be used and this will use `reactor.netty.udp.UdpServer` category
 80 | with `DEBUG` level. There are also `UdpServer.wiretap(String)` and `UdpServer.wiretap(String, LogLevel)` so that
 81 | one can change the category and the log level.
 82 | 
 83 | ==== Configuring the Event Loop Group
 84 | By default the `UDP` server will use Event Loop Group where the number of the worker threads will be
 85 | the number of processors available to the runtime on init (but with a minimum value of 4). When
 86 | one needs a different configuration, one of the `LoopResource.create` methods can be used in order to configure a new
 87 | Event Loop Group. Once the Event Loop Group is configured, the new configuration can be provided using one of the
 88 | `UdpServer.runOn`.
 89 | 
 90 | === Add UDP server IO handler that will echo the received package
 91 | `UdpServer.handle(BiFunction<UdpInbound, UdpOutbound, Publisher<Void>>)` should be used if one wants to attach IO
 92 | handler that will process the incoming packages and will eventually send packages as reply.
 93 | `UdpInbound` is used to receive bytes from the peer where `UdpInbound.receiveObject()` returns the pure inbound
 94 | `Flux`, while `UdpInbound.receive()` returns `ByteBufFlux` which provides an extra API to handle the incoming traffic.
 95 | `UdpOutbound` is used to send bytes to the peer, listen for any error returned by the write operation
 96 | and close on terminal  signal (complete|error). If more than one `Publisher` is attached
 97 | (multiple calls to `UdpOutbound.send*` methods), completion occurs when all publishers complete.
 98 | The `Publisher<Void>` that has to be returned as a result represents the sequence of the operations that will be
 99 | applied for the incoming and outgoing traffic.
100 | The packages that will be received and that will be send are handled by `io.netty.channel.socket.DatagramPacket`.
101 | For example if one wants to transform an incoming package and then to prepare a new one for sending, the snippet bellow
102 | can be used:
103 | 
104 | [source, java]
105 | ----
106 | if (o instanceof DatagramPacket) {
107 |     // Incoming DatagramPacket
108 |     DatagramPacket p = (DatagramPacket) o;
109 |     ByteBuf buf1 = Unpooled.copiedBuffer("Hello ", CharsetUtil.UTF_8);
110 |     // Creates a new ByteBuf using the incoming DatagramPacket content.
111 |     ByteBuf buf2 = Unpooled.copiedBuffer(buf1, p.content()
112 |                                                 .retain());
113 |     // Creates a new DatagramPacket with the ByteBuf and the sender
114 |     // information from the incoming DatagramPacket.
115 |     return new DatagramPacket(buf2, p.sender());
116 | }
117 | ----
118 | 
119 | === Creating UDP client
120 | `UdpClient` allows to build, configure and materialize a `UDP` client.
121 | Invoking `UdpClient.create()` one can prepare the `UDP` client for configuration. Having already a `UdpClient`
122 | instance, one can start configuring the host, port, the IO handler etc.
123 | For configuration purposes, the same immutable builder pattern is used as in `UdpServer`.
124 | 
125 | When finished with the client configuration, invoking `UdpClient.connect()`, one will connect the client
126 | and `Mono<Connection>` will be return, subscribing to this `Publisher` one can react
127 | on a successfully finished operation or handle issues that might happen. On the other hand
128 | cancelling this `Mono`, the underlying connecting operation will be aborted. If one do not need to interact with the
129 | `Mono`, there is `UdpClient.connectNow(Duration)` which is a convenient method for connecting the client and obtaining
130 | the `Connection`.
131 | As already described in the `UDP` server section, disposing the resources can be done via `Connection.dispose()`
132 | or `Connection.disposeNow()`.
133 | 
134 | === Configuring UDP client
135 | ==== Configuring the Wire Logger
136 | `UdpClient.wiretap` can be used for wire logging and this will use `reactor.netty.udp.UdpClient` category
137 | with `DEBUG` level. There are also `UdpClient.wiretap(String)` and `UdpClient.wiretap(String, LogLevel)` so that
138 | one can change the category and the log level.
139 | 
140 | ==== Configuring the Event Loop Group
141 | The default configuration for the Event Loop Group is the same as in `UDP` server.
142 | When one needs a different configuration, `UdpClient.runOn` methods can be used.
143 | 
144 | === Add UDP client IO handler that will send a package and will react on an incoming packages
145 | `UdpClient.handle(BiFunction<UdpInbound, UdpOutbound, Publisher<Void>>)` should be used if one wants to attach IO
146 | handler that will process the incoming packages and will eventually send packages as reply.
147 | Here as a convenience `UdpOutbound.send*` (e.g. `UdpOutbound.sendString`) methods can be used instead of
148 | `UdpOutbound.sendObject` as the client is connected to exactly one `UDP` server. The same is also for
149 | using `UdpInbound.receive()` instead of `UdpInbound.receiveObject()`.
150 | 
151 | === Utilize Mono<Connection>
152 | In the section for the `UDP` server creation was described that as a result of `UdpServer.bind` one will
153 | receive `Mono<Connection>` which will emit (complete|error) signals.
154 | Utilizing this `Mono` one can send a datagram package (the snippet below) as soon as the `UDP` server is
155 | bound successfully.
156 | 
157 | [source, java]
158 | ----
159 | DatagramChannel udp = DatagramChannel.open();
160 | udp.configureBlocking(true);
161 | udp.connect(new InetSocketAddress(server1.address().getPort()));
162 | 
163 | byte[] data = new byte[1024];
164 | new Random().nextBytes(data);
165 | for (int i = 0; i < 4; i++) {
166 |     udp.write(ByteBuffer.wrap(data));
167 | }
168 | 
169 | udp.close();
170 | ----
171 | 
172 | == TCP server and client
173 | If one wants to utilize the `TCP` protocol one will need to create a `TCP` servers that can send packages
174 | to the connected clients or `TCP` clients that can connect to specific `TCP` servers.
175 | `Reactor Netty` provides easy to use and configure `TcpServer` and `TcpClient`, they hide most of the
176 | `Netty` functionality that is needed in order to create with `TCP` server and client, and in addition add
177 | `Reactive Streams` backpressure.
178 | 
179 | === Creating TCP server
180 | `TcpServer` allows to build, configure and materialize a `TCP` server.
181 | Invoking `TcpServer.create()` one can prepare the `TCP` server for configuration. Having already a `TcpServer`
182 | instance, one can start configuring the host, port, the IO handler etc.
183 | For configuration purposes, the same immutable builder pattern is used as in `UdpServer`.
184 | 
185 | When finished with the server configuration, invoking `TcpServer.bind`, one will bind the server
186 | and `Mono<DisposableServer>` will be return, subscribing to this `Publisher` one can react
187 | on a successfully finished operation or handle issues that might happen. On the other hand
188 | cancelling this `Mono`, the underlying connecting operation will be aborted. If one do not need to interact with the
189 | `Mono`, there is `TcpServer.bindNow(Duration)` which is a convenient method for binding the server and obtaining
190 | the `DisposableServer`.
191 | `DisposableServer` holds contextual information for the underlying server.
192 | Disposing the resources can be done via `DisposableServer.dispose()` or `DisposableServer.disposeNow()`.
193 | 
194 | === Enabling SSL support for TCP server
195 | `TcpServer` provides several convenient methods for configuring SSL:
196 | 
197 | * `TcpServer.secure(SslContext)` where SslContext is already configured
198 | * `TcpServer.secure(Consumer<? super SslProvider.SslContextSpec>)` where the SSL configuration customization
199 | can be done via the passed builder.
200 | 
201 | === Add TCP server IO handler that will send a file
202 | `TcpServer.handle(BiFunction<NettyInbound, NettyOutbound, Publisher<Void>>)` should be used if one wants to attach IO
203 | handler that will process the incoming messages and will eventually send messages as a reply.
204 | `NettyInbound` is used to receive bytes from the peer where `NettyInbound.receiveObject()` returns the pure inbound
205 | `Flux`, while `NettyInbound.receive()` returns `ByteBufFlux` which provides an extra API to handle the incoming traffic.
206 | `NettyOutbound` is used to send bytes to the peer, listen for any error returned by the write operation
207 | and close on terminal  signal (complete|error). If more than one `Publisher` is attached
208 | (multiple calls to `NettyOutbound.send*` methods), completion occurs when all publishers complete.
209 | The `Publisher<Void>` that has to be returned as a result represents the sequence of the operations that will be
210 | applied for the incoming and outgoing traffic.
211 | For example if one wants to send a file to the client where the file name is received as an incoming package,
212 | the snippet bellow can be used:
213 | 
214 | [source, java]
215 | ----
216 | .handle((in, out) ->
217 |         in.receive()
218 |           .asString()
219 |           .flatMap(s -> {
220 |               try {
221 |                   Path file = Paths.get(getClass().getResource(s).toURI());
222 |                   return out.sendFile(file)
223 |                             .then();
224 |               } catch (URISyntaxException e) {
225 |                   return Mono.error(e);
226 |               }
227 |           }))
228 | ----
229 | 
230 | === Creating TCP client
231 | `TcpClient` allows to build, configure and materialize a `TCP` client.
232 | Invoking `TcpClient.create()` one can prepare the `TCP` client for configuration. Having already a `TcpClient`
233 | instance, one can start configuring the host, port, the IO handler etc.
234 | For configuration purposes, the same immutable builder pattern is used as in `UdpServer`.
235 | 
236 | When finished with the client configuration, invoking `TcpClient.connect()`, one will connect the client
237 | and `Mono<Connection>` will be return, subscribing to this `Publisher` one can react
238 | on a successfully finished operation or handle issues that might happen. On the other hand
239 | cancelling this `Mono`, the underlying connecting operation will be aborted. If one do not need to interact with the
240 | `Mono`, there is `TcpClient.connectNow(Duration)` which is a convenient method for connecting the client and obtaining
241 | the `Connection`.
242 | As already described in the `UDP` server section, disposing the resources can be done via `Connection.dispose()`
243 | or `Connection.disposeNow()`.
244 | 
245 | === Enabling SSL support for TCP client
246 | `TcpClient` provides several convenient methods for configuring SSL.
247 | When one wants to use the default SSL configuration provided by Reactor Netty `TcpClient.secure()` can be used.
248 | If additional configuration is necessary then one of the following methods can be used:
249 | 
250 | * `TcpClient.secure(SslContext)` where SslContext is already configured
251 | * `TcpClient.secure(Consumer<? super SslProvider.SslContextSpec>)` where the SSL configuration customization
252 | can be done via the passed builder.
253 | 
254 | === Add TCP client IO handler
255 | `TcpClient.handle(BiFunction<NettyInbound, NettyOutbound, Publisher<Void>>)` should be used if one wants to attach IO
256 | handler that will process the incoming messages and will eventually send messages as reply.
257 | Here as a convenience `NettyOutbound.send*` (e.g. `NettyOutbound.sendString`) methods can be used instead of
258 | `NettyOutbound.sendObject`. The same is also for using `NettyInbound.receive()` instead of
259 | `NettyInbound.receiveObject()`.
260 | 
261 | == HTTP server and client
262 | === Creating HTTP server
263 | `HttpServer` allows to build, configure and materialize a `HTTP` server.
264 | Invoking `HttpServer.create()` one can prepare the `HTTP` server for configuration. Having already a `HttpServer`
265 | instance, one can start configuring the host, port, the IO handler, compression etc.
266 | For configuration purposes, the same immutable builder pattern is used as in `UdpServer`.
267 | 
268 | When finished with the server configuration, invoking `HttpServer.bind`, one will bind the server
269 | and `Mono<DisposableServer>` will be return, subscribing to this `Publisher` one can react
270 | on a successfully finished operation or handle issues that might happen. On the other hand
271 | cancelling this `Mono`, the underlying connecting operation will be aborted. If one do not need to interact with the
272 | `Mono`, there is `HttpServer.bindNow(Duration)` which is a convenient method for binding the server and obtaining
273 | the `DisposableServer`.
274 | Disposing the resources can be done via `DisposableServer.dispose()` or `DisposableServer.disposeNow()`.
275 | 
276 | === Defining routes for the HTTP server
277 | In `HttpServer` one can handle the incoming requests and outgoing responses using
278 | `HttpServer.handle(BiFunction<HttpServerRequest, HttpServerResponse, Publisher<Void>>)` which is similar to the
279 | mechanism that was already described for `UdpServer`/`TcpServer`. However there is also a possibility to specify
280 | concrete routes and HTTP methods that the server will respond. This can be done using
281 | `HttpServer.route(Consumer<HttpServerRoutes>)`. Using `HttpServerRoutes` one can specify the HTTP method, paths etc.
282 | For example the snippet below specifies that the server will respond only on `POST` method, where the path starts with
283 | `/test` and has a path parameter.
284 | 
285 | [source, java]
286 | ----
287 | .route(routes ->
288 |         routes.post("/test/{param}", (req, res) ->
289 |                 res.sendString(req.receive()
290 |                                   .asString()
291 |                                   .map(s -> s + ' ' + req.param("param") + '!'))))
292 | ----
293 | 
294 | `HttpServerRequest` provides API for accessing http request attributes as method, path, headers, path parameters etc.
295 | as well as to receive the request body.
296 | `HttpServerResponse` provides API for accessing http response attributes as status code, headers, compression etc.
297 | as well as to send the response body.
298 | 
299 | === Creating HTTP client
300 | `HttpClient` allows to build, configure and materialize a `HTTP` client.
301 | Invoking `HttpClient.create()` one can prepare the `HTTP` client for configuration. Having already a `HttpClient`
302 | instance, one can start configuring the host, port, headers, compression etc.
303 | For configuration purposes, the same immutable builder pattern is used as in `UdpServer`.
304 | 
305 | When finished with the client configuration, invoking `HttpClient.get|post|...` methods, one will receive
306 | `HttpClient.RequestSender` and will be able start configuring the `HTTP` request such as the uri and the request body.
307 | `HttpClient.RequestSender.send*` will end the HTTP request's configuration and one can start discribing the actions
308 | on the `HTTP` response when it is received on the returned `HttpClient.ResponseReceiver`, the response body can be obtained via the provided
309 | `HttpClient.ResponseReceiver.response*` methods. As `HttpClient.ResponseReceiver` API always returns `Publisher`,
310 | the request and response executions are always deferred to the moment when there is a `Subscriber`
311 | that subscribes to the defined sequence. For example in the snippet below `block()` will subscribe to the defined
312 | sequence and in fact will trigger the execution.
313 | 
314 | In the snippet below can be used to send POST request with a body and received the answer from the server:
315 | 
316 | [source, java]
317 | ----
318 | HttpClient.create()             // Prepares a HTTP client for configuration.
319 |           .port(server.port())  // Obtain the server's port and provide it as a port to which this
320 |                                 // client should connect.
321 |           .wiretap(true)        // Applies a wire logger configuration.
322 |           .headers(h -> h.add("Content-Type", "text/plain")) // Adds headers to the HTTP request.
323 |           .post()              // Specifies that POST method will be used.
324 |           .uri("/test/World")  // Specifies the path.
325 |           .send(ByteBufFlux.fromString(Flux.just("Hello")))  // Sends the request body.
326 |           .responseContent()   // Receives the response body.
327 |           .aggregate()
328 |           .asString()
329 |           .block();
330 | ----
331 | 


--------------------------------------------------------------------------------
/docs/index.html:
--------------------------------------------------------------------------------
  1 | <!DOCTYPE html>
  2 | <html lang="en">
  3 | <head>
  4 | <meta charset="UTF-8">
  5 | <meta http-equiv="X-UA-Compatible" content="IE=edge">
  6 | <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7 | <meta name="generator" content="Asciidoctor 2.0.17">
  8 | <meta name="author" content="Violeta Georgieva - VMware">
  9 | <title>Reactor Netty Workshop</title>
 10 | <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
 11 | <style>
 12 | /*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
 13 | /* Uncomment the following line when using as a custom stylesheet */
 14 | /* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
 15 | html{font-family:sans-serif;-webkit-text-size-adjust:100%}
 16 | a{background:none}
 17 | a:focus{outline:thin dotted}
 18 | a:active,a:hover{outline:0}
 19 | h1{font-size:2em;margin:.67em 0}
 20 | b,strong{font-weight:bold}
 21 | abbr{font-size:.9em}
 22 | abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
 23 | dfn{font-style:italic}
 24 | hr{height:0}
 25 | mark{background:#ff0;color:#000}
 26 | code,kbd,pre,samp{font-family:monospace;font-size:1em}
 27 | pre{white-space:pre-wrap}
 28 | q{quotes:"\201C" "\201D" "\2018" "\2019"}
 29 | small{font-size:80%}
 30 | sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
 31 | sup{top:-.5em}
 32 | sub{bottom:-.25em}
 33 | img{border:0}
 34 | svg:not(:root){overflow:hidden}
 35 | figure{margin:0}
 36 | audio,video{display:inline-block}
 37 | audio:not([controls]){display:none;height:0}
 38 | fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
 39 | legend{border:0;padding:0}
 40 | button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
 41 | button,input{line-height:normal}
 42 | button,select{text-transform:none}
 43 | button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
 44 | button[disabled],html input[disabled]{cursor:default}
 45 | input[type=checkbox],input[type=radio]{padding:0}
 46 | button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
 47 | textarea{overflow:auto;vertical-align:top}
 48 | table{border-collapse:collapse;border-spacing:0}
 49 | *,::before,::after{box-sizing:border-box}
 50 | html,body{font-size:100%}
 51 | body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
 52 | a:hover{cursor:pointer}
 53 | img,object,embed{max-width:100%;height:auto}
 54 | object,embed{height:100%}
 55 | img{-ms-interpolation-mode:bicubic}
 56 | .left{float:left!important}
 57 | .right{float:right!important}
 58 | .text-left{text-align:left!important}
 59 | .text-right{text-align:right!important}
 60 | .text-center{text-align:center!important}
 61 | .text-justify{text-align:justify!important}
 62 | .hide{display:none}
 63 | img,object,svg{display:inline-block;vertical-align:middle}
 64 | textarea{height:auto;min-height:50px}
 65 | select{width:100%}
 66 | .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
 67 | div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
 68 | a{color:#2156a5;text-decoration:underline;line-height:inherit}
 69 | a:hover,a:focus{color:#1d4b8f}
 70 | a img{border:0}
 71 | p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
 72 | p aside{font-size:.875em;line-height:1.35;font-style:italic}
 73 | h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
 74 | h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
 75 | h1{font-size:2.125em}
 76 | h2{font-size:1.6875em}
 77 | h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
 78 | h4,h5{font-size:1.125em}
 79 | h6{font-size:1em}
 80 | hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
 81 | em,i{font-style:italic;line-height:inherit}
 82 | strong,b{font-weight:bold;line-height:inherit}
 83 | small{font-size:60%;line-height:inherit}
 84 | code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
 85 | ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
 86 | ul,ol{margin-left:1.5em}
 87 | ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
 88 | ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
 89 | ul.square{list-style-type:square}
 90 | ul.circle{list-style-type:circle}
 91 | ul.disc{list-style-type:disc}
 92 | ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
 93 | dl dt{margin-bottom:.3125em;font-weight:bold}
 94 | dl dd{margin-bottom:1.25em}
 95 | blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
 96 | blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
 97 | @media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
 98 | h1{font-size:2.75em}
 99 | h2{font-size:2.3125em}
100 | h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
101 | h4{font-size:1.4375em}}
102 | table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
103 | table thead,table tfoot{background:#f7f8f7}
104 | table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
105 | table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
106 | table tr.even,table tr.alt{background:#f8f8f7}
107 | table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
108 | h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
109 | h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
110 | .center{margin-left:auto;margin-right:auto}
111 | .stretch{width:100%}
112 | .clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
113 | .clearfix::after,.float-group::after{clear:both}
114 | :not(pre).nobreak{word-wrap:normal}
115 | :not(pre).nowrap{white-space:nowrap}
116 | :not(pre).pre-wrap{white-space:pre-wrap}
117 | :not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
118 | pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
119 | pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
120 | pre>code{display:block}
121 | pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
122 | em em{font-style:normal}
123 | strong strong{font-weight:400}
124 | .keyseq{color:rgba(51,51,51,.8)}
125 | kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
126 | .keyseq kbd:first-child{margin-left:0}
127 | .keyseq kbd:last-child{margin-right:0}
128 | .menuseq,.menuref{color:#000}
129 | .menuseq b:not(.caret),.menuref{font-weight:inherit}
130 | .menuseq{word-spacing:-.02em}
131 | .menuseq b.caret{font-size:1.25em;line-height:.8}
132 | .menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
133 | b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
134 | b.button::before{content:"[";padding:0 3px 0 2px}
135 | b.button::after{content:"]";padding:0 2px 0 3px}
136 | p a>code:hover{color:rgba(0,0,0,.9)}
137 | #header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
138 | #header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
139 | #header::after,#content::after,#footnotes::after,#footer::after{clear:both}
140 | #content{margin-top:1.25em}
141 | #content::before{content:none}
142 | #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
143 | #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
144 | #header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
145 | #header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
146 | #header .details span:first-child{margin-left:-.125em}
147 | #header .details span.email a{color:rgba(0,0,0,.85)}
148 | #header .details br{display:none}
149 | #header .details br+span::before{content:"\00a0\2013\00a0"}
150 | #header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
151 | #header .details br+span#revremark::before{content:"\00a0|\00a0"}
152 | #header #revnumber{text-transform:capitalize}
153 | #header #revnumber::after{content:"\00a0"}
154 | #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
155 | #toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
156 | #toc>ul{margin-left:.125em}
157 | #toc ul.sectlevel0>li>a{font-style:italic}
158 | #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
159 | #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
160 | #toc li{line-height:1.3334;margin-top:.3334em}
161 | #toc a{text-decoration:none}
162 | #toc a:active{text-decoration:underline}
163 | #toctitle{color:#7a2518;font-size:1.2em}
164 | @media screen and (min-width:768px){#toctitle{font-size:1.375em}
165 | body.toc2{padding-left:15em;padding-right:0}
166 | #toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
167 | #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
168 | #toc.toc2>ul{font-size:.9em;margin-bottom:0}
169 | #toc.toc2 ul ul{margin-left:0;padding-left:1em}
170 | #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
171 | body.toc2.toc-right{padding-left:0;padding-right:15em}
172 | body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
173 | @media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
174 | #toc.toc2{width:20em}
175 | #toc.toc2 #toctitle{font-size:1.375em}
176 | #toc.toc2>ul{font-size:.95em}
177 | #toc.toc2 ul ul{padding-left:1.25em}
178 | body.toc2.toc-right{padding-left:0;padding-right:20em}}
179 | #content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
180 | #content #toc>:first-child{margin-top:0}
181 | #content #toc>:last-child{margin-bottom:0}
182 | #footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
183 | #footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
184 | #content{margin-bottom:.625em}
185 | .sect1{padding-bottom:.625em}
186 | @media screen and (min-width:768px){#content{margin-bottom:1.25em}
187 | .sect1{padding-bottom:1.25em}}
188 | .sect1:last-child{padding-bottom:0}
189 | .sect1+.sect1{border-top:1px solid #e7e7e9}
190 | #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
191 | #content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
192 | #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
193 | #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
194 | #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
195 | details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
196 | details{margin-left:1.25rem}
197 | details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
198 | details>summary::-webkit-details-marker{display:none}
199 | details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
200 | details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
201 | details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
202 | .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
203 | table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
204 | .paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
205 | .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
206 | .admonitionblock>table td.icon{text-align:center;width:80px}
207 | .admonitionblock>table td.icon img{max-width:none}
208 | .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
209 | .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
210 | .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
211 | .exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
212 | .exampleblock>.content>:first-child{margin-top:0}
213 | .exampleblock>.content>:last-child{margin-bottom:0}
214 | .sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
215 | .sidebarblock>:first-child{margin-top:0}
216 | .sidebarblock>:last-child{margin-bottom:0}
217 | .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
218 | .exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
219 | .literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
220 | @media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
221 | @media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
222 | .literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
223 | .literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
224 | .listingblock>.content{position:relative}
225 | .listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
226 | .listingblock:hover code[data-lang]::before{display:block}
227 | .listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
228 | .listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
229 | .listingblock pre.highlightjs{padding:0}
230 | .listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
231 | .listingblock pre.prettyprint{border-width:0}
232 | .prettyprint{background:#f7f7f8}
233 | pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
234 | pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
235 | pre.prettyprint li code[data-lang]::before{opacity:1}
236 | pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
237 | table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
238 | table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
239 | table.linenotable td.code{padding-left:.75em}
240 | table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
241 | pre.pygments span.linenos{display:inline-block;margin-right:.75em}
242 | .quoteblock{margin:0 1em 1.25em 1.5em;display:table}
243 | .quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
244 | .quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
245 | .quoteblock blockquote{margin:0;padding:0;border:0}
246 | .quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
247 | .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
248 | .quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
249 | .verseblock{margin:0 1em 1.25em}
250 | .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
251 | .verseblock pre strong{font-weight:400}
252 | .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
253 | .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
254 | .quoteblock .attribution br,.verseblock .attribution br{display:none}
255 | .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
256 | .quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
257 | .quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
258 | .quoteblock.abstract{margin:0 1em 1.25em;display:block}
259 | .quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
260 | .quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
261 | .quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
262 | .quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
263 | .quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
264 | p.tableblock:last-child{margin-bottom:0}
265 | td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
266 | td.tableblock>.content>:last-child{margin-bottom:-1.25em}
267 | table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
268 | table.grid-all>*>tr>*{border-width:1px}
269 | table.grid-cols>*>tr>*{border-width:0 1px}
270 | table.grid-rows>*>tr>*{border-width:1px 0}
271 | table.frame-all{border-width:1px}
272 | table.frame-ends{border-width:1px 0}
273 | table.frame-sides{border-width:0 1px}
274 | table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
275 | table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
276 | table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
277 | table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
278 | table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
279 | th.halign-left,td.halign-left{text-align:left}
280 | th.halign-right,td.halign-right{text-align:right}
281 | th.halign-center,td.halign-center{text-align:center}
282 | th.valign-top,td.valign-top{vertical-align:top}
283 | th.valign-bottom,td.valign-bottom{vertical-align:bottom}
284 | th.valign-middle,td.valign-middle{vertical-align:middle}
285 | table thead th,table tfoot th{font-weight:bold}
286 | tbody tr th{background:#f7f8f7}
287 | tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
288 | p.tableblock>code:only-child{background:none;padding:0}
289 | p.tableblock{font-size:1em}
290 | ol{margin-left:1.75em}
291 | ul li ol{margin-left:1.5em}
292 | dl dd{margin-left:1.125em}
293 | dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
294 | li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
295 | ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
296 | ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
297 | ul.unstyled,ol.unstyled{margin-left:0}
298 | li>p:empty:only-child::before{content:"";display:inline-block}
299 | ul.checklist>li>p:first-child{margin-left:-1em}
300 | ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
301 | ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
302 | ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
303 | ul.inline>li{margin-left:1.25em}
304 | .unstyled dl dt{font-weight:400;font-style:normal}
305 | ol.arabic{list-style-type:decimal}
306 | ol.decimal{list-style-type:decimal-leading-zero}
307 | ol.loweralpha{list-style-type:lower-alpha}
308 | ol.upperalpha{list-style-type:upper-alpha}
309 | ol.lowerroman{list-style-type:lower-roman}
310 | ol.upperroman{list-style-type:upper-roman}
311 | ol.lowergreek{list-style-type:lower-greek}
312 | .hdlist>table,.colist>table{border:0;background:none}
313 | .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
314 | td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
315 | td.hdlist1{font-weight:bold;padding-bottom:1.25em}
316 | td.hdlist2{word-wrap:anywhere}
317 | .literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
318 | .colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
319 | .colist td:not([class]):first-child img{max-width:none}
320 | .colist td:not([class]):last-child{padding:.25em 0}
321 | .thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
322 | .imageblock.left{margin:.25em .625em 1.25em 0}
323 | .imageblock.right{margin:.25em 0 1.25em .625em}
324 | .imageblock>.title{margin-bottom:0}
325 | .imageblock.thumb,.imageblock.th{border-width:6px}
326 | .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
327 | .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
328 | .image.left{margin-right:.625em}
329 | .image.right{margin-left:.625em}
330 | a.image{text-decoration:none;display:inline-block}
331 | a.image object{pointer-events:none}
332 | sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
333 | sup.footnote a,sup.footnoteref a{text-decoration:none}
334 | sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
335 | #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
336 | #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
337 | #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
338 | #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
339 | #footnotes .footnote:last-of-type{margin-bottom:0}
340 | #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
341 | div.unbreakable{page-break-inside:avoid}
342 | .big{font-size:larger}
343 | .small{font-size:smaller}
344 | .underline{text-decoration:underline}
345 | .overline{text-decoration:overline}
346 | .line-through{text-decoration:line-through}
347 | .aqua{color:#00bfbf}
348 | .aqua-background{background:#00fafa}
349 | .black{color:#000}
350 | .black-background{background:#000}
351 | .blue{color:#0000bf}
352 | .blue-background{background:#0000fa}
353 | .fuchsia{color:#bf00bf}
354 | .fuchsia-background{background:#fa00fa}
355 | .gray{color:#606060}
356 | .gray-background{background:#7d7d7d}
357 | .green{color:#006000}
358 | .green-background{background:#007d00}
359 | .lime{color:#00bf00}
360 | .lime-background{background:#00fa00}
361 | .maroon{color:#600000}
362 | .maroon-background{background:#7d0000}
363 | .navy{color:#000060}
364 | .navy-background{background:#00007d}
365 | .olive{color:#606000}
366 | .olive-background{background:#7d7d00}
367 | .purple{color:#600060}
368 | .purple-background{background:#7d007d}
369 | .red{color:#bf0000}
370 | .red-background{background:#fa0000}
371 | .silver{color:#909090}
372 | .silver-background{background:#bcbcbc}
373 | .teal{color:#006060}
374 | .teal-background{background:#007d7d}
375 | .white{color:#bfbfbf}
376 | .white-background{background:#fafafa}
377 | .yellow{color:#bfbf00}
378 | .yellow-background{background:#fafa00}
379 | span.icon>.fa{cursor:default}
380 | a span.icon>.fa{cursor:inherit}
381 | .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
382 | .admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
383 | .admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
384 | .admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
385 | .admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
386 | .admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
387 | .conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
388 | .conum[data-value] *{color:#fff!important}
389 | .conum[data-value]+b{display:none}
390 | .conum[data-value]::after{content:attr(data-value)}
391 | pre .conum[data-value]{position:relative;top:-.125em}
392 | b.conum *{color:inherit!important}
393 | .conum:not([data-value]):empty{display:none}
394 | dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
395 | h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
396 | p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
397 | p,blockquote,dt,td.content,span.alt,summary{font-size:1.0625rem}
398 | p{margin-bottom:1.25rem}
399 | .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
400 | .exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
401 | .print-only{display:none!important}
402 | @page{margin:1.25cm .75cm}
403 | @media print{*{box-shadow:none!important;text-shadow:none!important}
404 | html{font-size:80%}
405 | a{color:inherit!important;text-decoration:underline!important}
406 | a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
407 | a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
408 | abbr[title]{border-bottom:1px dotted}
409 | abbr[title]::after{content:" (" attr(title) ")"}
410 | pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
411 | thead{display:table-header-group}
412 | svg{max-width:100%}
413 | p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
414 | h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
415 | #header,#content,#footnotes,#footer{max-width:none}
416 | #toc,.sidebarblock,.exampleblock>.content{background:none!important}
417 | #toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
418 | body.book #header{text-align:center}
419 | body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
420 | body.book #header .details{border:0!important;display:block;padding:0!important}
421 | body.book #header .details span:first-child{margin-left:0!important}
422 | body.book #header .details br{display:block}
423 | body.book #header .details br+span::before{content:none!important}
424 | body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
425 | body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
426 | .listingblock code[data-lang]::before{display:block}
427 | #footer{padding:0 .9375em}
428 | .hide-on-print{display:none!important}
429 | .print-only{display:block!important}
430 | .hide-for-print{display:none!important}
431 | .show-for-print{display:inherit!important}}
432 | @media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
433 | .sect1{padding:0!important}
434 | .sect1+.sect1{border:0}
435 | #footer{background:none}
436 | #footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
437 | @media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
438 | </style>
439 | <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
440 | <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/prettify/r298/prettify.min.css">
441 | </head>
442 | <body class="article">
443 | <div id="header">
444 | <h1>Reactor Netty Workshop</h1>
445 | <div class="details">
446 | <span id="author" class="author">Violeta Georgieva - VMware</span><br>
447 | </div>
448 | <div id="toc" class="toc">
449 | <div id="toctitle">Table of Contents</div>
450 | <ul class="sectlevel1">
451 | <li><a href="#_prerequisites">Prerequisites</a></li>
452 | <li><a href="#_how_to_start">How to start</a></li>
453 | <li><a href="#_udp_server_and_client">UDP server and client</a>
454 | <ul class="sectlevel2">
455 | <li><a href="#_creating_udp_server">Creating UDP server</a></li>
456 | <li><a href="#_configuring_udp_server">Configuring UDP server</a></li>
457 | <li><a href="#_add_udp_server_io_handler_that_will_echo_the_received_package">Add UDP server IO handler that will echo the received package</a></li>
458 | <li><a href="#_creating_udp_client">Creating UDP client</a></li>
459 | <li><a href="#_configuring_udp_client">Configuring UDP client</a></li>
460 | <li><a href="#_add_udp_client_io_handler_that_will_send_a_package_and_will_react_on_an_incoming_packages">Add UDP client IO handler that will send a package and will react on an incoming packages</a></li>
461 | <li><a href="#_utilize_monoconnection">Utilize Mono&lt;Connection&gt;</a></li>
462 | </ul>
463 | </li>
464 | <li><a href="#_tcp_server_and_client">TCP server and client</a>
465 | <ul class="sectlevel2">
466 | <li><a href="#_creating_tcp_server">Creating TCP server</a></li>
467 | <li><a href="#_enabling_ssl_support_for_tcp_server">Enabling SSL support for TCP server</a></li>
468 | <li><a href="#_add_tcp_server_io_handler_that_will_send_a_file">Add TCP server IO handler that will send a file</a></li>
469 | <li><a href="#_creating_tcp_client">Creating TCP client</a></li>
470 | <li><a href="#_enabling_ssl_support_for_tcp_client">Enabling SSL support for TCP client</a></li>
471 | <li><a href="#_add_tcp_client_io_handler">Add TCP client IO handler</a></li>
472 | </ul>
473 | </li>
474 | <li><a href="#_http_server_and_client">HTTP server and client</a>
475 | <ul class="sectlevel2">
476 | <li><a href="#_creating_http_server">Creating HTTP server</a></li>
477 | <li><a href="#_defining_routes_for_the_http_server">Defining routes for the HTTP server</a></li>
478 | <li><a href="#_creating_http_client">Creating HTTP client</a></li>
479 | </ul>
480 | </li>
481 | </ul>
482 | </div>
483 | </div>
484 | <div id="content">
485 | <div id="preamble">
486 | <div class="sectionbody">
487 | <div class="paragraph">
488 | <p>This repository hosts a complete workshop on <code>Reactor Netty</code>.</p>
489 | </div>
490 | <div class="paragraph">
491 | <p>When finishing the workshop one will know how to create and utilize:</p>
492 | </div>
493 | <div class="ulist">
494 | <ul>
495 | <li>
496 | <p><code>UDP</code> server and client</p>
497 | </li>
498 | <li>
499 | <p><code>TCP</code> server and client</p>
500 | </li>
501 | <li>
502 | <p><code>HTTP</code> server and client</p>
503 | </li>
504 | </ul>
505 | </div>
506 | <div class="paragraph">
507 | <p>Reference documentation can be useful while creating those servers and clients:</p>
508 | </div>
509 | <div class="ulist">
510 | <ul>
511 | <li>
512 | <p><a href="https://projectreactor.io/docs/netty/release/api/">Reactor Netty javadoc</a></p>
513 | </li>
514 | <li>
515 | <p><a href="https://projectreactor.io/docs/core/release/api/">Reactor Core javadoc</a></p>
516 | </li>
517 | <li>
518 | <p><a href="https://netty.io/wiki/index.html">Netty documentation</a> (Reactor Netty uses Netty 4.2.x)</p>
519 | </li>
520 | </ul>
521 | </div>
522 | </div>
523 | </div>
524 | <div class="sect1">
525 | <h2 id="_prerequisites"><a class="anchor" href="#_prerequisites"></a>Prerequisites</h2>
526 | <div class="sectionbody">
527 | <div class="ulist">
528 | <ul>
529 | <li>
530 | <p><code>Java 8</code></p>
531 | </li>
532 | <li>
533 | <p><code>Java IDE</code> installed with <code>Maven</code> support</p>
534 | </li>
535 | </ul>
536 | </div>
537 | </div>
538 | </div>
539 | <div class="sect1">
540 | <h2 id="_how_to_start"><a class="anchor" href="#_how_to_start"></a>How to start</h2>
541 | <div class="sectionbody">
542 | <div class="ulist">
543 | <ul>
544 | <li>
545 | <p>Clone/fork this repository <a href="https://github.com/violetagg/reactor-netty-workshop" class="bare">https://github.com/violetagg/reactor-netty-workshop</a></p>
546 | </li>
547 | <li>
548 | <p>Import the project as <code>Maven</code> one in your <code>IDE</code></p>
549 | </li>
550 | <li>
551 | <p>Make sure that the language level is set to <code>Java 8</code> in your <code>IDE</code> project settings</p>
552 | </li>
553 | <li>
554 | <p>Follow this script to create <code>HTTP</code>/<code>TCP</code>/<code>UDP</code> server and client</p>
555 | </li>
556 | <li>
557 | <p>Fix the <code>TODO</code> one by one in the tests under <code>io.spring.workshop.reactornetty</code>
558 | package in order to make the unit tests green</p>
559 | </li>
560 | <li>
561 | <p>The solution is available in the <code>complete</code> branch for comparison. Each step of this workshop
562 | has its companion commit in the git history with a detailed commit message.</p>
563 | </li>
564 | </ul>
565 | </div>
566 | </div>
567 | </div>
568 | <div class="sect1">
569 | <h2 id="_udp_server_and_client"><a class="anchor" href="#_udp_server_and_client"></a>UDP server and client</h2>
570 | <div class="sectionbody">
571 | <div class="paragraph">
572 | <p>If one wants to utilize the <code>UDP</code> protocol one will need to create a <code>UDP</code> servers that can send packages
573 | to each other or even <code>UDP</code> clients that can connect to specific <code>UDP</code> servers.
574 | <code>Reactor Netty</code> provides easy to use and configure <code>UdpServer</code> and <code>UdpClient</code>, they hide most of the
575 | <code>Netty</code> functionality that is needed in order to create <code>UDP</code> server and client, and in addition add
576 | <code>Reactive Streams</code> backpressure.</p>
577 | </div>
578 | <div class="sect2">
579 | <h3 id="_creating_udp_server"><a class="anchor" href="#_creating_udp_server"></a>Creating UDP server</h3>
580 | <div class="paragraph">
581 | <p><code>UdpServer</code> allows to build, configure and materialize a <code>UDP</code> server.
582 | Invoking <code>UdpServer.create()</code> one can prepare the <code>UDP</code> server for configuration. Having already a <code>UdpServer</code>
583 | instance, one can start configuring the host, port, the IO handler etc.
584 | For configuration purposes, an immutable builder pattern is used.
585 | In the example below the <code>UDP</code> server will be bound on port <code>8080</code> and will not use a random port.</p>
586 | </div>
587 | <div class="listingblock">
588 | <div class="content">
589 | <pre class="prettyprint highlight"><code data-lang="java">UdpServer.create()  // Prepares a UDP server for configuration.
590 |          .port(0)   // Configures the port number as zero, this will let the system
591 |                     // pick up an ephemeral port when binding the server.
592 |          .port(8080)// Configures the port number as 8080.
593 |          .bind()    // Binds the UDP server and returns a Mono&lt;Connection&gt;.
594 |          .block();  // Blocks and waits the server to finish initialising.</code></pre>
595 | </div>
596 | </div>
597 | <div class="paragraph">
598 | <p>When finished with the server configuration, invoking <code>UdpServer.bind()</code>, one will bind the server
599 | and <code>Mono&lt;Connection&gt;</code> will be return, subscribing to this <code>Publisher</code> one can react
600 | on a successfully finished operation or handle issues that might happen. On the other hand
601 | cancelling this <code>Mono</code>, the underlying binding will be aborted. If one do not need to interact with the <code>Mono</code>,
602 | there is <code>UdpServer.bindNow(Duration)</code> which is a convenient method for binding the server and obtaining the
603 | <code>Connection</code>.
604 | The <code>Connection</code> that is emitted as a result of a successfully bound server, holds contextual information
605 | for the underlying channel and provides a non-blocking resource disposing API.
606 | Disposing resource is very important so once the server is not necessary anymore, it must be disposed
607 | by the user via <code>Connection.dispose()</code> or <code>Connection.disposeNow()</code>. The difference between these two methods is
608 | that the second one will release the resources and close the underlying channel in a blocking fashion.</p>
609 | </div>
610 | </div>
611 | <div class="sect2">
612 | <h3 id="_configuring_udp_server"><a class="anchor" href="#_configuring_udp_server"></a>Configuring UDP server</h3>
613 | <div class="sect3">
614 | <h4 id="_configuring_the_wire_logger"><a class="anchor" href="#_configuring_the_wire_logger"></a>Configuring the Wire Logger</h4>
615 | <div class="paragraph">
616 | <p>There are use case when one wants to enable a wire logger in order to understand what&#8217;s wrong with the server.
617 | For that purposes <code>UdpServer.wiretap</code> can be used and this will use <code>reactor.netty.udp.UdpServer</code> category
618 | with <code>DEBUG</code> level. There are also <code>UdpServer.wiretap(String)</code> and <code>UdpServer.wiretap(String, LogLevel)</code> so that
619 | one can change the category and the log level.</p>
620 | </div>
621 | </div>
622 | <div class="sect3">
623 | <h4 id="_configuring_the_event_loop_group"><a class="anchor" href="#_configuring_the_event_loop_group"></a>Configuring the Event Loop Group</h4>
624 | <div class="paragraph">
625 | <p>By default the <code>UDP</code> server will use Event Loop Group where the number of the worker threads will be
626 | the number of processors available to the runtime on init (but with a minimum value of 4). When
627 | one needs a different configuration, one of the <code>LoopResource.create</code> methods can be used in order to configure a new
628 | Event Loop Group. Once the Event Loop Group is configured, the new configuration can be provided using one of the
629 | <code>UdpServer.runOn</code>.</p>
630 | </div>
631 | </div>
632 | </div>
633 | <div class="sect2">
634 | <h3 id="_add_udp_server_io_handler_that_will_echo_the_received_package"><a class="anchor" href="#_add_udp_server_io_handler_that_will_echo_the_received_package"></a>Add UDP server IO handler that will echo the received package</h3>
635 | <div class="paragraph">
636 | <p><code>UdpServer.handle(BiFunction&lt;UdpInbound, UdpOutbound, Publisher&lt;Void&gt;&gt;)</code> should be used if one wants to attach IO
637 | handler that will process the incoming packages and will eventually send packages as reply.
638 | <code>UdpInbound</code> is used to receive bytes from the peer where <code>UdpInbound.receiveObject()</code> returns the pure inbound
639 | <code>Flux</code>, while <code>UdpInbound.receive()</code> returns <code>ByteBufFlux</code> which provides an extra API to handle the incoming traffic.
640 | <code>UdpOutbound</code> is used to send bytes to the peer, listen for any error returned by the write operation
641 | and close on terminal  signal (complete|error). If more than one <code>Publisher</code> is attached
642 | (multiple calls to <code>UdpOutbound.send*</code> methods), completion occurs when all publishers complete.
643 | The <code>Publisher&lt;Void&gt;</code> that has to be returned as a result represents the sequence of the operations that will be
644 | applied for the incoming and outgoing traffic.
645 | The packages that will be received and that will be send are handled by <code>io.netty.channel.socket.DatagramPacket</code>.
646 | For example if one wants to transform an incoming package and then to prepare a new one for sending, the snippet bellow
647 | can be used:</p>
648 | </div>
649 | <div class="listingblock">
650 | <div class="content">
651 | <pre class="prettyprint highlight"><code data-lang="java">if (o instanceof DatagramPacket) {
652 |     // Incoming DatagramPacket
653 |     DatagramPacket p = (DatagramPacket) o;
654 |     ByteBuf buf1 = Unpooled.copiedBuffer("Hello ", CharsetUtil.UTF_8);
655 |     // Creates a new ByteBuf using the incoming DatagramPacket content.
656 |     ByteBuf buf2 = Unpooled.copiedBuffer(buf1, p.content()
657 |                                                 .retain());
658 |     // Creates a new DatagramPacket with the ByteBuf and the sender
659 |     // information from the incoming DatagramPacket.
660 |     return new DatagramPacket(buf2, p.sender());
661 | }</code></pre>
662 | </div>
663 | </div>
664 | </div>
665 | <div class="sect2">
666 | <h3 id="_creating_udp_client"><a class="anchor" href="#_creating_udp_client"></a>Creating UDP client</h3>
667 | <div class="paragraph">
668 | <p><code>UdpClient</code> allows to build, configure and materialize a <code>UDP</code> client.
669 | Invoking <code>UdpClient.create()</code> one can prepare the <code>UDP</code> client for configuration. Having already a <code>UdpClient</code>
670 | instance, one can start configuring the host, port, the IO handler etc.
671 | For configuration purposes, the same immutable builder pattern is used as in <code>UdpServer</code>.</p>
672 | </div>
673 | <div class="paragraph">
674 | <p>When finished with the client configuration, invoking <code>UdpClient.connect()</code>, one will connect the client
675 | and <code>Mono&lt;Connection&gt;</code> will be return, subscribing to this <code>Publisher</code> one can react
676 | on a successfully finished operation or handle issues that might happen. On the other hand
677 | cancelling this <code>Mono</code>, the underlying connecting operation will be aborted. If one do not need to interact with the
678 | <code>Mono</code>, there is <code>UdpClient.connectNow(Duration)</code> which is a convenient method for connecting the client and obtaining
679 | the <code>Connection</code>.
680 | As already described in the <code>UDP</code> server section, disposing the resources can be done via <code>Connection.dispose()</code>
681 | or <code>Connection.disposeNow()</code>.</p>
682 | </div>
683 | </div>
684 | <div class="sect2">
685 | <h3 id="_configuring_udp_client"><a class="anchor" href="#_configuring_udp_client"></a>Configuring UDP client</h3>
686 | <div class="sect3">
687 | <h4 id="_configuring_the_wire_logger_2"><a class="anchor" href="#_configuring_the_wire_logger_2"></a>Configuring the Wire Logger</h4>
688 | <div class="paragraph">
689 | <p><code>UdpClient.wiretap</code> can be used for wire logging and this will use <code>reactor.netty.udp.UdpClient</code> category
690 | with <code>DEBUG</code> level. There are also <code>UdpClient.wiretap(String)</code> and <code>UdpClient.wiretap(String, LogLevel)</code> so that
691 | one can change the category and the log level.</p>
692 | </div>
693 | </div>
694 | <div class="sect3">
695 | <h4 id="_configuring_the_event_loop_group_2"><a class="anchor" href="#_configuring_the_event_loop_group_2"></a>Configuring the Event Loop Group</h4>
696 | <div class="paragraph">
697 | <p>The default configuration for the Event Loop Group is the same as in <code>UDP</code> server.
698 | When one needs a different configuration, <code>UdpClient.runOn</code> methods can be used.</p>
699 | </div>
700 | </div>
701 | </div>
702 | <div class="sect2">
703 | <h3 id="_add_udp_client_io_handler_that_will_send_a_package_and_will_react_on_an_incoming_packages"><a class="anchor" href="#_add_udp_client_io_handler_that_will_send_a_package_and_will_react_on_an_incoming_packages"></a>Add UDP client IO handler that will send a package and will react on an incoming packages</h3>
704 | <div class="paragraph">
705 | <p><code>UdpClient.handle(BiFunction&lt;UdpInbound, UdpOutbound, Publisher&lt;Void&gt;&gt;)</code> should be used if one wants to attach IO
706 | handler that will process the incoming packages and will eventually send packages as reply.
707 | Here as a convenience <code>UdpOutbound.send*</code> (e.g. <code>UdpOutbound.sendString</code>) methods can be used instead of
708 | <code>UdpOutbound.sendObject</code> as the client is connected to exactly one <code>UDP</code> server. The same is also for
709 | using <code>UdpInbound.receive()</code> instead of <code>UdpInbound.receiveObject()</code>.</p>
710 | </div>
711 | </div>
712 | <div class="sect2">
713 | <h3 id="_utilize_monoconnection"><a class="anchor" href="#_utilize_monoconnection"></a>Utilize Mono&lt;Connection&gt;</h3>
714 | <div class="paragraph">
715 | <p>In the section for the <code>UDP</code> server creation was described that as a result of <code>UdpServer.bind</code> one will
716 | receive <code>Mono&lt;Connection&gt;</code> which will emit (complete|error) signals.
717 | Utilizing this <code>Mono</code> one can send a datagram package (the snippet below) as soon as the <code>UDP</code> server is
718 | bound successfully.</p>
719 | </div>
720 | <div class="listingblock">
721 | <div class="content">
722 | <pre class="prettyprint highlight"><code data-lang="java">DatagramChannel udp = DatagramChannel.open();
723 | udp.configureBlocking(true);
724 | udp.connect(new InetSocketAddress(server1.address().getPort()));
725 | 
726 | byte[] data = new byte[1024];
727 | new Random().nextBytes(data);
728 | for (int i = 0; i &lt; 4; i++) {
729 |     udp.write(ByteBuffer.wrap(data));
730 | }
731 | 
732 | udp.close();</code></pre>
733 | </div>
734 | </div>
735 | </div>
736 | </div>
737 | </div>
738 | <div class="sect1">
739 | <h2 id="_tcp_server_and_client"><a class="anchor" href="#_tcp_server_and_client"></a>TCP server and client</h2>
740 | <div class="sectionbody">
741 | <div class="paragraph">
742 | <p>If one wants to utilize the <code>TCP</code> protocol one will need to create a <code>TCP</code> servers that can send packages
743 | to the connected clients or <code>TCP</code> clients that can connect to specific <code>TCP</code> servers.
744 | <code>Reactor Netty</code> provides easy to use and configure <code>TcpServer</code> and <code>TcpClient</code>, they hide most of the
745 | <code>Netty</code> functionality that is needed in order to create with <code>TCP</code> server and client, and in addition add
746 | <code>Reactive Streams</code> backpressure.</p>
747 | </div>
748 | <div class="sect2">
749 | <h3 id="_creating_tcp_server"><a class="anchor" href="#_creating_tcp_server"></a>Creating TCP server</h3>
750 | <div class="paragraph">
751 | <p><code>TcpServer</code> allows to build, configure and materialize a <code>TCP</code> server.
752 | Invoking <code>TcpServer.create()</code> one can prepare the <code>TCP</code> server for configuration. Having already a <code>TcpServer</code>
753 | instance, one can start configuring the host, port, the IO handler etc.
754 | For configuration purposes, the same immutable builder pattern is used as in <code>UdpServer</code>.</p>
755 | </div>
756 | <div class="paragraph">
757 | <p>When finished with the server configuration, invoking <code>TcpServer.bind</code>, one will bind the server
758 | and <code>Mono&lt;DisposableServer&gt;</code> will be return, subscribing to this <code>Publisher</code> one can react
759 | on a successfully finished operation or handle issues that might happen. On the other hand
760 | cancelling this <code>Mono</code>, the underlying connecting operation will be aborted. If one do not need to interact with the
761 | <code>Mono</code>, there is <code>TcpServer.bindNow(Duration)</code> which is a convenient method for binding the server and obtaining
762 | the <code>DisposableServer</code>.
763 | <code>DisposableServer</code> holds contextual information for the underlying server.
764 | Disposing the resources can be done via <code>DisposableServer.dispose()</code> or <code>DisposableServer.disposeNow()</code>.</p>
765 | </div>
766 | </div>
767 | <div class="sect2">
768 | <h3 id="_enabling_ssl_support_for_tcp_server"><a class="anchor" href="#_enabling_ssl_support_for_tcp_server"></a>Enabling SSL support for TCP server</h3>
769 | <div class="paragraph">
770 | <p><code>TcpServer</code> provides several convenient methods for configuring SSL:</p>
771 | </div>
772 | <div class="ulist">
773 | <ul>
774 | <li>
775 | <p><code>TcpServer.secure(SslContext)</code> where SslContext is already configured</p>
776 | </li>
777 | <li>
778 | <p><code>TcpServer.secure(Consumer&lt;? super SslProvider.SslContextSpec&gt;)</code> where the SSL configuration customization
779 | can be done via the passed builder.</p>
780 | </li>
781 | </ul>
782 | </div>
783 | </div>
784 | <div class="sect2">
785 | <h3 id="_add_tcp_server_io_handler_that_will_send_a_file"><a class="anchor" href="#_add_tcp_server_io_handler_that_will_send_a_file"></a>Add TCP server IO handler that will send a file</h3>
786 | <div class="paragraph">
787 | <p><code>TcpServer.handle(BiFunction&lt;NettyInbound, NettyOutbound, Publisher&lt;Void&gt;&gt;)</code> should be used if one wants to attach IO
788 | handler that will process the incoming messages and will eventually send messages as a reply.
789 | <code>NettyInbound</code> is used to receive bytes from the peer where <code>NettyInbound.receiveObject()</code> returns the pure inbound
790 | <code>Flux</code>, while <code>NettyInbound.receive()</code> returns <code>ByteBufFlux</code> which provides an extra API to handle the incoming traffic.
791 | <code>NettyOutbound</code> is used to send bytes to the peer, listen for any error returned by the write operation
792 | and close on terminal  signal (complete|error). If more than one <code>Publisher</code> is attached
793 | (multiple calls to <code>NettyOutbound.send*</code> methods), completion occurs when all publishers complete.
794 | The <code>Publisher&lt;Void&gt;</code> that has to be returned as a result represents the sequence of the operations that will be
795 | applied for the incoming and outgoing traffic.
796 | For example if one wants to send a file to the client where the file name is received as an incoming package,
797 | the snippet bellow can be used:</p>
798 | </div>
799 | <div class="listingblock">
800 | <div class="content">
801 | <pre class="prettyprint highlight"><code data-lang="java">.handle((in, out) -&gt;
802 |         in.receive()
803 |           .asString()
804 |           .flatMap(s -&gt; {
805 |               try {
806 |                   Path file = Paths.get(getClass().getResource(s).toURI());
807 |                   return out.sendFile(file)
808 |                             .then();
809 |               } catch (URISyntaxException e) {
810 |                   return Mono.error(e);
811 |               }
812 |           }))</code></pre>
813 | </div>
814 | </div>
815 | </div>
816 | <div class="sect2">
817 | <h3 id="_creating_tcp_client"><a class="anchor" href="#_creating_tcp_client"></a>Creating TCP client</h3>
818 | <div class="paragraph">
819 | <p><code>TcpClient</code> allows to build, configure and materialize a <code>TCP</code> client.
820 | Invoking <code>TcpClient.create()</code> one can prepare the <code>TCP</code> client for configuration. Having already a <code>TcpClient</code>
821 | instance, one can start configuring the host, port, the IO handler etc.
822 | For configuration purposes, the same immutable builder pattern is used as in <code>UdpServer</code>.</p>
823 | </div>
824 | <div class="paragraph">
825 | <p>When finished with the client configuration, invoking <code>TcpClient.connect()</code>, one will connect the client
826 | and <code>Mono&lt;Connection&gt;</code> will be return, subscribing to this <code>Publisher</code> one can react
827 | on a successfully finished operation or handle issues that might happen. On the other hand
828 | cancelling this <code>Mono</code>, the underlying connecting operation will be aborted. If one do not need to interact with the
829 | <code>Mono</code>, there is <code>TcpClient.connectNow(Duration)</code> which is a convenient method for connecting the client and obtaining
830 | the <code>Connection</code>.
831 | As already described in the <code>UDP</code> server section, disposing the resources can be done via <code>Connection.dispose()</code>
832 | or <code>Connection.disposeNow()</code>.</p>
833 | </div>
834 | </div>
835 | <div class="sect2">
836 | <h3 id="_enabling_ssl_support_for_tcp_client"><a class="anchor" href="#_enabling_ssl_support_for_tcp_client"></a>Enabling SSL support for TCP client</h3>
837 | <div class="paragraph">
838 | <p><code>TcpClient</code> provides several convenient methods for configuring SSL.
839 | When one wants to use the default SSL configuration provided by Reactor Netty <code>TcpClient.secure()</code> can be used.
840 | If additional configuration is necessary then one of the following methods can be used:</p>
841 | </div>
842 | <div class="ulist">
843 | <ul>
844 | <li>
845 | <p><code>TcpClient.secure(SslContext)</code> where SslContext is already configured</p>
846 | </li>
847 | <li>
848 | <p><code>TcpClient.secure(Consumer&lt;? super SslProvider.SslContextSpec&gt;)</code> where the SSL configuration customization
849 | can be done via the passed builder.</p>
850 | </li>
851 | </ul>
852 | </div>
853 | </div>
854 | <div class="sect2">
855 | <h3 id="_add_tcp_client_io_handler"><a class="anchor" href="#_add_tcp_client_io_handler"></a>Add TCP client IO handler</h3>
856 | <div class="paragraph">
857 | <p><code>TcpClient.handle(BiFunction&lt;NettyInbound, NettyOutbound, Publisher&lt;Void&gt;&gt;)</code> should be used if one wants to attach IO
858 | handler that will process the incoming messages and will eventually send messages as reply.
859 | Here as a convenience <code>NettyOutbound.send*</code> (e.g. <code>NettyOutbound.sendString</code>) methods can be used instead of
860 | <code>NettyOutbound.sendObject</code>. The same is also for using <code>NettyInbound.receive()</code> instead of
861 | <code>NettyInbound.receiveObject()</code>.</p>
862 | </div>
863 | </div>
864 | </div>
865 | </div>
866 | <div class="sect1">
867 | <h2 id="_http_server_and_client"><a class="anchor" href="#_http_server_and_client"></a>HTTP server and client</h2>
868 | <div class="sectionbody">
869 | <div class="sect2">
870 | <h3 id="_creating_http_server"><a class="anchor" href="#_creating_http_server"></a>Creating HTTP server</h3>
871 | <div class="paragraph">
872 | <p><code>HttpServer</code> allows to build, configure and materialize a <code>HTTP</code> server.
873 | Invoking <code>HttpServer.create()</code> one can prepare the <code>HTTP</code> server for configuration. Having already a <code>HttpServer</code>
874 | instance, one can start configuring the host, port, the IO handler, compression etc.
875 | For configuration purposes, the same immutable builder pattern is used as in <code>UdpServer</code>.</p>
876 | </div>
877 | <div class="paragraph">
878 | <p>When finished with the server configuration, invoking <code>HttpServer.bind</code>, one will bind the server
879 | and <code>Mono&lt;DisposableServer&gt;</code> will be return, subscribing to this <code>Publisher</code> one can react
880 | on a successfully finished operation or handle issues that might happen. On the other hand
881 | cancelling this <code>Mono</code>, the underlying connecting operation will be aborted. If one do not need to interact with the
882 | <code>Mono</code>, there is <code>HttpServer.bindNow(Duration)</code> which is a convenient method for binding the server and obtaining
883 | the <code>DisposableServer</code>.
884 | Disposing the resources can be done via <code>DisposableServer.dispose()</code> or <code>DisposableServer.disposeNow()</code>.</p>
885 | </div>
886 | </div>
887 | <div class="sect2">
888 | <h3 id="_defining_routes_for_the_http_server"><a class="anchor" href="#_defining_routes_for_the_http_server"></a>Defining routes for the HTTP server</h3>
889 | <div class="paragraph">
890 | <p>In <code>HttpServer</code> one can handle the incoming requests and outgoing responses using
891 | <code>HttpServer.handle(BiFunction&lt;HttpServerRequest, HttpServerResponse, Publisher&lt;Void&gt;&gt;)</code> which is similar to the
892 | mechanism that was already described for <code>UdpServer</code>/<code>TcpServer</code>. However there is also a possibility to specify
893 | concrete routes and HTTP methods that the server will respond. This can be done using
894 | <code>HttpServer.route(Consumer&lt;HttpServerRoutes&gt;)</code>. Using <code>HttpServerRoutes</code> one can specify the HTTP method, paths etc.
895 | For example the snippet below specifies that the server will respond only on <code>POST</code> method, where the path starts with
896 | <code>/test</code> and has a path parameter.</p>
897 | </div>
898 | <div class="listingblock">
899 | <div class="content">
900 | <pre class="prettyprint highlight"><code data-lang="java">.route(routes -&gt;
901 |         routes.post("/test/{param}", (req, res) -&gt;
902 |                 res.sendString(req.receive()
903 |                                   .asString()
904 |                                   .map(s -&gt; s + ' ' + req.param("param") + '!'))))</code></pre>
905 | </div>
906 | </div>
907 | <div class="paragraph">
908 | <p><code>HttpServerRequest</code> provides API for accessing http request attributes as method, path, headers, path parameters etc.
909 | as well as to receive the request body.
910 | <code>HttpServerResponse</code> provides API for accessing http response attributes as status code, headers, compression etc.
911 | as well as to send the response body.</p>
912 | </div>
913 | </div>
914 | <div class="sect2">
915 | <h3 id="_creating_http_client"><a class="anchor" href="#_creating_http_client"></a>Creating HTTP client</h3>
916 | <div class="paragraph">
917 | <p><code>HttpClient</code> allows to build, configure and materialize a <code>HTTP</code> client.
918 | Invoking <code>HttpClient.create()</code> one can prepare the <code>HTTP</code> client for configuration. Having already a <code>HttpClient</code>
919 | instance, one can start configuring the host, port, headers, compression etc.
920 | For configuration purposes, the same immutable builder pattern is used as in <code>UdpServer</code>.</p>
921 | </div>
922 | <div class="paragraph">
923 | <p>When finished with the client configuration, invoking <code>HttpClient.get|post|&#8230;&#8203;</code> methods, one will receive
924 | <code>HttpClient.RequestSender</code> and will be able start configuring the <code>HTTP</code> request such as the uri and the request body.
925 | <code>HttpClient.RequestSender.send*</code> will end the HTTP request&#8217;s configuration and one can start discribing the actions
926 | on the <code>HTTP</code> response when it is received on the returned <code>HttpClient.ResponseReceiver</code>, the response body can be obtained via the provided
927 | <code>HttpClient.ResponseReceiver.response*</code> methods. As <code>HttpClient.ResponseReceiver</code> API always returns <code>Publisher</code>,
928 | the request and response executions are always deferred to the moment when there is a <code>Subscriber</code>
929 | that subscribes to the defined sequence. For example in the snippet below <code>block()</code> will subscribe to the defined
930 | sequence and in fact will trigger the execution.</p>
931 | </div>
932 | <div class="paragraph">
933 | <p>In the snippet below can be used to send POST request with a body and received the answer from the server:</p>
934 | </div>
935 | <div class="listingblock">
936 | <div class="content">
937 | <pre class="prettyprint highlight"><code data-lang="java">HttpClient.create()             // Prepares a HTTP client for configuration.
938 |           .port(server.port())  // Obtain the server's port and provide it as a port to which this
939 |                                 // client should connect.
940 |           .wiretap(true)        // Applies a wire logger configuration.
941 |           .headers(h -&gt; h.add("Content-Type", "text/plain")) // Adds headers to the HTTP request.
942 |           .post()              // Specifies that POST method will be used.
943 |           .uri("/test/World")  // Specifies the path.
944 |           .send(ByteBufFlux.fromString(Flux.just("Hello")))  // Sends the request body.
945 |           .responseContent()   // Receives the response body.
946 |           .aggregate()
947 |           .asString()
948 |           .block();</code></pre>
949 | </div>
950 | </div>
951 | </div>
952 | </div>
953 | </div>
954 | </div>
955 | <div id="footer">
956 | <div id="footer-text">
957 | Last updated 2022-03-03 12:32:50 +0200
958 | </div>
959 | </div>
960 | <script src="https://cdnjs.cloudflare.com/ajax/libs/prettify/r298/run_prettify.min.js"></script>
961 | </body>
962 | </html>


--------------------------------------------------------------------------------