dnrops
/
swift-nio
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add 2 missing server readme docs. (#940) 

Add missing server readme docs for WebSocket server and UDP echo server.

Motivation:
With the exception of these two samples, all client and server examples have helpful readme docs.
Provides brief description of purpose of the sample code and how to run it.

Modifications:
Adds a readme to NIOUDPEchoServer.
Adds a readme to NIOWebSocketServer.

Result:
The samples for NIOUDPEchoServer and NIOWebSocketServer have a little explanation.
This commit is contained in:
Liam Flynn 2019-04-02 11:28:31 +01:00 committed by Johannes Weiss
parent 3336cfaca3
commit df4e078c74
2 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Sources/NIOUDPEchoServer/README.md Normal file
View File

@ -0,0 +1,11 @@
# NIOUDPEchoServer
This sample application provides a simple UDP echo server that sends clients back whatever data they send it. Invoke it using one of the following syntaxes:
```bash
swift run NIOUDPEchoServer # Binds the server on ::1, port 9999.
swift run NIOUDPEchoServer 9899 # Binds the server on ::1, port 9899
swift run NIOUDPEchoServer /path/to/unix/socket # Binds the server using the given UNIX socket
swift run NIOUDPEchoServer 192.168.0.5 9899 # Binds the server on 192.168.0.5:9899
```

20
Sources/NIOWebSocketServer/README.md Normal file
View File

@ -0,0 +1,20 @@
# NIOWebSocketServer
This sample application provides a simple WebSocket server which replies to a limited number of WebSocket message types. Initially, it sends clients back a test page response to a valid HTTP1 GET request. A 405 error will be reported for any other type of request. Once upgraded to WebSocket responses it will respond to a number of WebSocket message opcodes. Invoke it using one of the following syntaxes:
```bash
swift run NIOWebSocketServer # Binds the server on 'localhost', port 8888.
swift run NIOWebSocketServer 9899 # Binds the server on 'localhost', port 9899
swift run NIOWebSocketServer /path/to/unix/socket # Binds the server using the given UNIX socket
swift run NIOWebSocketServer 192.168.0.5 9899 # Binds the server on 192.168.0.5:9899
```
## Message Type Opcodes
The WebSocket server responds to the following message type opcodes:
- `connectionClose`: closes the connection.
- `ping`: replies with a 'pong' message containing frame data matching the received message.
- `text`: prints the received string out on the server console.
All other message types are ignored.