DatagramIterator¶

class DatagramIterator¶

A class to retrieve the individual data elements previously stored in a Datagram. Elements may be retrieved one at a time; it is up to the caller to know the correct type and order of each element.

Note that it is the responsibility of the caller to ensure that the datagram object is not destructed while this DatagramIterator is in use.

Inheritance diagram

digraph inheritancef0afaff1d1 { bgcolor=transparent; rankdir=BT; size="8.0, 12.0"; "DTOOL_SUPER_BASE" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style=""]; "DatagramIterator" [URL="acron.core.DatagramIterator.html#acron.core.DatagramIterator",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "DTOOL_SUPER_BASE" -> "DatagramIterator" [arrowsize=0.75,style=""]; }

DatagramIterator.__init__()¶

DatagramIterator.extract_bytes()¶

Extracts the indicated number of bytes in the datagram and returns them as a string.

Extracts the indicated number of bytes in the datagram into the given character buffer. Assumes that the buffer is big enough to hold the requested number of bytes. Returns the number of bytes that were successfully written.

DatagramIterator.get_be_float32()¶: Extracts a 32-bit big-endian single-precision floating-point number.

DatagramIterator.get_be_float64()¶: Extracts a 64-bit big-endian floating-point number.

DatagramIterator.get_be_int16()¶: Extracts a signed 16-bit big-endian integer.

DatagramIterator.get_be_int32()¶: Extracts a signed 32-bit big-endian integer.

DatagramIterator.get_be_int64()¶: Extracts a signed 64-bit big-endian integer.

DatagramIterator.get_be_uint16()¶: Extracts an unsigned 16-bit big-endian integer.

DatagramIterator.get_be_uint32()¶: Extracts an unsigned 32-bit big-endian integer.

DatagramIterator.get_be_uint64()¶: Extracts an unsigned 64-bit big-endian integer.

DatagramIterator.get_blob()¶: Extracts a variable-length binary blob.

DatagramIterator.get_blob32()¶: Extracts a variable-length binary blob with a 32-bit size field.

DatagramIterator.get_bool()¶: Extracts a boolean value.

static DatagramIterator.get_class_type()¶

DatagramIterator.get_current_index()¶: Returns the current position within the datagram of the next piece of data to extract.

DatagramIterator.get_datagram()¶: Return the datagram of this iterator.

DatagramIterator.get_fixed_string()¶: Extracts a fixed-length string. However, if a zero byte occurs within the string, it marks the end of the string.

DatagramIterator.get_float32()¶: Extracts a 32-bit single-precision floating-point number.

DatagramIterator.get_float64()¶: Extracts a 64-bit floating-point number.

DatagramIterator.get_int16()¶: Extracts a signed 16-bit integer.

DatagramIterator.get_int32()¶: Extracts a signed 32-bit integer.

DatagramIterator.get_int64()¶: Extracts a signed 64-bit integer.

DatagramIterator.get_int8()¶: Extracts a signed 8-bit integer.

DatagramIterator.get_remaining_bytes()¶: Returns the remaining bytes in the datagram as a string, but does not extract them from the iterator.

DatagramIterator.get_remaining_size()¶: Return the bytes left in the datagram.

DatagramIterator.get_stdfloat()¶: Extracts either a 32-bit or a 64-bit floating-point number, according to Datagram::set_stdfloat_double().

DatagramIterator.get_string()¶: Extracts a variable-length string.

DatagramIterator.get_string32()¶: Extracts a variable-length string with a 32-bit length field.

DatagramIterator.get_uint16()¶: Extracts an unsigned 16-bit integer.

DatagramIterator.get_uint32()¶: Extracts an unsigned 32-bit integer.

DatagramIterator.get_uint64()¶: Extracts an unsigned 64-bit integer.

DatagramIterator.get_uint8()¶: Extracts an unsigned 8-bit integer.

DatagramIterator.get_wstring()¶: Extracts a variable-length wstring (with a 32-bit length field).

DatagramIterator.get_z_string()¶: Extracts a variable-length string, as a NULL-terminated string.

DatagramIterator.output()¶: Write a string representation of this instance to <out>.

DatagramIterator.peek_int16()¶: Extracts a signed 16-bit integer without advancing the iterator.

DatagramIterator.peek_uint16()¶: Extracts an unsigned 16-bit integer without advancing the iterator.

DatagramIterator.skip_bytes()¶: Skips over the indicated number of bytes in the datagram.

DatagramIterator.write()¶: Write a string representation of this instance to <out>.