C++ Client API Reference for Oracle Coherence: coherence/io/OctetArrayReadBuffer.hpp Source File

00001 /*
00002  * Copyright (c) 2000, 2020, Oracle and/or its affiliates.
00003  *
00004  * Licensed under the Universal Permissive License v 1.0 as shown at
00005  * http://oss.oracle.com/licenses/upl.
00006  */
00007 #ifndef COH_OCTET_ARRAY_READ_BUFFER_HPP
00008 #define COH_OCTET_ARRAY_READ_BUFFER_HPP
00009 
00010 #include "coherence/lang.ns"
00011 
00012 #include "coherence/io/AbstractOctetArrayReadBuffer.hpp"
00013 
00014 COH_OPEN_NAMESPACE2(coherence,io)
00015 
00016 class OctetArrayWriteBuffer;
00017 
00018 
00019 /**
00020 * A ReadBuffer on top of an octet Array.
00021 *
00022 * @author jh  2008.01.03
00023 */
00024 class COH_EXPORT OctetArrayReadBuffer
00025     : public cloneable_spec<OctetArrayReadBuffer,
00026         extends<AbstractOctetArrayReadBuffer> >
00027     {
00028     friend class factory<OctetArrayReadBuffer>;
00029 
00030     // ----- constructors ---------------------------------------------------
00031 
00032     protected:
00033         /**
00034         * Construct an OctetArrayReadBuffer object from a portion of an octet
00035         * Array.
00036         *
00037         * @param vab    an Array of octets
00038         * @param of     the offset into the octet Array
00039         * @param cb     the number of octets to extract or npos for
00040         *               (vab->length - of)
00041         * @param fCopy  true to make a copy of the passed in Array
00042         *
00043         * @throws  IndexOutOfBoundsException if <code>of + cb</code> is
00044         *          larger than <code>vab->length</code>
00045         * @throws  NullPointerException if <code>vab</code> is
00046         *          <code>NULL</code>
00047         */
00048         OctetArrayReadBuffer(Array<octet_t>::View vab, size32_t of = 0,
00049                 size32_t cb = npos, bool fCopy = false);
00050 
00051         /**
00052         * Copy constructor.
00053         */
00054         OctetArrayReadBuffer(const OctetArrayReadBuffer& that);
00055 
00056 
00057     // ----- Object interface -----------------------------------------------
00058 
00059     public:
00060         /**
00061         * {@inheritDoc}
00062         */
00063         virtual TypedHandle<const String> toString() const;
00064 
00065 
00066     // ----- internal methods -----------------------------------------------
00067 
00068     protected:
00069         /**
00070         * Allow the length to be modified. This method is provided for use by
00071         * OctetArrayWriteBuffer only, and only for read buffers that it owns.
00072         *
00073         * @param cb  the new length
00074         */
00075         virtual void updateLength(size32_t cb);
00076 
00077         /**
00078         * {@inheritDoc}
00079         */
00080         virtual ReadBuffer::View instantiateReadBuffer(size32_t of,
00081                 size32_t cb) const;
00082 
00083 
00084     // ----- friends --------------------------------------------------------
00085 
00086     friend class OctetArrayWriteBuffer;
00087     };
00088 
00089 COH_CLOSE_NAMESPACE2
00090 
00091 #endif // COH_OCTET_ARRAY_READ_BUFFER_HPP