capnproto

FORK: Cap'n Proto serialization/RPC system - core tools and C++ library
git clone https://git.neptards.moe/neptards/capnproto.git
Log | Files | Refs | README | LICENSE

websocket-rpc.h (2225B)


      1 // Copyright (c) 2021 Ian Denhardt and contributors
      2 // Licensed under the MIT License:
      3 //
      4 // Permission is hereby granted, free of charge, to any person obtaining a copy
      5 // of this software and associated documentation files (the "Software"), to deal
      6 // in the Software without restriction, including without limitation the rights
      7 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
      8 // copies of the Software, and to permit persons to whom the Software is
      9 // furnished to do so, subject to the following conditions:
     10 //
     11 // The above copyright notice and this permission notice shall be included in
     12 // all copies or substantial portions of the Software.
     13 //
     14 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
     15 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
     16 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
     17 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
     18 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
     19 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
     20 // THE SOFTWARE.
     21 
     22 #pragma once
     23 
     24 #include <kj/compat/http.h>
     25 #include <capnp/serialize-async.h>
     26 
     27 namespace capnp {
     28 
     29 class WebSocketMessageStream final : public MessageStream {
     30   // An implementation of MessageStream that sends messages over a websocket.
     31   //
     32   // Each capnproto message is sent in a single binary websocket frame.
     33 public:
     34   WebSocketMessageStream(kj::WebSocket& socket);
     35 
     36   // Implements MessageStream
     37   kj::Promise<kj::Maybe<MessageReaderAndFds>> tryReadMessage(
     38       kj::ArrayPtr<kj::AutoCloseFd> fdSpace,
     39       ReaderOptions options = ReaderOptions(), kj::ArrayPtr<word> scratchSpace = nullptr) override;
     40   kj::Promise<void> writeMessage(
     41       kj::ArrayPtr<const int> fds,
     42       kj::ArrayPtr<const kj::ArrayPtr<const word>> segments) override
     43     KJ_WARN_UNUSED_RESULT;
     44   kj::Promise<void> writeMessages(
     45       kj::ArrayPtr<kj::ArrayPtr<const kj::ArrayPtr<const word>>> messages) override
     46     KJ_WARN_UNUSED_RESULT;
     47   kj::Maybe<int> getSendBufferSize() override;
     48   kj::Promise<void> end() override;
     49 private:
     50   kj::WebSocket& socket;
     51 };
     52 
     53 }  // namespace capnp