From 30da3a967b88b9e7795a76f79d601ae1183c6dc1 Mon Sep 17 00:00:00 2001 From: Peter Thorson Date: Sun, 2 Mar 2014 19:10:24 -0600 Subject: [PATCH] renaming and re-titling the app client tutorial to utility client --- .../app_client_tutorial.md | 33 ------------------- tutorials/app_client_tutorial/chapter2.md | 14 -------- .../step1.cpp | 0 .../step2.cpp | 0 .../step3.cpp | 0 .../step4.cpp | 0 .../step5.cpp | 0 .../utility_client.md} | 8 ++++- 8 files changed, 7 insertions(+), 48 deletions(-) delete mode 100644 tutorials/app_client_tutorial/app_client_tutorial.md delete mode 100644 tutorials/app_client_tutorial/chapter2.md rename tutorials/{app_client_tutorial => utility_client_tutorial}/step1.cpp (100%) rename tutorials/{app_client_tutorial => utility_client_tutorial}/step2.cpp (100%) rename tutorials/{app_client_tutorial => utility_client_tutorial}/step3.cpp (100%) rename tutorials/{app_client_tutorial => utility_client_tutorial}/step4.cpp (100%) rename tutorials/{app_client_tutorial => utility_client_tutorial}/step5.cpp (100%) rename tutorials/{app_client_tutorial/chapter1.md => utility_client_tutorial/utility_client.md} (99%) diff --git a/tutorials/app_client_tutorial/app_client_tutorial.md b/tutorials/app_client_tutorial/app_client_tutorial.md deleted file mode 100644 index f596930b26..0000000000 --- a/tutorials/app_client_tutorial/app_client_tutorial.md +++ /dev/null @@ -1,33 +0,0 @@ -Client - -separate thread - -multiple connections at once - - -An application with its own event loop. This demonstrates an example of how to integrate WebSocket++ into an application with a pre-existing event loop. This includes applications that use GUI frameworks like wxWidgets, Qt, etc. - -- Uses a dedicated thread (or thread pool) to process WebSocket traffic. This allows better responsiveness for WebSocket activities, multiple similtaneous connections, easily reconnecting - - -This example application impliments a command line menu to manage an arbitrary number of outgoing websocket connections. - - -Core Options: -- Create a new connection to a WebSocket server with the given URI. -- View list of outstanding connections with some metadata -- Send a message along a specific connection -- Send a message to all connections -- List all messages received by a given connection -- Close a specific connection -- Close all connections - -Bonus Features -- Set the user agent -- Set the origin -- Set other arbitrary headers -- Set proxy information -- Send a ping - -utility features -- Pipe one connection to another diff --git a/tutorials/app_client_tutorial/chapter2.md b/tutorials/app_client_tutorial/chapter2.md deleted file mode 100644 index 9b35f84dd0..0000000000 --- a/tutorials/app_client_tutorial/chapter2.md +++ /dev/null @@ -1,14 +0,0 @@ -Utility Client Example Application -================================== - -Chapter 2: Initial Setup & Basics ---------------------------------- - -Using intermediate level features - -- Subprotocol negotiation -- Setting and reading custom headers -- Ping and Pong - -### Step 1 - diff --git a/tutorials/app_client_tutorial/step1.cpp b/tutorials/utility_client_tutorial/step1.cpp similarity index 100% rename from tutorials/app_client_tutorial/step1.cpp rename to tutorials/utility_client_tutorial/step1.cpp diff --git a/tutorials/app_client_tutorial/step2.cpp b/tutorials/utility_client_tutorial/step2.cpp similarity index 100% rename from tutorials/app_client_tutorial/step2.cpp rename to tutorials/utility_client_tutorial/step2.cpp diff --git a/tutorials/app_client_tutorial/step3.cpp b/tutorials/utility_client_tutorial/step3.cpp similarity index 100% rename from tutorials/app_client_tutorial/step3.cpp rename to tutorials/utility_client_tutorial/step3.cpp diff --git a/tutorials/app_client_tutorial/step4.cpp b/tutorials/utility_client_tutorial/step4.cpp similarity index 100% rename from tutorials/app_client_tutorial/step4.cpp rename to tutorials/utility_client_tutorial/step4.cpp diff --git a/tutorials/app_client_tutorial/step5.cpp b/tutorials/utility_client_tutorial/step5.cpp similarity index 100% rename from tutorials/app_client_tutorial/step5.cpp rename to tutorials/utility_client_tutorial/step5.cpp diff --git a/tutorials/app_client_tutorial/chapter1.md b/tutorials/utility_client_tutorial/utility_client.md similarity index 99% rename from tutorials/app_client_tutorial/chapter1.md rename to tutorials/utility_client_tutorial/utility_client.md index 45439a32e7..f90516a653 100644 --- a/tutorials/app_client_tutorial/chapter1.md +++ b/tutorials/utility_client_tutorial/utility_client.md @@ -14,6 +14,9 @@ A basic program loop that prompts the user for a command and then processes it. `clang++ step1.cpp` #### Code so far + +*note* A code snapshot for each step is present next to this tutorial file in the git repository. + ```cpp #include #include @@ -673,6 +676,9 @@ _Sending and receiving messages_ _Using TLS / Secure WebSockets_ +Chapter 2: Intermediate Features +-------------------------------- + ### Step 8 _Intermediate level features_ @@ -685,7 +691,7 @@ _Intermediate level features_ - Setting Origin - Timers and security - Close behavior - +- Send one message to all connections ### Misc stuff not sure if it should be included here or elsewhere?