cannam@62: // Copyright (c) 2013-2014 Sandstorm Development Group, Inc. and contributors
cannam@62: // Licensed under the MIT License:
cannam@62: //
cannam@62: // Permission is hereby granted, free of charge, to any person obtaining a copy
cannam@62: // of this software and associated documentation files (the "Software"), to deal
cannam@62: // in the Software without restriction, including without limitation the rights
cannam@62: // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
cannam@62: // copies of the Software, and to permit persons to whom the Software is
cannam@62: // furnished to do so, subject to the following conditions:
cannam@62: //
cannam@62: // The above copyright notice and this permission notice shall be included in
cannam@62: // all copies or substantial portions of the Software.
cannam@62: //
cannam@62: // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
cannam@62: // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
cannam@62: // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
cannam@62: // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
cannam@62: // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
cannam@62: // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
cannam@62: // THE SOFTWARE.
cannam@62: 
cannam@62: #ifndef CAPNP_SERIALIZE_ASYNC_H_
cannam@62: #define CAPNP_SERIALIZE_ASYNC_H_
cannam@62: 
cannam@62: #if defined(__GNUC__) && !defined(CAPNP_HEADER_WARNINGS)
cannam@62: #pragma GCC system_header
cannam@62: #endif
cannam@62: 
cannam@62: #include <kj/async-io.h>
cannam@62: #include "message.h"
cannam@62: 
cannam@62: namespace capnp {
cannam@62: 
cannam@62: kj::Promise<kj::Own<MessageReader>> readMessage(
cannam@62:     kj::AsyncInputStream& input, ReaderOptions options = ReaderOptions(),
cannam@62:     kj::ArrayPtr<word> scratchSpace = nullptr);
cannam@62: // Read a message asynchronously.
cannam@62: //
cannam@62: // `input` must remain valid until the returned promise resolves (or is canceled).
cannam@62: //
cannam@62: // `scratchSpace`, if provided, must remain valid until the returned MessageReader is destroyed.
cannam@62: 
cannam@62: kj::Promise<kj::Maybe<kj::Own<MessageReader>>> tryReadMessage(
cannam@62:     kj::AsyncInputStream& input, ReaderOptions options = ReaderOptions(),
cannam@62:     kj::ArrayPtr<word> scratchSpace = nullptr);
cannam@62: // Like `readMessage` but returns null on EOF.
cannam@62: 
cannam@62: kj::Promise<void> writeMessage(kj::AsyncOutputStream& output,
cannam@62:                                kj::ArrayPtr<const kj::ArrayPtr<const word>> segments)
cannam@62:     KJ_WARN_UNUSED_RESULT;
cannam@62: kj::Promise<void> writeMessage(kj::AsyncOutputStream& output, MessageBuilder& builder)
cannam@62:     KJ_WARN_UNUSED_RESULT;
cannam@62: // Write asynchronously.  The parameters must remain valid until the returned promise resolves.
cannam@62: 
cannam@62: // =======================================================================================
cannam@62: // inline implementation details
cannam@62: 
cannam@62: inline kj::Promise<void> writeMessage(kj::AsyncOutputStream& output, MessageBuilder& builder) {
cannam@62:   return writeMessage(output, builder.getSegmentsForOutput());
cannam@62: }
cannam@62: 
cannam@62: }  // namespace capnp
cannam@62: 
cannam@62: #endif  // CAPNP_SERIALIZE_ASYNC_H_