home · contact · privacy
MAJOR re-write. Split plomrogue into a server and a client. Re-wrote large parts
[plomrogue] / src / server / io.h
1 /* io.h:
2  *
3  * Communication of the server with the outside world via input fifo and output
4  * file.
5  */
6
7 #ifndef IO_H
8 #define IO_H
9
10
11
12 /* Return single \0-terminated string read from input queue (world.queue); or,
13  * if queue is empty and world.turn is unequal world.last_update_turn, update
14  * output file at world.path_out (and update world.last_update_turn), then read
15  * file at world.path_in for the next load of bytes to put onto the input queue.
16  *
17  * Reading the file at world.path_in may put many \0-terminated strings on the
18  * queue at once. Successive calls of io_round() will make these available one
19  * by one. Each such call cuts off bytes from the beginning of world.queue, up
20  * to and including the last \0 byte that is followed by a non-\0 byte or ends
21  * the queue. If the queue starts with a \0 byte, it and its \0 followers are
22  * cut and a NULL pointer is returned. Reading from the input file stops only
23  * when one or more byte were read and the next read returns 0 bytes. If the
24  * re-filled queue does not end in a \0 byte, a \0 byte is appended to it.
25  */
26 extern char * io_round();
27
28
29
30 #endif