Document Actions

SRB File Reader

Note: This is the print view with all the Reference Manual pages on one page. The paginated version is available here, if you prefer that.

details on the SRB File Reader actor

1. About

about the SRB File Reader actor

This actor reads a file from the SRB server into an unsigned byte array.

2. Parameters

details on the actor's parameters

name	type	description
server id	int	ID of the SRB Server actor to use for this actor.

3. Input Ports

details on the Input Ports of this actor

name	type	description
input	string	full path of the file on the SRB server to read into the array.

4. Output Ports

Details on this actors output ports

name	type	description
output	unsigned byte array	the contents of the file represented as an unsigned byte array
zeroToken	boolean	true if the unsigned byte array has no data (i.e. is size 0), otherwise false. This is required since array tokens of size 0 cannot be sent.

5. Usage Notes

details on specific usage notes for this actor

If there is the possibility that the file being read in is empty (i.e. has size 0), then the zeroToken port should be checked every time before trying to read the output port.

This is because, at the time of writing, array tokens cannot be of size 0, and in PN domains it is impossible to check if there are going to be tokens on a port.