Oracle Coherence for C++ API: OctetArrayReadBuffer Class Reference

An offset ranges from 0 to length() - 1. The first octet of the sequence is at offset 0, the next at offset 1, and so on, as for array indexing.

Parameters:

the offset (index) of the octet

Returns:: the octet at the specified offset in this ReadBuffer

Exceptions:

IndexOutOfBoundsException if the of argument is not less than the length of this ReadBuffer

virtual void

read (size32_t ofBegin, size32_t ofEnd, Array< octet_t >::Handle habDest, size32_t ofDest) const

Copies octets from this ReadBuffer into the destination octet array.

The first octet to be copied is at offset ofBegin; the last octet to be copied is at offset ofEnd-1 (thus the total number of octets to be copied is ofEnd - ofBegin). The octets are copied into the subarray of habDest starting at offset ofDest and ending at index:

     ofDest + (ofEnd - ofBegin) - 1

This method allows the caller to extract a chunk of octets into the caller's own array.

Parameters:

	ofBegin	offset of the first octet in the ReadBuffer to copy
	ofEnd	offset after the last octet in the ReadBuffer to copy
	habDest	the destination octet array
	ofDest	the offset in the destination octet array to copy the first octet to

Exceptions:

	IndexOutOfBoundsException	if any of the following is true: `ofBegin` is greater than `ofEnd` `ofEnd` is greater than the length of this ReadBuffer; `ofDest + (ofEnd - ofBegin)` is larger than `habDest->length`
	NullPointerException	if `habDest` is NULL

virtual Array
< octet_t >::View

toOctetArray (size32_t of, size32_t cb) const

Get a portion of the contents of the ReadBuffer as an octet array.

Parameters:

	of	the beginning index, inclusive
	cb	the number of octets to include in the resulting array

Returns:: an octet array containing the specified portion of this ReadBuffer

Exceptions:

IndexOutOfBoundsException if of + cb is larger than the length of this ReadBuffer

virtual void

toStream (std::ostream &out) const

Output a human-readable description of this Object to the given stream.

coherence::lang::operator<<(std::ostream, Object::View) is defined and will call into the toStream method, to output Objects. If a managed String object is desired, the COH_TO_STRING macro can be used to build up a String from streamable contents.

 Object::View vKey   = ...
 Object::View vValue = ...
 std::cout << vKey << " = " << vValue << std::endl;

 String::Handle hs = COH_TO_STRING(vKey << " = " << vValue);

Parameters:

out

the stream used to output the description