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