Interface OCI::Buffer

interface Buffer

An interface for a buffer. A buffer can be viewed as an object holding an array of octets and a position counter, which determines how many octets have already been sent or received. The IDL interface definition for Buffer is incomplete and must be extended by the specific language mappings. For example, the C++ mapping defines the following additional functions:



Attribute Index

length
The buffer length.
pos
The position counter.

Operation Index

advance
Increment the position counter.
is_full
Checks if the buffer is full.
rest_length
Returns the rest length of the buffer.

Attributes

length
readonly attribute unsigned long length;

The buffer length.


pos
attribute unsigned long pos;

The position counter. Note that the buffer's length and the position counter don't depend on each other. There are no restrictions on the values permitted for the counter. This implies that it's even legal to set the counter to values beyond the buffer's length.



Operations

advance
void advance(in unsigned long delta);

Increment the position counter.

Parameters:
delta - The value to add to the position counter.

is_full
boolean is_full();

Checks if the buffer is full. The buffer is considered full if its length is equal to the position counter's value.

Returns:
TRUE if the buffer is full, FALSE otherwise.

rest_length
unsigned long rest_length();

Returns the rest length of the buffer. The rest length is the length minus the position counter's value. If the value of the position counter exceeds the buffer's length, the return value is undefined.

Returns:
The rest length.


Generated by the ORBacus IDL-to-HTML translator (non-commercial)