| SUMMARY: MODULE | CLASS | TYPE | PROC | VAR | CONST | DETAIL: TYPE | PROC | VAR | CONST |
IO
Object
Object
| Class List | |
| Reader | |
| Writer | |
| Class Summary: Reader [Detail] | |
+--IO:BinaryRider.Reader | |
| Field Summary | |
| byteOrder-: SHORTINT Endian settings for the reader. | |
| channel-: ByteChannel The channel on which this reader is operating. | |
| Constructor Summary | |
| ConnectReader(ByteChannel): Reader | |
| Method Summary | |
| INIT(ByteChannel, SHORTINT) | |
| ReadBool(VAR BOOLEAN) | |
| ReadBytes(VAR ARRAY OF BYTE, LONGINT, LONGINT) Read the bytes according to the native machine byte order. | |
| [ReadBytesOrdered](VAR ARRAY OF BYTE) | |
| ReadChar(VAR CHAR) | |
| ReadInt(VAR INTEGER) | |
| ReadLChar(VAR LONGCHAR) | |
| ReadLInt(VAR LONGINT) | |
| ReadLReal(VAR LONGREAL) | |
| ReadLString(VAR ARRAY OF LONGCHAR) The string s is filled until `0X' is encountered, there are no more characters in the channel, or the string is filled. | |
| ReadNum(VAR LONGINT) | |
| ReadReal(VAR REAL) | |
| ReadSInt(VAR SHORTINT) | |
| ReadSet(VAR SET) | |
| ReadStr(VAR String) | |
| ReadString(VAR ARRAY OF CHAR) The string s is filled until `0X' is encountered, there are no more characters in the channel, or the string is filled. | |
| SetByteOrder(SHORTINT) | |
| SetPos(LONGINT) | |
| Class Summary: Writer [Detail] | |
+--IO:BinaryRider.Writer | |
| Field Summary | |
| byteOrder-: SHORTINT Endian settings for the writer. | |
| channel-: ByteChannel The channel on which this writer is operating. | |
| Constructor Summary | |
| ConnectWriter(ByteChannel): Writer | |
| Method Summary | |
| INIT(ByteChannel, SHORTINT) | |
| SetByteOrder(SHORTINT) | |
| SetPos(LONGINT) | |
| WriteBool(BOOLEAN) | |
| WriteBytes(ARRAY OF BYTE, LONGINT, LONGINT) | |
| WriteChar(CHAR) | |
| WriteInt(INTEGER) | |
| WriteLChar(LONGCHAR) | |
| WriteLInt(LONGINT) | |
| WriteLReal(LONGREAL) | |
| WriteLString(ARRAY OF LONGCHAR) The terminating `0X' is also written. | |
| WriteNum(LONGINT) Write integers in a compressed and portable format. | |
| [WriteOrdered](VAR ARRAY OF BYTE) | |
| WriteReal(REAL) | |
| WriteSInt(SHORTINT) | |
| WriteSet(SET) | |
| WriteStr(String) | |
| WriteString(ARRAY OF CHAR) Note: The terminating `0X' is also written. | |
| Constant Summary | |
| bigEndian Read/write most significant byte first. | |
| littleEndian Read/write least significant byte first. | |
| nativeEndian Do whatever the host machine uses. | |
| Class Detail: Reader |
| Field Detail |
FIELD byteOrder-: SHORTINT
Endian settings for the reader.
FIELD channel-: ByteChannel
The channel on which this reader is operating.
| Constructor Detail |
PROCEDURE ConnectReader(ch: ByteChannel): Reader
Pre-condition: ch is in blocking mode.
| Method Detail |
PROCEDURE (r: Reader) INIT(ch: ByteChannel;
byteOrder: SHORTINT)PROCEDURE (r: Reader) ReadBool(VAR bool: BOOLEAN) RAISES Error;
PROCEDURE (r: Reader) ReadBytes(VAR x: ARRAY OF BYTE;
start: LONGINT;
n: LONGINT)
RAISES Error;Read the bytes according to the native machine byte order.
PROCEDURE (r: Reader) [ReadBytesOrdered](VAR x: ARRAY OF BYTE) RAISES Error;
PROCEDURE (r: Reader) ReadChar(VAR ch: CHAR) RAISES Error;
PROCEDURE (r: Reader) ReadInt(VAR int: INTEGER) RAISES Error;
PROCEDURE (r: Reader) ReadLChar(VAR ch: LONGCHAR) RAISES Error;
PROCEDURE (r: Reader) ReadLInt(VAR lint: LONGINT) RAISES Error;
PROCEDURE (r: Reader) ReadLReal(VAR lreal: LONGREAL) RAISES Error;
PROCEDURE (r: Reader) ReadLString(VAR s: ARRAY OF LONGCHAR) RAISES Error;
The string s is filled until `0X' is encountered, there are no more characters in the channel, or the string is filled. s is always terminated with `0X'.
PROCEDURE (r: Reader) ReadNum(VAR num: LONGINT) RAISES Error;
PROCEDURE (r: Reader) ReadReal(VAR real: REAL) RAISES Error;
PROCEDURE (r: Reader) ReadSInt(VAR sint: SHORTINT) RAISES Error;
PROCEDURE (r: Reader) ReadSet(VAR s: SET) RAISES Error;
PROCEDURE (r: Reader) ReadStr(VAR s: String) RAISES Error;
PROCEDURE (r: Reader) ReadString(VAR s: ARRAY OF CHAR) RAISES Error;
The string s is filled until `0X' is encountered, there are no more characters in the channel, or the string is filled. s is always terminated with `0X'.
PROCEDURE (r: Reader) SetByteOrder(order: SHORTINT)
PROCEDURE (r: Reader) SetPos(newPos: LONGINT) RAISES Error;
| Class Detail: Writer |
| Field Detail |
FIELD byteOrder-: SHORTINT
Endian settings for the writer.
FIELD channel-: ByteChannel
The channel on which this writer is operating.
| Constructor Detail |
PROCEDURE ConnectWriter(ch: ByteChannel): Writer
Pre-condition: ch is in blocking mode.
| Method Detail |
PROCEDURE (w: Writer) INIT(ch: ByteChannel;
byteOrder: SHORTINT)PROCEDURE (w: Writer) SetByteOrder(order: SHORTINT)
PROCEDURE (w: Writer) SetPos(newPos: LONGINT) RAISES Error;
PROCEDURE (w: Writer) WriteBool(bool: BOOLEAN) RAISES Error;
PROCEDURE (w: Writer) WriteBytes(x: ARRAY OF BYTE;
start: LONGINT;
n: LONGINT)
RAISES Error;PROCEDURE (w: Writer) WriteChar(ch: CHAR) RAISES Error;
PROCEDURE (w: Writer) WriteInt(int: INTEGER) RAISES Error;
PROCEDURE (w: Writer) WriteLChar(ch: LONGCHAR) RAISES Error;
PROCEDURE (w: Writer) WriteLInt(lint: LONGINT) RAISES Error;
PROCEDURE (w: Writer) WriteLReal(lreal: LONGREAL) RAISES Error;
PROCEDURE (w: Writer) WriteLString(s: ARRAY OF LONGCHAR) RAISES Error;
The terminating `0X' is also written.
PROCEDURE (w: Writer) WriteNum(lint: LONGINT) RAISES Error;
Write integers in a compressed and portable format.
PROCEDURE (w: Writer) [WriteOrdered](VAR x: ARRAY OF BYTE) RAISES Error;
PROCEDURE (w: Writer) WriteReal(real: REAL) RAISES Error;
PROCEDURE (w: Writer) WriteSInt(sint: SHORTINT) RAISES Error;
PROCEDURE (w: Writer) WriteSet(s: SET) RAISES Error;
PROCEDURE (w: Writer) WriteStr(s: String) RAISES Error;
PROCEDURE (w: Writer) WriteString(s: ARRAY OF CHAR) RAISES Error;
Note: The terminating `0X' is also written.
| Constant Detail |
CONST bigEndian
Read/write most significant byte first.
CONST littleEndian
Read/write least significant byte first.
CONST nativeEndian
Do whatever the host machine uses.