Austin Schuh | 9d82300 | 2019-04-14 12:53:17 -0700 | [diff] [blame^] | 1 | // Copyright (c) 2013-2017, Matt Godbolt |
Austin Schuh | 24adb6b | 2015-09-06 17:37:40 -0700 | [diff] [blame] | 2 | // All rights reserved. |
Austin Schuh | 9d82300 | 2019-04-14 12:53:17 -0700 | [diff] [blame^] | 3 | // |
| 4 | // Redistribution and use in source and binary forms, with or without |
Austin Schuh | 24adb6b | 2015-09-06 17:37:40 -0700 | [diff] [blame] | 5 | // modification, are permitted provided that the following conditions are met: |
Austin Schuh | 9d82300 | 2019-04-14 12:53:17 -0700 | [diff] [blame^] | 6 | // |
| 7 | // Redistributions of source code must retain the above copyright notice, this |
Austin Schuh | 24adb6b | 2015-09-06 17:37:40 -0700 | [diff] [blame] | 8 | // list of conditions and the following disclaimer. |
Austin Schuh | 9d82300 | 2019-04-14 12:53:17 -0700 | [diff] [blame^] | 9 | // |
| 10 | // Redistributions in binary form must reproduce the above copyright notice, |
| 11 | // this list of conditions and the following disclaimer in the documentation |
Austin Schuh | 24adb6b | 2015-09-06 17:37:40 -0700 | [diff] [blame] | 12 | // and/or other materials provided with the distribution. |
Austin Schuh | 9d82300 | 2019-04-14 12:53:17 -0700 | [diff] [blame^] | 13 | // |
| 14 | // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| 15 | // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 16 | // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 17 | // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
| 18 | // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| 19 | // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| 20 | // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| 21 | // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| 22 | // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| 23 | // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
Austin Schuh | 24adb6b | 2015-09-06 17:37:40 -0700 | [diff] [blame] | 24 | // POSSIBILITY OF SUCH DAMAGE. |
| 25 | |
| 26 | #pragma once |
| 27 | |
| 28 | #include "seasocks/Request.h" |
| 29 | |
Austin Schuh | 9d82300 | 2019-04-14 12:53:17 -0700 | [diff] [blame^] | 30 | #include <string> |
Austin Schuh | 24adb6b | 2015-09-06 17:37:40 -0700 | [diff] [blame] | 31 | #include <vector> |
| 32 | |
| 33 | namespace seasocks { |
| 34 | |
| 35 | class WebSocket : public Request { |
| 36 | public: |
| 37 | /** |
| 38 | * Send the given text data. Must be called on the seasocks thread. |
| 39 | * See Server::execute for how to run work on the seasocks |
| 40 | * thread externally. |
| 41 | */ |
| 42 | virtual void send(const char* data) = 0; |
| 43 | /** |
Austin Schuh | 9d82300 | 2019-04-14 12:53:17 -0700 | [diff] [blame^] | 44 | * Send the given text data. Must be called on the seasocks thread. |
| 45 | * See Server::execute for how to run work on the seasocks |
| 46 | * thread externally. |
| 47 | */ |
| 48 | void send(const std::string& data) { |
| 49 | send(data.c_str()); |
| 50 | } |
| 51 | /** |
Austin Schuh | 24adb6b | 2015-09-06 17:37:40 -0700 | [diff] [blame] | 52 | * Send the given binary data. Must be called on the seasocks thread. |
| 53 | * See Server::execute for how to run work on the seasocks |
| 54 | * thread externally. |
| 55 | */ |
| 56 | virtual void send(const uint8_t* data, size_t length) = 0; |
| 57 | /** |
| 58 | * Close the socket. It's invalid to access the socket after |
| 59 | * calling close(). The Handler::onDisconnect() call may occur |
| 60 | * at a later time. |
| 61 | */ |
| 62 | virtual void close() = 0; |
| 63 | |
| 64 | /** |
| 65 | * Interface to dealing with WebSocket connections. |
| 66 | */ |
| 67 | class Handler { |
| 68 | public: |
Austin Schuh | 9d82300 | 2019-04-14 12:53:17 -0700 | [diff] [blame^] | 69 | virtual ~Handler() = default; |
Austin Schuh | 24adb6b | 2015-09-06 17:37:40 -0700 | [diff] [blame] | 70 | |
| 71 | /** |
| 72 | * Called on the seasocks thread during initial connection. |
| 73 | */ |
| 74 | virtual void onConnect(WebSocket* connection) = 0; |
| 75 | /** |
| 76 | * Called on the seasocks thread with upon receipt of a full text WebSocket message. |
| 77 | */ |
Austin Schuh | 9d82300 | 2019-04-14 12:53:17 -0700 | [diff] [blame^] | 78 | virtual void onData(WebSocket*, const char*) { |
| 79 | } |
Austin Schuh | 24adb6b | 2015-09-06 17:37:40 -0700 | [diff] [blame] | 80 | /** |
| 81 | * Called on the seasocks thread with upon receipt of a full binary WebSocket message. |
| 82 | */ |
Austin Schuh | 9d82300 | 2019-04-14 12:53:17 -0700 | [diff] [blame^] | 83 | virtual void onData(WebSocket*, const uint8_t*, size_t) { |
| 84 | } |
Austin Schuh | 24adb6b | 2015-09-06 17:37:40 -0700 | [diff] [blame] | 85 | /** |
| 86 | * Called on the seasocks thread when the socket has been |
| 87 | */ |
| 88 | virtual void onDisconnect(WebSocket* connection) = 0; |
Austin Schuh | 9d82300 | 2019-04-14 12:53:17 -0700 | [diff] [blame^] | 89 | /** |
| 90 | * Choose a protocol before accepting a connection: return < 0 to reject the connection, else return the ordinal |
| 91 | * in the vector of string protocols. |
| 92 | */ |
| 93 | virtual ssize_t chooseProtocol(const std::vector<std::string>&) const { |
| 94 | return 0; |
| 95 | } |
Austin Schuh | 24adb6b | 2015-09-06 17:37:40 -0700 | [diff] [blame] | 96 | }; |
| 97 | |
| 98 | protected: |
| 99 | // To delete a WebSocket, just close it. It is owned by the Server, and |
| 100 | // the server will delete it when it's finished. |
Austin Schuh | 9d82300 | 2019-04-14 12:53:17 -0700 | [diff] [blame^] | 101 | virtual ~WebSocket() = default; |
Austin Schuh | 24adb6b | 2015-09-06 17:37:40 -0700 | [diff] [blame] | 102 | }; |
| 103 | |
Austin Schuh | 9d82300 | 2019-04-14 12:53:17 -0700 | [diff] [blame^] | 104 | } // namespace seasocks |