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: // This file contains a bunch of internal declarations that must appear before rpc.h can start.
cannam@49: // We don't define these directly in rpc.h because it makes the file hard to read.
cannam@49: 
cannam@49: #ifndef CAPNP_RPC_PRELUDE_H_
cannam@49: #define CAPNP_RPC_PRELUDE_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 "capability.h"
cannam@49: #include "persistent.capnp.h"
cannam@49: 
cannam@49: namespace capnp {
cannam@49: 
cannam@49: class OutgoingRpcMessage;
cannam@49: class IncomingRpcMessage;
cannam@49: 
cannam@49: template <typename SturdyRefHostId>
cannam@49: class RpcSystem;
cannam@49: 
cannam@49: namespace _ {  // private
cannam@49: 
cannam@49: class VatNetworkBase {
cannam@49:   // Non-template version of VatNetwork.  Ignore this class; see VatNetwork in rpc.h.
cannam@49: 
cannam@49: public:
cannam@49:   class Connection;
cannam@49: 
cannam@49:   struct ConnectionAndProvisionId {
cannam@49:     kj::Own<Connection> connection;
cannam@49:     kj::Own<OutgoingRpcMessage> firstMessage;
cannam@49:     Orphan<AnyPointer> provisionId;
cannam@49:   };
cannam@49: 
cannam@49:   class Connection {
cannam@49:   public:
cannam@49:     virtual kj::Own<OutgoingRpcMessage> newOutgoingMessage(uint firstSegmentWordSize) = 0;
cannam@49:     virtual kj::Promise<kj::Maybe<kj::Own<IncomingRpcMessage>>> receiveIncomingMessage() = 0;
cannam@49:     virtual kj::Promise<void> shutdown() = 0;
cannam@49:     virtual AnyStruct::Reader baseGetPeerVatId() = 0;
cannam@49:   };
cannam@49:   virtual kj::Maybe<kj::Own<Connection>> baseConnect(AnyStruct::Reader vatId) = 0;
cannam@49:   virtual kj::Promise<kj::Own<Connection>> baseAccept() = 0;
cannam@49: };
cannam@49: 
cannam@49: class SturdyRefRestorerBase {
cannam@49: public:
cannam@49:   virtual Capability::Client baseRestore(AnyPointer::Reader ref) = 0;
cannam@49: };
cannam@49: 
cannam@49: class BootstrapFactoryBase {
cannam@49:   // Non-template version of BootstrapFactory.  Ignore this class; see BootstrapFactory in rpc.h.
cannam@49: public:
cannam@49:   virtual Capability::Client baseCreateFor(AnyStruct::Reader clientId) = 0;
cannam@49: };
cannam@49: 
cannam@49: class RpcSystemBase {
cannam@49:   // Non-template version of RpcSystem.  Ignore this class; see RpcSystem in rpc.h.
cannam@49: 
cannam@49: public:
cannam@49:   RpcSystemBase(VatNetworkBase& network, kj::Maybe<Capability::Client> bootstrapInterface,
cannam@49:                 kj::Maybe<RealmGateway<>::Client> gateway);
cannam@49:   RpcSystemBase(VatNetworkBase& network, BootstrapFactoryBase& bootstrapFactory,
cannam@49:                 kj::Maybe<RealmGateway<>::Client> gateway);
cannam@49:   RpcSystemBase(VatNetworkBase& network, SturdyRefRestorerBase& restorer);
cannam@49:   RpcSystemBase(RpcSystemBase&& other) noexcept;
cannam@49:   ~RpcSystemBase() noexcept(false);
cannam@49: 
cannam@49: private:
cannam@49:   class Impl;
cannam@49:   kj::Own<Impl> impl;
cannam@49: 
cannam@49:   Capability::Client baseBootstrap(AnyStruct::Reader vatId);
cannam@49:   Capability::Client baseRestore(AnyStruct::Reader vatId, AnyPointer::Reader objectId);
cannam@49:   void baseSetFlowLimit(size_t words);
cannam@49: 
cannam@49:   template <typename>
cannam@49:   friend class capnp::RpcSystem;
cannam@49: };
cannam@49: 
cannam@49: template <typename T> struct InternalRefFromRealmGateway_;
cannam@49: template <typename InternalRef, typename ExternalRef, typename InternalOwner,
cannam@49:           typename ExternalOwner>
cannam@49: struct InternalRefFromRealmGateway_<RealmGateway<InternalRef, ExternalRef, InternalOwner,
cannam@49:                                     ExternalOwner>> {
cannam@49:   typedef InternalRef Type;
cannam@49: };
cannam@49: template <typename T>
cannam@49: using InternalRefFromRealmGateway = typename InternalRefFromRealmGateway_<T>::Type;
cannam@49: template <typename T>
cannam@49: using InternalRefFromRealmGatewayClient = InternalRefFromRealmGateway<typename T::Calls>;
cannam@49: 
cannam@49: template <typename T> struct ExternalRefFromRealmGateway_;
cannam@49: template <typename InternalRef, typename ExternalRef, typename InternalOwner,
cannam@49:           typename ExternalOwner>
cannam@49: struct ExternalRefFromRealmGateway_<RealmGateway<InternalRef, ExternalRef, InternalOwner,
cannam@49:                                     ExternalOwner>> {
cannam@49:   typedef ExternalRef Type;
cannam@49: };
cannam@49: template <typename T>
cannam@49: using ExternalRefFromRealmGateway = typename ExternalRefFromRealmGateway_<T>::Type;
cannam@49: template <typename T>
cannam@49: using ExternalRefFromRealmGatewayClient = ExternalRefFromRealmGateway<typename T::Calls>;
cannam@49: 
cannam@49: }  // namespace _ (private)
cannam@49: }  // namespace capnp
cannam@49: 
cannam@49: #endif  // CAPNP_RPC_PRELUDE_H_