annotate win32-mingw/include/capnp/rpc.h @ 169:223a55898ab9 tip default

Add null config files
author Chris Cannam <cannam@all-day-breakfast.com>
date Mon, 02 Mar 2020 14:03:47 +0000
parents 279b18cc7785
children
rev   line source
cannam@149 1 // Copyright (c) 2013-2014 Sandstorm Development Group, Inc. and contributors
cannam@149 2 // Licensed under the MIT License:
cannam@149 3 //
cannam@149 4 // Permission is hereby granted, free of charge, to any person obtaining a copy
cannam@149 5 // of this software and associated documentation files (the "Software"), to deal
cannam@149 6 // in the Software without restriction, including without limitation the rights
cannam@149 7 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
cannam@149 8 // copies of the Software, and to permit persons to whom the Software is
cannam@149 9 // furnished to do so, subject to the following conditions:
cannam@149 10 //
cannam@149 11 // The above copyright notice and this permission notice shall be included in
cannam@149 12 // all copies or substantial portions of the Software.
cannam@149 13 //
cannam@149 14 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
cannam@149 15 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
cannam@149 16 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
cannam@149 17 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
cannam@149 18 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
cannam@149 19 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
cannam@149 20 // THE SOFTWARE.
cannam@149 21
cannam@149 22 #ifndef CAPNP_RPC_H_
cannam@149 23 #define CAPNP_RPC_H_
cannam@149 24
cannam@149 25 #if defined(__GNUC__) && !defined(CAPNP_HEADER_WARNINGS)
cannam@149 26 #pragma GCC system_header
cannam@149 27 #endif
cannam@149 28
cannam@149 29 #include "capability.h"
cannam@149 30 #include "rpc-prelude.h"
cannam@149 31
cannam@149 32 namespace capnp {
cannam@149 33
cannam@149 34 template <typename VatId, typename ProvisionId, typename RecipientId,
cannam@149 35 typename ThirdPartyCapId, typename JoinResult>
cannam@149 36 class VatNetwork;
cannam@149 37 template <typename SturdyRefObjectId>
cannam@149 38 class SturdyRefRestorer;
cannam@149 39
cannam@149 40 template <typename VatId>
cannam@149 41 class BootstrapFactory: public _::BootstrapFactoryBase {
cannam@149 42 // Interface that constructs per-client bootstrap interfaces. Use this if you want each client
cannam@149 43 // who connects to see a different bootstrap interface based on their (authenticated) VatId.
cannam@149 44 // This allows an application to bootstrap off of the authentication performed at the VatNetwork
cannam@149 45 // level. (Typically VatId is some sort of public key.)
cannam@149 46 //
cannam@149 47 // This is only useful for multi-party networks. For TwoPartyVatNetwork, there's no reason to
cannam@149 48 // use a BootstrapFactory; just specify a single bootstrap capability in this case.
cannam@149 49
cannam@149 50 public:
cannam@149 51 virtual Capability::Client createFor(typename VatId::Reader clientId) = 0;
cannam@149 52 // Create a bootstrap capability appropriate for exposing to the given client. VatNetwork will
cannam@149 53 // have authenticated the client VatId before this is called.
cannam@149 54
cannam@149 55 private:
cannam@149 56 Capability::Client baseCreateFor(AnyStruct::Reader clientId) override;
cannam@149 57 };
cannam@149 58
cannam@149 59 template <typename VatId>
cannam@149 60 class RpcSystem: public _::RpcSystemBase {
cannam@149 61 // Represents the RPC system, which is the portal to objects available on the network.
cannam@149 62 //
cannam@149 63 // The RPC implementation sits on top of an implementation of `VatNetwork`. The `VatNetwork`
cannam@149 64 // determines how to form connections between vats -- specifically, two-way, private, reliable,
cannam@149 65 // sequenced datagram connections. The RPC implementation determines how to use such connections
cannam@149 66 // to manage object references and make method calls.
cannam@149 67 //
cannam@149 68 // See `makeRpcServer()` and `makeRpcClient()` below for convenient syntax for setting up an
cannam@149 69 // `RpcSystem` given a `VatNetwork`.
cannam@149 70 //
cannam@149 71 // See `ez-rpc.h` for an even simpler interface for setting up RPC in a typical two-party
cannam@149 72 // client/server scenario.
cannam@149 73
cannam@149 74 public:
cannam@149 75 template <typename ProvisionId, typename RecipientId,
cannam@149 76 typename ThirdPartyCapId, typename JoinResult>
cannam@149 77 RpcSystem(
cannam@149 78 VatNetwork<VatId, ProvisionId, RecipientId, ThirdPartyCapId, JoinResult>& network,
cannam@149 79 kj::Maybe<Capability::Client> bootstrapInterface,
cannam@149 80 kj::Maybe<RealmGateway<>::Client> gateway = nullptr);
cannam@149 81
cannam@149 82 template <typename ProvisionId, typename RecipientId,
cannam@149 83 typename ThirdPartyCapId, typename JoinResult>
cannam@149 84 RpcSystem(
cannam@149 85 VatNetwork<VatId, ProvisionId, RecipientId, ThirdPartyCapId, JoinResult>& network,
cannam@149 86 BootstrapFactory<VatId>& bootstrapFactory,
cannam@149 87 kj::Maybe<RealmGateway<>::Client> gateway = nullptr);
cannam@149 88
cannam@149 89 template <typename ProvisionId, typename RecipientId,
cannam@149 90 typename ThirdPartyCapId, typename JoinResult,
cannam@149 91 typename LocalSturdyRefObjectId>
cannam@149 92 RpcSystem(
cannam@149 93 VatNetwork<VatId, ProvisionId, RecipientId, ThirdPartyCapId, JoinResult>& network,
cannam@149 94 SturdyRefRestorer<LocalSturdyRefObjectId>& restorer);
cannam@149 95
cannam@149 96 RpcSystem(RpcSystem&& other) = default;
cannam@149 97
cannam@149 98 Capability::Client bootstrap(typename VatId::Reader vatId);
cannam@149 99 // Connect to the given vat and return its bootstrap interface.
cannam@149 100
cannam@149 101 Capability::Client restore(typename VatId::Reader hostId, AnyPointer::Reader objectId)
cannam@149 102 KJ_DEPRECATED("Please transition to using a bootstrap interface instead.");
cannam@149 103 // ** DEPRECATED **
cannam@149 104 //
cannam@149 105 // Restores the given SturdyRef from the network and return the capability representing it.
cannam@149 106 //
cannam@149 107 // `hostId` identifies the host from which to request the ref, in the format specified by the
cannam@149 108 // `VatNetwork` in use. `objectId` is the object ID in whatever format is expected by said host.
cannam@149 109 //
cannam@149 110 // This method will be removed in a future version of Cap'n Proto. Instead, please transition
cannam@149 111 // to using bootstrap(), which is equivalent to calling restore() with a null `objectId`.
cannam@149 112 // You may emulate the old concept of object IDs by exporting a bootstrap interface which has
cannam@149 113 // methods that can be used to obtain other capabilities by ID.
cannam@149 114
cannam@149 115 void setFlowLimit(size_t words);
cannam@149 116 // Sets the incoming call flow limit. If more than `words` worth of call messages have not yet
cannam@149 117 // received responses, the RpcSystem will not read further messages from the stream. This can be
cannam@149 118 // used as a crude way to prevent a resource exhaustion attack (or bug) in which a peer makes an
cannam@149 119 // excessive number of simultaneous calls that consume the receiver's RAM.
cannam@149 120 //
cannam@149 121 // There are some caveats. When over the flow limit, all messages are blocked, including returns.
cannam@149 122 // If the outstanding calls are themselves waiting on calls going in the opposite direction, the
cannam@149 123 // flow limit may prevent those calls from completing, leading to deadlock. However, a
cannam@149 124 // sufficiently high limit should make this unlikely.
cannam@149 125 //
cannam@149 126 // Note that a call's parameter size counts against the flow limit until the call returns, even
cannam@149 127 // if the recipient calls releaseParams() to free the parameter memory early. This is because
cannam@149 128 // releaseParams() may simply indicate that the parameters have been forwarded to another
cannam@149 129 // machine, but are still in-memory there. For illustration, say that Alice made a call to Bob
cannam@149 130 // who forwarded the call to Carol. Bob has imposed a flow limit on Alice. Alice's calls are
cannam@149 131 // being forwarded to Carol, so Bob never keeps the parameters in-memory for more than a brief
cannam@149 132 // period. However, the flow limit counts all calls that haven't returned, even if Bob has
cannam@149 133 // already freed the memory they consumed. You might argue that the right solution here is
cannam@149 134 // instead for Carol to impose her own flow limit on Bob. This has a serious problem, though:
cannam@149 135 // Bob might be forwarding requests to Carol on behalf of many different parties, not just Alice.
cannam@149 136 // If Alice can pump enough data to hit the Bob -> Carol flow limit, then those other parties
cannam@149 137 // will be disrupted. Thus, we can only really impose the limit on the Alice -> Bob link, which
cannam@149 138 // only affects Alice. We need that one flow limit to limit Alice's impact on the whole system,
cannam@149 139 // so it has to count all in-flight calls.
cannam@149 140 //
cannam@149 141 // In Sandstorm, flow limits are imposed by the supervisor on calls coming out of a grain, in
cannam@149 142 // order to prevent a grain from inundating the system with in-flight calls. In practice, the
cannam@149 143 // main time this happens is when a grain is pushing a large file download and doesn't implement
cannam@149 144 // proper cooperative flow control.
cannam@149 145 };
cannam@149 146
cannam@149 147 template <typename VatId, typename ProvisionId, typename RecipientId,
cannam@149 148 typename ThirdPartyCapId, typename JoinResult>
cannam@149 149 RpcSystem<VatId> makeRpcServer(
cannam@149 150 VatNetwork<VatId, ProvisionId, RecipientId, ThirdPartyCapId, JoinResult>& network,
cannam@149 151 Capability::Client bootstrapInterface);
cannam@149 152 // Make an RPC server. Typical usage (e.g. in a main() function):
cannam@149 153 //
cannam@149 154 // MyEventLoop eventLoop;
cannam@149 155 // kj::WaitScope waitScope(eventLoop);
cannam@149 156 // MyNetwork network;
cannam@149 157 // MyMainInterface::Client bootstrap = makeMain();
cannam@149 158 // auto server = makeRpcServer(network, bootstrap);
cannam@149 159 // kj::NEVER_DONE.wait(waitScope); // run forever
cannam@149 160 //
cannam@149 161 // See also ez-rpc.h, which has simpler instructions for the common case of a two-party
cannam@149 162 // client-server RPC connection.
cannam@149 163
cannam@149 164 template <typename VatId, typename ProvisionId, typename RecipientId,
cannam@149 165 typename ThirdPartyCapId, typename JoinResult, typename RealmGatewayClient,
cannam@149 166 typename InternalRef = _::InternalRefFromRealmGatewayClient<RealmGatewayClient>,
cannam@149 167 typename ExternalRef = _::ExternalRefFromRealmGatewayClient<RealmGatewayClient>>
cannam@149 168 RpcSystem<VatId> makeRpcServer(
cannam@149 169 VatNetwork<VatId, ProvisionId, RecipientId, ThirdPartyCapId, JoinResult>& network,
cannam@149 170 Capability::Client bootstrapInterface, RealmGatewayClient gateway);
cannam@149 171 // Make an RPC server for a VatNetwork that resides in a different realm from the application.
cannam@149 172 // The given RealmGateway is used to translate SturdyRefs between the app's ("internal") format
cannam@149 173 // and the network's ("external") format.
cannam@149 174
cannam@149 175 template <typename VatId, typename ProvisionId, typename RecipientId,
cannam@149 176 typename ThirdPartyCapId, typename JoinResult>
cannam@149 177 RpcSystem<VatId> makeRpcServer(
cannam@149 178 VatNetwork<VatId, ProvisionId, RecipientId, ThirdPartyCapId, JoinResult>& network,
cannam@149 179 BootstrapFactory<VatId>& bootstrapFactory);
cannam@149 180 // Make an RPC server that can serve different bootstrap interfaces to different clients via a
cannam@149 181 // BootstrapInterface.
cannam@149 182
cannam@149 183 template <typename VatId, typename ProvisionId, typename RecipientId,
cannam@149 184 typename ThirdPartyCapId, typename JoinResult, typename RealmGatewayClient,
cannam@149 185 typename InternalRef = _::InternalRefFromRealmGatewayClient<RealmGatewayClient>,
cannam@149 186 typename ExternalRef = _::ExternalRefFromRealmGatewayClient<RealmGatewayClient>>
cannam@149 187 RpcSystem<VatId> makeRpcServer(
cannam@149 188 VatNetwork<VatId, ProvisionId, RecipientId, ThirdPartyCapId, JoinResult>& network,
cannam@149 189 BootstrapFactory<VatId>& bootstrapFactory, RealmGatewayClient gateway);
cannam@149 190 // Make an RPC server that can serve different bootstrap interfaces to different clients via a
cannam@149 191 // BootstrapInterface and communicates with a different realm than the application is in via a
cannam@149 192 // RealmGateway.
cannam@149 193
cannam@149 194 template <typename VatId, typename LocalSturdyRefObjectId,
cannam@149 195 typename ProvisionId, typename RecipientId, typename ThirdPartyCapId, typename JoinResult>
cannam@149 196 RpcSystem<VatId> makeRpcServer(
cannam@149 197 VatNetwork<VatId, ProvisionId, RecipientId, ThirdPartyCapId, JoinResult>& network,
cannam@149 198 SturdyRefRestorer<LocalSturdyRefObjectId>& restorer)
cannam@149 199 KJ_DEPRECATED("Please transition to using a bootstrap interface instead.");
cannam@149 200 // ** DEPRECATED **
cannam@149 201 //
cannam@149 202 // Create an RPC server which exports multiple main interfaces by object ID. The `restorer` object
cannam@149 203 // can be used to look up objects by ID.
cannam@149 204 //
cannam@149 205 // Please transition to exporting only one interface, which is known as the "bootstrap" interface.
cannam@149 206 // For backwards-compatibility with old clients, continue to implement SturdyRefRestorer, but
cannam@149 207 // return the new bootstrap interface when the request object ID is null. When new clients connect
cannam@149 208 // and request the bootstrap interface, they will get that interface. Eventually, once all clients
cannam@149 209 // are updated to request only the bootstrap interface, stop implementing SturdyRefRestorer and
cannam@149 210 // switch to passing the bootstrap capability itself as the second parameter to `makeRpcServer()`.
cannam@149 211
cannam@149 212 template <typename VatId, typename ProvisionId,
cannam@149 213 typename RecipientId, typename ThirdPartyCapId, typename JoinResult>
cannam@149 214 RpcSystem<VatId> makeRpcClient(
cannam@149 215 VatNetwork<VatId, ProvisionId, RecipientId, ThirdPartyCapId, JoinResult>& network);
cannam@149 216 // Make an RPC client. Typical usage (e.g. in a main() function):
cannam@149 217 //
cannam@149 218 // MyEventLoop eventLoop;
cannam@149 219 // kj::WaitScope waitScope(eventLoop);
cannam@149 220 // MyNetwork network;
cannam@149 221 // auto client = makeRpcClient(network);
cannam@149 222 // MyCapability::Client cap = client.restore(hostId, objId).castAs<MyCapability>();
cannam@149 223 // auto response = cap.fooRequest().send().wait(waitScope);
cannam@149 224 // handleMyResponse(response);
cannam@149 225 //
cannam@149 226 // See also ez-rpc.h, which has simpler instructions for the common case of a two-party
cannam@149 227 // client-server RPC connection.
cannam@149 228
cannam@149 229 template <typename VatId, typename ProvisionId, typename RecipientId,
cannam@149 230 typename ThirdPartyCapId, typename JoinResult, typename RealmGatewayClient,
cannam@149 231 typename InternalRef = _::InternalRefFromRealmGatewayClient<RealmGatewayClient>,
cannam@149 232 typename ExternalRef = _::ExternalRefFromRealmGatewayClient<RealmGatewayClient>>
cannam@149 233 RpcSystem<VatId> makeRpcClient(
cannam@149 234 VatNetwork<VatId, ProvisionId, RecipientId, ThirdPartyCapId, JoinResult>& network,
cannam@149 235 RealmGatewayClient gateway);
cannam@149 236 // Make an RPC client for a VatNetwork that resides in a different realm from the application.
cannam@149 237 // The given RealmGateway is used to translate SturdyRefs between the app's ("internal") format
cannam@149 238 // and the network's ("external") format.
cannam@149 239
cannam@149 240 template <typename SturdyRefObjectId>
cannam@149 241 class SturdyRefRestorer: public _::SturdyRefRestorerBase {
cannam@149 242 // ** DEPRECATED **
cannam@149 243 //
cannam@149 244 // In Cap'n Proto 0.4.x, applications could export multiple main interfaces identified by
cannam@149 245 // object IDs. The callback used to map object IDs to objects was `SturdyRefRestorer`, as we
cannam@149 246 // imagined this would eventually be used for restoring SturdyRefs as well. In practice, it was
cannam@149 247 // never used for real SturdyRefs, only for exporting singleton objects under well-known names.
cannam@149 248 //
cannam@149 249 // The new preferred strategy is to export only a _single_ such interface, called the
cannam@149 250 // "bootstrap interface". That interface can itself have methods for obtaining other objects, of
cannam@149 251 // course, but that is up to the app. `SturdyRefRestorer` exists for backwards-compatibility.
cannam@149 252 //
cannam@149 253 // Hint: Use SturdyRefRestorer<capnp::Text> to define a server that exports services under
cannam@149 254 // string names.
cannam@149 255
cannam@149 256 public:
cannam@149 257 virtual Capability::Client restore(typename SturdyRefObjectId::Reader ref)
cannam@149 258 KJ_DEPRECATED(
cannam@149 259 "Please transition to using bootstrap interfaces instead of SturdyRefRestorer.") = 0;
cannam@149 260 // Restore the given object, returning a capability representing it.
cannam@149 261
cannam@149 262 private:
cannam@149 263 Capability::Client baseRestore(AnyPointer::Reader ref) override final;
cannam@149 264 };
cannam@149 265
cannam@149 266 // =======================================================================================
cannam@149 267 // VatNetwork
cannam@149 268
cannam@149 269 class OutgoingRpcMessage {
cannam@149 270 // A message to be sent by a `VatNetwork`.
cannam@149 271
cannam@149 272 public:
cannam@149 273 virtual AnyPointer::Builder getBody() = 0;
cannam@149 274 // Get the message body, which the caller may fill in any way it wants. (The standard RPC
cannam@149 275 // implementation initializes it as a Message as defined in rpc.capnp.)
cannam@149 276
cannam@149 277 virtual void send() = 0;
cannam@149 278 // Send the message, or at least put it in a queue to be sent later. Note that the builder
cannam@149 279 // returned by `getBody()` remains valid at least until the `OutgoingRpcMessage` is destroyed.
cannam@149 280 };
cannam@149 281
cannam@149 282 class IncomingRpcMessage {
cannam@149 283 // A message received from a `VatNetwork`.
cannam@149 284
cannam@149 285 public:
cannam@149 286 virtual AnyPointer::Reader getBody() = 0;
cannam@149 287 // Get the message body, to be interpreted by the caller. (The standard RPC implementation
cannam@149 288 // interprets it as a Message as defined in rpc.capnp.)
cannam@149 289 };
cannam@149 290
cannam@149 291 template <typename VatId, typename ProvisionId, typename RecipientId,
cannam@149 292 typename ThirdPartyCapId, typename JoinResult>
cannam@149 293 class VatNetwork: public _::VatNetworkBase {
cannam@149 294 // Cap'n Proto RPC operates between vats, where a "vat" is some sort of host of objects.
cannam@149 295 // Typically one Cap'n Proto process (in the Unix sense) is one vat. The RPC system is what
cannam@149 296 // allows calls between objects hosted in different vats.
cannam@149 297 //
cannam@149 298 // The RPC implementation sits on top of an implementation of `VatNetwork`. The `VatNetwork`
cannam@149 299 // determines how to form connections between vats -- specifically, two-way, private, reliable,
cannam@149 300 // sequenced datagram connections. The RPC implementation determines how to use such connections
cannam@149 301 // to manage object references and make method calls.
cannam@149 302 //
cannam@149 303 // The most common implementation of VatNetwork is TwoPartyVatNetwork (rpc-twoparty.h). Most
cannam@149 304 // simple client-server apps will want to use it. (You may even want to use the EZ RPC
cannam@149 305 // interfaces in `ez-rpc.h` and avoid all of this.)
cannam@149 306 //
cannam@149 307 // TODO(someday): Provide a standard implementation for the public internet.
cannam@149 308
cannam@149 309 public:
cannam@149 310 class Connection;
cannam@149 311
cannam@149 312 struct ConnectionAndProvisionId {
cannam@149 313 // Result of connecting to a vat introduced by another vat.
cannam@149 314
cannam@149 315 kj::Own<Connection> connection;
cannam@149 316 // Connection to the new vat.
cannam@149 317
cannam@149 318 kj::Own<OutgoingRpcMessage> firstMessage;
cannam@149 319 // An already-allocated `OutgoingRpcMessage` associated with `connection`. The RPC system will
cannam@149 320 // construct this as an `Accept` message and send it.
cannam@149 321
cannam@149 322 Orphan<ProvisionId> provisionId;
cannam@149 323 // A `ProvisionId` already allocated inside `firstMessage`, which the RPC system will use to
cannam@149 324 // build the `Accept` message.
cannam@149 325 };
cannam@149 326
cannam@149 327 class Connection: public _::VatNetworkBase::Connection {
cannam@149 328 // A two-way RPC connection.
cannam@149 329 //
cannam@149 330 // This object may represent a connection that doesn't exist yet, but is expected to exist
cannam@149 331 // in the future. In this case, sent messages will automatically be queued and sent once the
cannam@149 332 // connection is ready, so that the caller doesn't need to know the difference.
cannam@149 333
cannam@149 334 public:
cannam@149 335 // Level 0 features ----------------------------------------------
cannam@149 336
cannam@149 337 virtual typename VatId::Reader getPeerVatId() = 0;
cannam@149 338 // Returns the connected vat's authenticated VatId. It is the VatNetwork's responsibility to
cannam@149 339 // authenticate this, so that the caller can be assured that they are really talking to the
cannam@149 340 // identified vat and not an imposter.
cannam@149 341
cannam@149 342 virtual kj::Own<OutgoingRpcMessage> newOutgoingMessage(uint firstSegmentWordSize) override = 0;
cannam@149 343 // Allocate a new message to be sent on this connection.
cannam@149 344 //
cannam@149 345 // If `firstSegmentWordSize` is non-zero, it should be treated as a hint suggesting how large
cannam@149 346 // to make the first segment. This is entirely a hint and the connection may adjust it up or
cannam@149 347 // down. If it is zero, the connection should choose the size itself.
cannam@149 348
cannam@149 349 virtual kj::Promise<kj::Maybe<kj::Own<IncomingRpcMessage>>> receiveIncomingMessage() override = 0;
cannam@149 350 // Wait for a message to be received and return it. If the read stream cleanly terminates,
cannam@149 351 // return null. If any other problem occurs, throw an exception.
cannam@149 352
cannam@149 353 virtual kj::Promise<void> shutdown() override KJ_WARN_UNUSED_RESULT = 0;
cannam@149 354 // Waits until all outgoing messages have been sent, then shuts down the outgoing stream. The
cannam@149 355 // returned promise resolves after shutdown is complete.
cannam@149 356
cannam@149 357 private:
cannam@149 358 AnyStruct::Reader baseGetPeerVatId() override;
cannam@149 359 };
cannam@149 360
cannam@149 361 // Level 0 features ------------------------------------------------
cannam@149 362
cannam@149 363 virtual kj::Maybe<kj::Own<Connection>> connect(typename VatId::Reader hostId) = 0;
cannam@149 364 // Connect to a VatId. Note that this method immediately returns a `Connection`, even
cannam@149 365 // if the network connection has not yet been established. Messages can be queued to this
cannam@149 366 // connection and will be delivered once it is open. The caller must attempt to read from the
cannam@149 367 // connection to verify that it actually succeeded; the read will fail if the connection
cannam@149 368 // couldn't be opened. Some network implementations may actually start sending messages before
cannam@149 369 // hearing back from the server at all, to avoid a round trip.
cannam@149 370 //
cannam@149 371 // Returns nullptr if `hostId` refers to the local host.
cannam@149 372
cannam@149 373 virtual kj::Promise<kj::Own<Connection>> accept() = 0;
cannam@149 374 // Wait for the next incoming connection and return it.
cannam@149 375
cannam@149 376 // Level 4 features ------------------------------------------------
cannam@149 377 // TODO(someday)
cannam@149 378
cannam@149 379 private:
cannam@149 380 kj::Maybe<kj::Own<_::VatNetworkBase::Connection>>
cannam@149 381 baseConnect(AnyStruct::Reader hostId) override final;
cannam@149 382 kj::Promise<kj::Own<_::VatNetworkBase::Connection>> baseAccept() override final;
cannam@149 383 };
cannam@149 384
cannam@149 385 // =======================================================================================
cannam@149 386 // ***************************************************************************************
cannam@149 387 // Inline implementation details start here
cannam@149 388 // ***************************************************************************************
cannam@149 389 // =======================================================================================
cannam@149 390
cannam@149 391 template <typename VatId>
cannam@149 392 Capability::Client BootstrapFactory<VatId>::baseCreateFor(AnyStruct::Reader clientId) {
cannam@149 393 return createFor(clientId.as<VatId>());
cannam@149 394 }
cannam@149 395
cannam@149 396 template <typename SturdyRef, typename ProvisionId, typename RecipientId,
cannam@149 397 typename ThirdPartyCapId, typename JoinResult>
cannam@149 398 kj::Maybe<kj::Own<_::VatNetworkBase::Connection>>
cannam@149 399 VatNetwork<SturdyRef, ProvisionId, RecipientId, ThirdPartyCapId, JoinResult>::
cannam@149 400 baseConnect(AnyStruct::Reader ref) {
cannam@149 401 auto maybe = connect(ref.as<SturdyRef>());
cannam@149 402 return maybe.map([](kj::Own<Connection>& conn) -> kj::Own<_::VatNetworkBase::Connection> {
cannam@149 403 return kj::mv(conn);
cannam@149 404 });
cannam@149 405 }
cannam@149 406
cannam@149 407 template <typename SturdyRef, typename ProvisionId, typename RecipientId,
cannam@149 408 typename ThirdPartyCapId, typename JoinResult>
cannam@149 409 kj::Promise<kj::Own<_::VatNetworkBase::Connection>>
cannam@149 410 VatNetwork<SturdyRef, ProvisionId, RecipientId, ThirdPartyCapId, JoinResult>::baseAccept() {
cannam@149 411 return accept().then(
cannam@149 412 [](kj::Own<Connection>&& connection) -> kj::Own<_::VatNetworkBase::Connection> {
cannam@149 413 return kj::mv(connection);
cannam@149 414 });
cannam@149 415 }
cannam@149 416
cannam@149 417 template <typename SturdyRef, typename ProvisionId, typename RecipientId,
cannam@149 418 typename ThirdPartyCapId, typename JoinResult>
cannam@149 419 AnyStruct::Reader VatNetwork<
cannam@149 420 SturdyRef, ProvisionId, RecipientId, ThirdPartyCapId, JoinResult>::
cannam@149 421 Connection::baseGetPeerVatId() {
cannam@149 422 return getPeerVatId();
cannam@149 423 }
cannam@149 424
cannam@149 425 template <typename SturdyRef>
cannam@149 426 Capability::Client SturdyRefRestorer<SturdyRef>::baseRestore(AnyPointer::Reader ref) {
cannam@149 427 #pragma GCC diagnostic push
cannam@149 428 #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
cannam@149 429 return restore(ref.getAs<SturdyRef>());
cannam@149 430 #pragma GCC diagnostic pop
cannam@149 431 }
cannam@149 432
cannam@149 433 template <typename VatId>
cannam@149 434 template <typename ProvisionId, typename RecipientId,
cannam@149 435 typename ThirdPartyCapId, typename JoinResult>
cannam@149 436 RpcSystem<VatId>::RpcSystem(
cannam@149 437 VatNetwork<VatId, ProvisionId, RecipientId, ThirdPartyCapId, JoinResult>& network,
cannam@149 438 kj::Maybe<Capability::Client> bootstrap,
cannam@149 439 kj::Maybe<RealmGateway<>::Client> gateway)
cannam@149 440 : _::RpcSystemBase(network, kj::mv(bootstrap), kj::mv(gateway)) {}
cannam@149 441
cannam@149 442 template <typename VatId>
cannam@149 443 template <typename ProvisionId, typename RecipientId,
cannam@149 444 typename ThirdPartyCapId, typename JoinResult>
cannam@149 445 RpcSystem<VatId>::RpcSystem(
cannam@149 446 VatNetwork<VatId, ProvisionId, RecipientId, ThirdPartyCapId, JoinResult>& network,
cannam@149 447 BootstrapFactory<VatId>& bootstrapFactory,
cannam@149 448 kj::Maybe<RealmGateway<>::Client> gateway)
cannam@149 449 : _::RpcSystemBase(network, bootstrapFactory, kj::mv(gateway)) {}
cannam@149 450
cannam@149 451 template <typename VatId>
cannam@149 452 template <typename ProvisionId, typename RecipientId,
cannam@149 453 typename ThirdPartyCapId, typename JoinResult,
cannam@149 454 typename LocalSturdyRefObjectId>
cannam@149 455 RpcSystem<VatId>::RpcSystem(
cannam@149 456 VatNetwork<VatId, ProvisionId, RecipientId, ThirdPartyCapId, JoinResult>& network,
cannam@149 457 SturdyRefRestorer<LocalSturdyRefObjectId>& restorer)
cannam@149 458 : _::RpcSystemBase(network, restorer) {}
cannam@149 459
cannam@149 460 template <typename VatId>
cannam@149 461 Capability::Client RpcSystem<VatId>::bootstrap(typename VatId::Reader vatId) {
cannam@149 462 return baseBootstrap(_::PointerHelpers<VatId>::getInternalReader(vatId));
cannam@149 463 }
cannam@149 464
cannam@149 465 template <typename VatId>
cannam@149 466 Capability::Client RpcSystem<VatId>::restore(
cannam@149 467 typename VatId::Reader hostId, AnyPointer::Reader objectId) {
cannam@149 468 return baseRestore(_::PointerHelpers<VatId>::getInternalReader(hostId), objectId);
cannam@149 469 }
cannam@149 470
cannam@149 471 template <typename VatId>
cannam@149 472 inline void RpcSystem<VatId>::setFlowLimit(size_t words) {
cannam@149 473 baseSetFlowLimit(words);
cannam@149 474 }
cannam@149 475
cannam@149 476 template <typename VatId, typename ProvisionId, typename RecipientId,
cannam@149 477 typename ThirdPartyCapId, typename JoinResult>
cannam@149 478 RpcSystem<VatId> makeRpcServer(
cannam@149 479 VatNetwork<VatId, ProvisionId, RecipientId, ThirdPartyCapId, JoinResult>& network,
cannam@149 480 Capability::Client bootstrapInterface) {
cannam@149 481 return RpcSystem<VatId>(network, kj::mv(bootstrapInterface));
cannam@149 482 }
cannam@149 483
cannam@149 484 template <typename VatId, typename ProvisionId, typename RecipientId,
cannam@149 485 typename ThirdPartyCapId, typename JoinResult,
cannam@149 486 typename RealmGatewayClient, typename InternalRef, typename ExternalRef>
cannam@149 487 RpcSystem<VatId> makeRpcServer(
cannam@149 488 VatNetwork<VatId, ProvisionId, RecipientId, ThirdPartyCapId, JoinResult>& network,
cannam@149 489 Capability::Client bootstrapInterface, RealmGatewayClient gateway) {
cannam@149 490 return RpcSystem<VatId>(network, kj::mv(bootstrapInterface),
cannam@149 491 gateway.template castAs<RealmGateway<>>());
cannam@149 492 }
cannam@149 493
cannam@149 494 template <typename VatId, typename ProvisionId, typename RecipientId,
cannam@149 495 typename ThirdPartyCapId, typename JoinResult>
cannam@149 496 RpcSystem<VatId> makeRpcServer(
cannam@149 497 VatNetwork<VatId, ProvisionId, RecipientId, ThirdPartyCapId, JoinResult>& network,
cannam@149 498 BootstrapFactory<VatId>& bootstrapFactory) {
cannam@149 499 return RpcSystem<VatId>(network, bootstrapFactory);
cannam@149 500 }
cannam@149 501
cannam@149 502 template <typename VatId, typename ProvisionId, typename RecipientId,
cannam@149 503 typename ThirdPartyCapId, typename JoinResult,
cannam@149 504 typename RealmGatewayClient, typename InternalRef, typename ExternalRef>
cannam@149 505 RpcSystem<VatId> makeRpcServer(
cannam@149 506 VatNetwork<VatId, ProvisionId, RecipientId, ThirdPartyCapId, JoinResult>& network,
cannam@149 507 BootstrapFactory<VatId>& bootstrapFactory, RealmGatewayClient gateway) {
cannam@149 508 return RpcSystem<VatId>(network, bootstrapFactory, gateway.template castAs<RealmGateway<>>());
cannam@149 509 }
cannam@149 510
cannam@149 511 template <typename VatId, typename LocalSturdyRefObjectId,
cannam@149 512 typename ProvisionId, typename RecipientId, typename ThirdPartyCapId, typename JoinResult>
cannam@149 513 RpcSystem<VatId> makeRpcServer(
cannam@149 514 VatNetwork<VatId, ProvisionId, RecipientId, ThirdPartyCapId, JoinResult>& network,
cannam@149 515 SturdyRefRestorer<LocalSturdyRefObjectId>& restorer) {
cannam@149 516 return RpcSystem<VatId>(network, restorer);
cannam@149 517 }
cannam@149 518
cannam@149 519 template <typename VatId, typename ProvisionId,
cannam@149 520 typename RecipientId, typename ThirdPartyCapId, typename JoinResult>
cannam@149 521 RpcSystem<VatId> makeRpcClient(
cannam@149 522 VatNetwork<VatId, ProvisionId, RecipientId, ThirdPartyCapId, JoinResult>& network) {
cannam@149 523 return RpcSystem<VatId>(network, nullptr);
cannam@149 524 }
cannam@149 525
cannam@149 526 template <typename VatId, typename ProvisionId,
cannam@149 527 typename RecipientId, typename ThirdPartyCapId, typename JoinResult,
cannam@149 528 typename RealmGatewayClient, typename InternalRef, typename ExternalRef>
cannam@149 529 RpcSystem<VatId> makeRpcClient(
cannam@149 530 VatNetwork<VatId, ProvisionId, RecipientId, ThirdPartyCapId, JoinResult>& network,
cannam@149 531 RealmGatewayClient gateway) {
cannam@149 532 return RpcSystem<VatId>(network, nullptr, gateway.template castAs<RealmGateway<>>());
cannam@149 533 }
cannam@149 534
cannam@149 535 } // namespace capnp
cannam@149 536
cannam@149 537 #endif // CAPNP_RPC_H_