| SUMMARY: MODULE | CLASS | TYPE | PROC | VAR | CONST | DETAIL: TYPE | PROC | VAR | CONST |
Channel
Msg
Object
Object
| Class List | |
| ErrorContext | This record is exported, so that extensions of Channel can access the error descriptions by extending ErrorContextDesc. |
| Reader | |
| Writer | |
| Class Summary: ErrorContext [Detail] | |
+---Msg.Context | +---Channel.ErrorContext | +--BinaryRider.ErrorContext This record is exported, so that extensions of Channel can access the error descriptions by extending ErrorContextDesc. | |
| Inherited Fields | |
From Msg.Context: | |
| Inherited Methods | |
| Class Summary: Reader [Detail] | |
+--BinaryRider.Reader | |
| Field Summary | |
| base-: Channel The channel on which this reader is operating. | |
| byteOrder-: SHORTINT Endian settings for the reader. | |
| byteReader-: Reader Binary reader underneath this text reader. | |
| res: Msg | |
| Constructor Summary | |
| ConnectReader(Channel): Reader | |
| InitReader(Reader, Channel, SHORTINT) | |
| Method Summary | |
| Available(): LONGINT | |
| ClearError() | |
| Pos(): LONGINT | |
| 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] | |
+--BinaryRider.Writer | |
| Field Summary | |
| base-: Channel The channel on which this writer is operating. | |
| byteOrder-: SHORTINT Endian settings for the writer. | |
| byteWriter-: Writer Binary writer underneath this text writer. | |
| res: Msg | |
| Constructor Summary | |
| ConnectWriter(Channel): Writer | |
| InitWriter(Writer, Channel, SHORTINT) | |
| Method Summary | |
| ClearError() | |
| Pos(): LONGINT | |
| SetByteOrder(SHORTINT) | |
| SetPos(LONGINT) | |
| WriteBool(BOOLEAN) | |
| WriteBytes(ARRAY OF BYTE, LONGINT, LONGINT) | |
| [WriteBytesOrdered](VAR ARRAY OF BYTE) | |
| 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. | |
| 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. | |
| done | |
| invalidFormat | |
| littleEndian Read/write least significant byte first. | |
| nativeEndian Do whatever the host machine uses. | |
| readAfterEnd | |
| Class Detail: ErrorContext |
| Class Detail: Reader |
| Field Detail |
FIELD base-: Channel
The channel on which this reader is operating.
FIELD byteOrder-: SHORTINT
Endian settings for the reader.
FIELD byteReader-: Reader
Binary reader underneath this text reader. This field should only be used by extensions of this type.
FIELD res: Msg
| Constructor Detail |
PROCEDURE ConnectReader(ch: Channel): Reader
PROCEDURE InitReader(r: Reader;
ch: Channel;
byteOrder: SHORTINT)| Method Detail |
PROCEDURE (r: Reader) Available(): LONGINT
PROCEDURE (r: Reader) ClearError()
PROCEDURE (r: Reader) Pos(): LONGINT
PROCEDURE (r: Reader) ReadBool(VAR bool: BOOLEAN)
PROCEDURE (r: Reader) ReadBytes(VAR x: ARRAY OF BYTE;
start: LONGINT;
n: LONGINT)Read the bytes according to the native machine byte order.
PROCEDURE (r: Reader) [ReadBytesOrdered](VAR x: ARRAY OF BYTE)
PROCEDURE (r: Reader) ReadChar(VAR ch: CHAR)
PROCEDURE (r: Reader) ReadInt(VAR int: INTEGER)
PROCEDURE (r: Reader) ReadLChar(VAR ch: LONGCHAR)
PROCEDURE (r: Reader) ReadLInt(VAR lint: LONGINT)
PROCEDURE (r: Reader) ReadLReal(VAR lreal: LONGREAL)
PROCEDURE (r: Reader) ReadLString(VAR s: 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. s is always terminated with `0X'.
PROCEDURE (r: Reader) ReadNum(VAR num: LONGINT)
PROCEDURE (r: Reader) ReadReal(VAR real: REAL)
PROCEDURE (r: Reader) ReadSInt(VAR sint: SHORTINT)
PROCEDURE (r: Reader) ReadSet(VAR s: SET)
PROCEDURE (r: Reader) ReadStr(VAR s: String)
PROCEDURE (r: Reader) ReadString(VAR s: 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. s is always terminated with `0X'.
PROCEDURE (r: Reader) SetByteOrder(order: SHORTINT)
PROCEDURE (r: Reader) SetPos(newPos: LONGINT)
| Class Detail: Writer |
| Field Detail |
FIELD base-: Channel
The channel on which this writer is operating.
FIELD byteOrder-: SHORTINT
Endian settings for the writer.
FIELD byteWriter-: Writer
Binary writer underneath this text writer. This field should only be used by extensions of this type.
FIELD res: Msg
| Constructor Detail |
PROCEDURE ConnectWriter(ch: Channel): Writer
PROCEDURE InitWriter(w: Writer;
ch: Channel;
byteOrder: SHORTINT)| Method Detail |
PROCEDURE (w: Writer) ClearError()
PROCEDURE (w: Writer) Pos(): LONGINT
PROCEDURE (w: Writer) SetByteOrder(order: SHORTINT)
PROCEDURE (w: Writer) SetPos(newPos: LONGINT)
PROCEDURE (w: Writer) WriteBool(bool: BOOLEAN)
PROCEDURE (w: Writer) WriteBytes(x: ARRAY OF BYTE;
start: LONGINT;
n: LONGINT)PROCEDURE (w: Writer) [WriteBytesOrdered](VAR x: ARRAY OF BYTE)
PROCEDURE (w: Writer) WriteChar(ch: CHAR)
PROCEDURE (w: Writer) WriteInt(int: INTEGER)
PROCEDURE (w: Writer) WriteLChar(ch: LONGCHAR)
PROCEDURE (w: Writer) WriteLInt(lint: LONGINT)
PROCEDURE (w: Writer) WriteLReal(lreal: LONGREAL)
PROCEDURE (w: Writer) WriteLString(s: ARRAY OF LONGCHAR)
The terminating `0X' is also written.
PROCEDURE (w: Writer) WriteNum(lint: LONGINT)
Write integers in a compressed and portable format.
PROCEDURE (w: Writer) WriteReal(real: REAL)
PROCEDURE (w: Writer) WriteSInt(sint: SHORTINT)
PROCEDURE (w: Writer) WriteSet(s: SET)
PROCEDURE (w: Writer) WriteStr(s: String)
PROCEDURE (w: Writer) WriteString(s: ARRAY OF CHAR)
Note: The terminating `0X' is also written.
| Constant Detail |
CONST bigEndian
Read/write most significant byte first.
CONST done
CONST invalidFormat
CONST littleEndian
Read/write least significant byte first.
CONST nativeEndian
Do whatever the host machine uses.
CONST readAfterEnd