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