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