cannam@49: // Copyright (c) 2013-2014 Sandstorm Development Group, Inc. and contributors cannam@49: // Licensed under the MIT License: cannam@49: // cannam@49: // Permission is hereby granted, free of charge, to any person obtaining a copy cannam@49: // of this software and associated documentation files (the "Software"), to deal cannam@49: // in the Software without restriction, including without limitation the rights cannam@49: // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell cannam@49: // copies of the Software, and to permit persons to whom the Software is cannam@49: // furnished to do so, subject to the following conditions: cannam@49: // cannam@49: // The above copyright notice and this permission notice shall be included in cannam@49: // all copies or substantial portions of the Software. cannam@49: // cannam@49: // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR cannam@49: // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, cannam@49: // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE cannam@49: // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER cannam@49: // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, cannam@49: // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN cannam@49: // THE SOFTWARE. cannam@49: cannam@49: #ifndef CAPNP_RPC_TWOPARTY_H_ cannam@49: #define CAPNP_RPC_TWOPARTY_H_ cannam@49: cannam@49: #if defined(__GNUC__) && !defined(CAPNP_HEADER_WARNINGS) cannam@49: #pragma GCC system_header cannam@49: #endif cannam@49: cannam@49: #include "rpc.h" cannam@49: #include "message.h" cannam@49: #include cannam@49: #include cannam@49: cannam@49: namespace capnp { cannam@49: cannam@49: namespace rpc { cannam@49: namespace twoparty { cannam@49: typedef VatId SturdyRefHostId; // For backwards-compatibility with version 0.4. cannam@49: } cannam@49: } cannam@49: cannam@49: typedef VatNetwork cannam@49: TwoPartyVatNetworkBase; cannam@49: cannam@49: class TwoPartyVatNetwork: public TwoPartyVatNetworkBase, cannam@49: private TwoPartyVatNetworkBase::Connection { cannam@49: // A `VatNetwork` that consists of exactly two parties communicating over an arbitrary byte cannam@49: // stream. This is used to implement the common case of a client/server network. cannam@49: // cannam@49: // See `ez-rpc.h` for a simple interface for setting up two-party clients and servers. cannam@49: // Use `TwoPartyVatNetwork` only if you need the advanced features. cannam@49: cannam@49: public: cannam@49: TwoPartyVatNetwork(kj::AsyncIoStream& stream, rpc::twoparty::Side side, cannam@49: ReaderOptions receiveOptions = ReaderOptions()); cannam@49: KJ_DISALLOW_COPY(TwoPartyVatNetwork); cannam@49: cannam@49: kj::Promise onDisconnect() { return disconnectPromise.addBranch(); } cannam@49: // Returns a promise that resolves when the peer disconnects. cannam@49: cannam@49: rpc::twoparty::Side getSide() { return side; } cannam@49: cannam@49: // implements VatNetwork ----------------------------------------------------- cannam@49: cannam@49: kj::Maybe> connect( cannam@49: rpc::twoparty::VatId::Reader ref) override; cannam@49: kj::Promise> accept() override; cannam@49: cannam@49: private: cannam@49: class OutgoingMessageImpl; cannam@49: class IncomingMessageImpl; cannam@49: cannam@49: kj::AsyncIoStream& stream; cannam@49: rpc::twoparty::Side side; cannam@49: MallocMessageBuilder peerVatId; cannam@49: ReaderOptions receiveOptions; cannam@49: bool accepted = false; cannam@49: cannam@49: kj::Maybe> previousWrite; cannam@49: // Resolves when the previous write completes. This effectively serves as the write queue. cannam@49: // Becomes null when shutdown() is called. cannam@49: cannam@49: kj::Own>> acceptFulfiller; cannam@49: // Fulfiller for the promise returned by acceptConnectionAsRefHost() on the client side, or the cannam@49: // second call on the server side. Never fulfilled, because there is only one connection. cannam@49: cannam@49: kj::ForkedPromise disconnectPromise = nullptr; cannam@49: cannam@49: class FulfillerDisposer: public kj::Disposer { cannam@49: // Hack: TwoPartyVatNetwork is both a VatNetwork and a VatNetwork::Connection. When the RPC cannam@49: // system detects (or initiates) a disconnection, it drops its reference to the Connection. cannam@49: // When all references have been dropped, then we want disconnectPromise to be fulfilled. cannam@49: // So we hand out Owns with this disposer attached, so that we can detect when cannam@49: // they are dropped. cannam@49: cannam@49: public: cannam@49: mutable kj::Own> fulfiller; cannam@49: mutable uint refcount = 0; cannam@49: cannam@49: void disposeImpl(void* pointer) const override; cannam@49: }; cannam@49: FulfillerDisposer disconnectFulfiller; cannam@49: cannam@49: kj::Own asConnection(); cannam@49: // Returns a pointer to this with the disposer set to disconnectFulfiller. cannam@49: cannam@49: // implements Connection ----------------------------------------------------- cannam@49: cannam@49: rpc::twoparty::VatId::Reader getPeerVatId() override; cannam@49: kj::Own newOutgoingMessage(uint firstSegmentWordSize) override; cannam@49: kj::Promise>> receiveIncomingMessage() override; cannam@49: kj::Promise shutdown() override; cannam@49: }; cannam@49: cannam@49: class TwoPartyServer: private kj::TaskSet::ErrorHandler { cannam@49: // Convenience class which implements a simple server which accepts connections on a listener cannam@49: // socket and serices them as two-party connections. cannam@49: cannam@49: public: cannam@49: explicit TwoPartyServer(Capability::Client bootstrapInterface); cannam@49: cannam@49: void accept(kj::Own&& connection); cannam@49: // Accepts the connection for servicing. cannam@49: cannam@49: kj::Promise listen(kj::ConnectionReceiver& listener); cannam@49: // Listens for connections on the given listener. The returned promise never resolves unless an cannam@49: // exception is thrown while trying to accept. You may discard the returned promise to cancel cannam@49: // listening. cannam@49: cannam@49: private: cannam@49: Capability::Client bootstrapInterface; cannam@49: kj::TaskSet tasks; cannam@49: cannam@49: struct AcceptedConnection; cannam@49: cannam@49: void taskFailed(kj::Exception&& exception) override; cannam@49: }; cannam@49: cannam@49: class TwoPartyClient { cannam@49: // Convenience class which implements a simple client. cannam@49: cannam@49: public: cannam@49: explicit TwoPartyClient(kj::AsyncIoStream& connection); cannam@49: TwoPartyClient(kj::AsyncIoStream& connection, Capability::Client bootstrapInterface, cannam@49: rpc::twoparty::Side side = rpc::twoparty::Side::CLIENT); cannam@49: cannam@49: Capability::Client bootstrap(); cannam@49: // Get the server's bootstrap interface. cannam@49: cannam@49: inline kj::Promise onDisconnect() { return network.onDisconnect(); } cannam@49: cannam@49: private: cannam@49: TwoPartyVatNetwork network; cannam@49: RpcSystem rpcSystem; cannam@49: }; cannam@49: cannam@49: } // namespace capnp cannam@49: cannam@49: #endif // CAPNP_RPC_TWOPARTY_H_