coherence/io/OctetArrayReadBuffer.hpp

/*
* OctetArrayReadBuffer.hpp
*
* Copyright (c) 2000, 2009, Oracle and/or its affiliates. All rights reserved.
*
* Oracle is a registered trademarks of Oracle Corporation and/or its
* affiliates.
*
* This software is the confidential and proprietary information of Oracle
* Corporation. You shall not disclose such confidential and proprietary
* information and shall use it only in accordance with the terms of the
* license agreement you entered into with Oracle.
*
* This notice may not be removed or altered.
*/
#ifndef COH_OCTET_ARRAY_READ_BUFFER_HPP
#define COH_OCTET_ARRAY_READ_BUFFER_HPP

#include "coherence/lang.ns"

#include "coherence/io/AbstractReadBuffer.hpp"

COH_OPEN_NAMESPACE2(coherence,io)

class OctetArrayWriteBuffer;


/**
* A ReadBuffer on top of an octet array.
*
* @author jh  2008.01.03
*/
class COH_EXPORT OctetArrayReadBuffer
    : public cloneable_spec<OctetArrayReadBuffer,
        extends<AbstractReadBuffer> >
    {
    friend class factory<OctetArrayReadBuffer>;

    // ----- handle definitions (needed for nested classes) -----------------

    public:
        typedef this_spec::Handle Handle;
        typedef this_spec::View   View;
        typedef this_spec::Holder Holder;


    // ----- constructors ---------------------------------------------------

    protected:
        /**
        * Construct an OctetArrayReadBuffer object from a portion of an octet
        * array.
        *
        * @param vab    an array of octets
        * @param of     the offset into the octet array
        * @param cb     the number of octets to extract
        * @param fCopy  true to make a copy of the passed array
        */
        OctetArrayReadBuffer(Array<octet_t>::View vab, size32_t of,
                size32_t cb, bool fCopy = false);

        /**
        * Copy constructor.
        */
        OctetArrayReadBuffer(const OctetArrayReadBuffer& that);


    // ----- ReadBuffer interface -------------------------------------------

    public:
        /**
        * {@inheritDoc}
        */
        virtual size32_t length() const;

        /**
        * {@inheritDoc}
        */
        virtual octet_t read(size32_t of) const;

        /**
        * {@inheritDoc}
        */
        virtual void read(size32_t ofBegin, size32_t ofEnd,
                Array<octet_t>::Handle habDest, size32_t ofDest) const;

        /**
        * {@inheritDoc}
        */
        virtual Array<octet_t>::View toOctetArray(size32_t of, size32_t cb) const;

        /**
        * {@inheritDoc}
        */
        using AbstractReadBuffer::toOctetArray;


    // ----- Object interface -----------------------------------------------

    public:
        /**
        * {@inheritDoc}
        */
        virtual void toStream(std::ostream& out) const;


    // ----- internal methods -----------------------------------------------

    protected:
        /**
        * Allow the length to be modified. This method is provided for use by
        * OctetArrayWriteBuffer only, and only for read buffers that it owns.
        *
        * @param cb  the new length
        */
        virtual void updateLength(size32_t cb);

        /**
        * {@inheritDoc}
        */
        virtual ReadBuffer::View instantiateReadBuffer(size32_t of,
                size32_t cb) const;

        /**
        * {@inheritDoc}
        */
        virtual BufferInput::Handle instantiateBufferInput() const;


    // ----- OctetArrayBufferInput inner class ------------------------------

    public:
        /**
        * This is an implementation of the BufferInput interface on top of a
        * octet array.
        *
        * @author jh  2008.01.03
        */
        class COH_EXPORT OctetArrayBufferInput
            : public class_spec<OctetArrayBufferInput,
                extends<AbstractBufferInput> >
            {
            friend class factory<OctetArrayBufferInput>;

            // ----- constructors ---------------------------------------

            protected:
                /**
                * Create a new OctetArrayBufferInput instance that delegates
                * to the given OctetArrayReadBuffer.
                *
                * @param vBuf  the delegate ReadBuffer
                */
                OctetArrayBufferInput(OctetArrayReadBuffer::View vBuf);

            // ----- BufferInput interface ------------------------------

            public:
                /**
                * {@inheritDoc}
                */
                using AbstractBufferInput::read;

                /**
                * {@inheritDoc}
                */
                virtual octet_t read();

                /**
                * {@inheritDoc}
                */
                virtual void read(Array<octet_t>::Handle hab, size32_t of,
                        size32_t cb);

                /**
                * {@inheritDoc}
                */
                virtual char16_t readChar16();

                /**
                * {@inheritDoc}
                */
                virtual int16_t readInt16();

                /**
                * {@inheritDoc}
                */
                virtual int32_t readInt32();

                /**
                * {@inheritDoc}
                */
                virtual int64_t readInt64();

                /**
                * {@inheritDoc}
                */
                virtual float32_t readFloat32();

                /**
                * {@inheritDoc}
                */
                virtual float64_t readFloat64();

            // ----- internal methods -----------------------------------

            protected:
                /**
                * {@inheritDoc}
                */
                virtual String::View convertUTF(size32_t of, size32_t cb) const;
            };


    // ----- data members ---------------------------------------------------

    protected:
        /**
        * The octet array that holds the binary data.
        */
        FinalView<Array<octet_t> > m_vab;

        /**
        * Offset into the octet array at which the binary data is located.
        */
        size32_t m_of;

        /**
        * Number of octets in the octet array that belong to this ReadBuffer
        * object.
        */
        size32_t m_cb;


    // ----- friends --------------------------------------------------------

    friend class OctetArrayWriteBuffer;
    };

COH_CLOSE_NAMESPACE2

#endif // COH_OCTET_ARRAY_READ_BUFFER_HPP

Copyright (c) 2000, 2009, Oracle and/or its affiliates. All rights reserved.