ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2026-04-29 15:37:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Formatting fixes for app client tutorial step 5

Browse Source
This commit is contained in:
Peter Thorson
2014-03-02 19:02:11 -06:00
parent 98fd183210
commit 93d9b5f820
2 changed files with 24 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
tutorials/app_client_tutorial/chapter1.md
View File

@@ -530,7 +530,7 @@ _Closing connections_
This step adds a command that allows you to close a WebSocket connection and adjusts the quit command so that it cleanly closes all outstanding connections before quitting.
#### WebSocket++ tools for connection closing
#### Getting connection close information out of WebSocket++
> ###### Terminology: WebSocket close codes & reasons
> The WebSocket close handshake involves an exchange of optional machine readable close codes and human readable reason strings. Each endpoint sends independent close details. The codes are short integers. The reasons are UTF8 text strings of at most 125 characters. More details about valid close code ranges and the meaning of each code can be found at https://tools.ietf.org/html/rfc6455#section-7.4
@@ -563,11 +563,11 @@ void on_close(client * c, websocketpp::connection_hdl hdl) {
}
```
Similarly to `on_open` and `on_fail`, websocket_endpoint::connect registers this close handler when a new connection is made.
Similarly to `on_open` and `on_fail`, `websocket_endpoint::connect` registers this close handler when a new connection is made.
#### Add close method to `websocket_endpoint`
This method starts by looking up the given connection ID in the connection list. If it isn't found an error is printed. Next a close request is sent to the connection's handle with the specified WebSocket close code. This is done by calling `endpoint::close`. This is a thread safe method that is used to asynchronously dispatch a close signal to the connection with the given handle. When the operation is complete the connection's close handler will be triggered.
This method starts by looking up the given connection ID in the connection list. Next a close request is sent to the connection's handle with the specified WebSocket close code. This is done by calling `endpoint::close`. This is a thread safe method that is used to asynchronously dispatch a close signal to the connection with the given handle. When the operation is complete the connection's close handler will be triggered.
```cpp
void close(int id, websocketpp::close::status::value code) {
@@ -588,10 +588,26 @@ void close(int id, websocketpp::close::status::value code) {
#### Add close option to the command loop and help message
A close option is added to the command loop. It takes a connection ID and optionally a close code and a close reason. If no code is specified the default of 1000/Normal is used. If no reason is specified, none is sent. The endpoint::send method will do some error checking and abort the close request if you try and send an invalid code or a reason with invalid UTF8 formatting. Reason strings longer than 125 characters will be truncated.
A close option is added to the command loop. It takes a connection ID and optionally a close code and a close reason. If no code is specified the default of 1000/Normal is used. If no reason is specified, none is sent. The `endpoint::send` method will do some error checking and abort the close request if you try and send an invalid code or a reason with invalid UTF8 formatting. Reason strings longer than 125 characters will be truncated.
An entry is also added to the help system to describe how the new command may be used.
```cpp
else if (input.substr(0,5) == "close") {
std::stringstream ss(input);
std::string cmd;
int id;
int close_code = websocketpp::close::status::normal;
std::string reason = "";
ss >> cmd >> id >> close_code;
std::getline(ss,reason);
endpoint.close(id, close_code, reason);
}
```
#### Close all outstanding connections in `websocket_endpoint` destructor
Until now quitting the program left outstanding connections and the WebSocket++ network thread in a lurch. Now that we have a method of closing connections we can clean this up properly.
@@ -613,7 +629,8 @@ The destructor for `websocket_endpoint` now stops perpetual mode (so the run thr
websocketpp::lib::error_code ec;
m_endpoint.close(it->second->get_hdl(), websocketpp::close::status::going_away, "", ec);
if (ec) {
std::cout << "> Error closing connection " << it->second->get_id() << ": " << ec.message() << std::endl;
std::cout << "> Error closing connection " << it->second->get_id() << ": "
<< ec.message() << std::endl;
}
}

3
tutorials/app_client_tutorial/step5.cpp
View File

@@ -106,7 +106,8 @@ public:
websocketpp::lib::error_code ec;
m_endpoint.close(it->second->get_hdl(), websocketpp::close::status::going_away, "", ec);
if (ec) {
std::cout << "> Error closing connection " << it->second->get_id() << ": " << ec.message() << std::endl;
std::cout << "> Error closing connection " << it->second->get_id() << ": "
<< ec.message() << std::endl;
}
}