cannam@148
|
1 // Copyright (c) 2013-2014 Sandstorm Development Group, Inc. and contributors
|
cannam@148
|
2 // Licensed under the MIT License:
|
cannam@148
|
3 //
|
cannam@148
|
4 // Permission is hereby granted, free of charge, to any person obtaining a copy
|
cannam@148
|
5 // of this software and associated documentation files (the "Software"), to deal
|
cannam@148
|
6 // in the Software without restriction, including without limitation the rights
|
cannam@148
|
7 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
cannam@148
|
8 // copies of the Software, and to permit persons to whom the Software is
|
cannam@148
|
9 // furnished to do so, subject to the following conditions:
|
cannam@148
|
10 //
|
cannam@148
|
11 // The above copyright notice and this permission notice shall be included in
|
cannam@148
|
12 // all copies or substantial portions of the Software.
|
cannam@148
|
13 //
|
cannam@148
|
14 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
cannam@148
|
15 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
cannam@148
|
16 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
cannam@148
|
17 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
cannam@148
|
18 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
cannam@148
|
19 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
cannam@148
|
20 // THE SOFTWARE.
|
cannam@148
|
21
|
cannam@148
|
22 #ifndef CAPNP_SERIALIZE_ASYNC_H_
|
cannam@148
|
23 #define CAPNP_SERIALIZE_ASYNC_H_
|
cannam@148
|
24
|
cannam@148
|
25 #if defined(__GNUC__) && !defined(CAPNP_HEADER_WARNINGS)
|
cannam@148
|
26 #pragma GCC system_header
|
cannam@148
|
27 #endif
|
cannam@148
|
28
|
cannam@148
|
29 #include <kj/async-io.h>
|
cannam@148
|
30 #include "message.h"
|
cannam@148
|
31
|
cannam@148
|
32 namespace capnp {
|
cannam@148
|
33
|
cannam@148
|
34 kj::Promise<kj::Own<MessageReader>> readMessage(
|
cannam@148
|
35 kj::AsyncInputStream& input, ReaderOptions options = ReaderOptions(),
|
cannam@148
|
36 kj::ArrayPtr<word> scratchSpace = nullptr);
|
cannam@148
|
37 // Read a message asynchronously.
|
cannam@148
|
38 //
|
cannam@148
|
39 // `input` must remain valid until the returned promise resolves (or is canceled).
|
cannam@148
|
40 //
|
cannam@148
|
41 // `scratchSpace`, if provided, must remain valid until the returned MessageReader is destroyed.
|
cannam@148
|
42
|
cannam@148
|
43 kj::Promise<kj::Maybe<kj::Own<MessageReader>>> tryReadMessage(
|
cannam@148
|
44 kj::AsyncInputStream& input, ReaderOptions options = ReaderOptions(),
|
cannam@148
|
45 kj::ArrayPtr<word> scratchSpace = nullptr);
|
cannam@148
|
46 // Like `readMessage` but returns null on EOF.
|
cannam@148
|
47
|
cannam@148
|
48 kj::Promise<void> writeMessage(kj::AsyncOutputStream& output,
|
cannam@148
|
49 kj::ArrayPtr<const kj::ArrayPtr<const word>> segments)
|
cannam@148
|
50 KJ_WARN_UNUSED_RESULT;
|
cannam@148
|
51 kj::Promise<void> writeMessage(kj::AsyncOutputStream& output, MessageBuilder& builder)
|
cannam@148
|
52 KJ_WARN_UNUSED_RESULT;
|
cannam@148
|
53 // Write asynchronously. The parameters must remain valid until the returned promise resolves.
|
cannam@148
|
54
|
cannam@148
|
55 // =======================================================================================
|
cannam@148
|
56 // inline implementation details
|
cannam@148
|
57
|
cannam@148
|
58 inline kj::Promise<void> writeMessage(kj::AsyncOutputStream& output, MessageBuilder& builder) {
|
cannam@148
|
59 return writeMessage(output, builder.getSegmentsForOutput());
|
cannam@148
|
60 }
|
cannam@148
|
61
|
cannam@148
|
62 } // namespace capnp
|
cannam@148
|
63
|
cannam@148
|
64 #endif // CAPNP_SERIALIZE_ASYNC_H_
|