Chris@47: // Copyright (c) 2013-2014 Sandstorm Development Group, Inc. and contributors Chris@47: // Licensed under the MIT License: Chris@47: // Chris@47: // Permission is hereby granted, free of charge, to any person obtaining a copy Chris@47: // of this software and associated documentation files (the "Software"), to deal Chris@47: // in the Software without restriction, including without limitation the rights Chris@47: // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell Chris@47: // copies of the Software, and to permit persons to whom the Software is Chris@47: // furnished to do so, subject to the following conditions: Chris@47: // Chris@47: // The above copyright notice and this permission notice shall be included in Chris@47: // all copies or substantial portions of the Software. Chris@47: // Chris@47: // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR Chris@47: // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, Chris@47: // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE Chris@47: // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER Chris@47: // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, Chris@47: // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN Chris@47: // THE SOFTWARE. Chris@47: Chris@47: #ifndef CAPNP_SERIALIZE_PACKED_H_ Chris@47: #define CAPNP_SERIALIZE_PACKED_H_ Chris@47: Chris@47: #if defined(__GNUC__) && !defined(CAPNP_HEADER_WARNINGS) Chris@47: #pragma GCC system_header Chris@47: #endif Chris@47: Chris@47: #include "serialize.h" Chris@47: Chris@47: namespace capnp { Chris@47: Chris@47: namespace _ { // private Chris@47: Chris@47: class PackedInputStream: public kj::InputStream { Chris@47: // An input stream that unpacks packed data with a picky constraint: The caller must read data Chris@47: // in the exact same size and sequence as the data was written to PackedOutputStream. Chris@47: Chris@47: public: Chris@47: explicit PackedInputStream(kj::BufferedInputStream& inner); Chris@47: KJ_DISALLOW_COPY(PackedInputStream); Chris@47: ~PackedInputStream() noexcept(false); Chris@47: Chris@47: // implements InputStream ------------------------------------------ Chris@47: size_t tryRead(void* buffer, size_t minBytes, size_t maxBytes) override; Chris@47: void skip(size_t bytes) override; Chris@47: Chris@47: private: Chris@47: kj::BufferedInputStream& inner; Chris@47: }; Chris@47: Chris@47: class PackedOutputStream: public kj::OutputStream { Chris@47: public: Chris@47: explicit PackedOutputStream(kj::BufferedOutputStream& inner); Chris@47: KJ_DISALLOW_COPY(PackedOutputStream); Chris@47: ~PackedOutputStream() noexcept(false); Chris@47: Chris@47: // implements OutputStream ----------------------------------------- Chris@47: void write(const void* buffer, size_t bytes) override; Chris@47: Chris@47: private: Chris@47: kj::BufferedOutputStream& inner; Chris@47: }; Chris@47: Chris@47: } // namespace _ (private) Chris@47: Chris@47: class PackedMessageReader: private _::PackedInputStream, public InputStreamMessageReader { Chris@47: public: Chris@47: PackedMessageReader(kj::BufferedInputStream& inputStream, ReaderOptions options = ReaderOptions(), Chris@47: kj::ArrayPtr scratchSpace = nullptr); Chris@47: KJ_DISALLOW_COPY(PackedMessageReader); Chris@47: ~PackedMessageReader() noexcept(false); Chris@47: }; Chris@47: Chris@47: class PackedFdMessageReader: private kj::FdInputStream, private kj::BufferedInputStreamWrapper, Chris@47: public PackedMessageReader { Chris@47: public: Chris@47: PackedFdMessageReader(int fd, ReaderOptions options = ReaderOptions(), Chris@47: kj::ArrayPtr scratchSpace = nullptr); Chris@47: // Read message from a file descriptor, without taking ownership of the descriptor. Chris@47: // Note that if you want to reuse the descriptor after the reader is destroyed, you'll need to Chris@47: // seek it, since otherwise the position is unspecified. Chris@47: Chris@47: PackedFdMessageReader(kj::AutoCloseFd fd, ReaderOptions options = ReaderOptions(), Chris@47: kj::ArrayPtr scratchSpace = nullptr); Chris@47: // Read a message from a file descriptor, taking ownership of the descriptor. Chris@47: Chris@47: KJ_DISALLOW_COPY(PackedFdMessageReader); Chris@47: Chris@47: ~PackedFdMessageReader() noexcept(false); Chris@47: }; Chris@47: Chris@47: void writePackedMessage(kj::BufferedOutputStream& output, MessageBuilder& builder); Chris@47: void writePackedMessage(kj::BufferedOutputStream& output, Chris@47: kj::ArrayPtr> segments); Chris@47: // Write a packed message to a buffered output stream. Chris@47: Chris@47: void writePackedMessage(kj::OutputStream& output, MessageBuilder& builder); Chris@47: void writePackedMessage(kj::OutputStream& output, Chris@47: kj::ArrayPtr> segments); Chris@47: // Write a packed message to an unbuffered output stream. If you intend to write multiple messages Chris@47: // in succession, consider wrapping your output in a buffered stream in order to reduce system Chris@47: // call overhead. Chris@47: Chris@47: void writePackedMessageToFd(int fd, MessageBuilder& builder); Chris@47: void writePackedMessageToFd(int fd, kj::ArrayPtr> segments); Chris@47: // Write a single packed message to the file descriptor. Chris@47: Chris@47: size_t computeUnpackedSizeInWords(kj::ArrayPtr packedBytes); Chris@47: // Computes the number of words to which the given packed bytes will unpack. Not intended for use Chris@47: // in performance-sensitive situations. Chris@47: Chris@47: // ======================================================================================= Chris@47: // inline stuff Chris@47: Chris@47: inline void writePackedMessage(kj::BufferedOutputStream& output, MessageBuilder& builder) { Chris@47: writePackedMessage(output, builder.getSegmentsForOutput()); Chris@47: } Chris@47: Chris@47: inline void writePackedMessage(kj::OutputStream& output, MessageBuilder& builder) { Chris@47: writePackedMessage(output, builder.getSegmentsForOutput()); Chris@47: } Chris@47: Chris@47: inline void writePackedMessageToFd(int fd, MessageBuilder& builder) { Chris@47: writePackedMessageToFd(fd, builder.getSegmentsForOutput()); Chris@47: } Chris@47: Chris@47: } // namespace capnp Chris@47: Chris@47: #endif // CAPNP_SERIALIZE_PACKED_H_