Skip to content
Branch: master
Find file History
tigerpixel and weissi 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.
Latest commit df4e078 Apr 2, 2019
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
README.md Add 2 missing server readme docs. (#940) Apr 2, 2019
main.swift Allow delaying HTTP upgrade decisions. (#844) Mar 1, 2019

README.md

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:

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.

You can’t perform that action at this time.