comparison win64-msvc/include/capnp/serialize-async.h @ 47:d93140aac40b

Current Capnp libs and headers from git
author Chris Cannam
date Thu, 20 Oct 2016 18:15:38 +0100
parents
children 0f2d93caa50c
comparison
equal deleted inserted replaced
46:efe5b9f38b13 47:d93140aac40b
1 // Copyright (c) 2013-2014 Sandstorm Development Group, Inc. 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 #ifndef CAPNP_SERIALIZE_ASYNC_H_
23 #define CAPNP_SERIALIZE_ASYNC_H_
24
25 #if defined(__GNUC__) && !defined(CAPNP_HEADER_WARNINGS)
26 #pragma GCC system_header
27 #endif
28
29 #include <kj/async-io.h>
30 #include "message.h"
31
32 namespace capnp {
33
34 kj::Promise<kj::Own<MessageReader>> readMessage(
35 kj::AsyncInputStream& input, ReaderOptions options = ReaderOptions(),
36 kj::ArrayPtr<word> scratchSpace = nullptr);
37 // Read a message asynchronously.
38 //
39 // `input` must remain valid until the returned promise resolves (or is canceled).
40 //
41 // `scratchSpace`, if provided, must remain valid until the returned MessageReader is destroyed.
42
43 kj::Promise<kj::Maybe<kj::Own<MessageReader>>> tryReadMessage(
44 kj::AsyncInputStream& input, ReaderOptions options = ReaderOptions(),
45 kj::ArrayPtr<word> scratchSpace = nullptr);
46 // Like `readMessage` but returns null on EOF.
47
48 kj::Promise<void> writeMessage(kj::AsyncOutputStream& output,
49 kj::ArrayPtr<const kj::ArrayPtr<const word>> segments)
50 KJ_WARN_UNUSED_RESULT;
51 kj::Promise<void> writeMessage(kj::AsyncOutputStream& output, MessageBuilder& builder)
52 KJ_WARN_UNUSED_RESULT;
53 // Write asynchronously. The parameters must remain valid until the returned promise resolves.
54
55 // =======================================================================================
56 // inline implementation details
57
58 inline kj::Promise<void> writeMessage(kj::AsyncOutputStream& output, MessageBuilder& builder) {
59 return writeMessage(output, builder.getSegmentsForOutput());
60 }
61
62 } // namespace capnp
63
64 #endif // CAPNP_SERIALIZE_ASYNC_H_