-/* src/client/io.c */
+/* src/client/io.c
+ *
+ * This file is part of PlomRogue. PlomRogue is licensed under the GPL version 3
+ * or any later version. For details on its copyright, license, and warranties,
+ * see the file NOTICE in the root directory of the PlomRogue source package.
+ */
#define _POSIX_C_SOURCE 1 /* PIPE_BUF */
#include "io.h"
static uint16_t read_value_from_line(char * read_buf, uint32_t linemax,
FILE * file);
-/* If the server's worldstate file has changed since the last read_world(),
+/* If the server's worldstate file has changed since the last read_worldstate(),
* return a pointer to its file descriptor; else, return NULL.
*
* Two tests are performed to check for a file change. The file's last data
static FILE * changed_worldstate_file(char * path);
/* Attempt to read the server's worldstate file as representation of the game
- * world in a hard-coded serialization format. Returns 1 on success and 0 if the
+ * world in a hard-coded serialization format. Returns 1 on success, or 0 if the
* out file wasn't read for supposedly not having changed since a last
- * read_world() call.
+ * read_worldstate() call.
*
- * map_center() is triggered by either, the first successful read_world() (thus
- * on client start), or on turn 1 (thus on world start).
+ * map_center() is triggered by either, the first successful read_worldstate()
+ * (thus on client start), or on turn 1 (thus on world start).
*/
-static uint8_t read_world();
+static uint8_t read_worldstate();
/* If "last_server_answer_time" is too old, send a PING to the server; or, if a
* previous PING has not sparked any answer after a while, abort the client.
*/
-static void test_ping_pong(time_t last_server_answer_time);
+static void ping_pong_test(time_t last_server_answer_time);
/* Update "last_server_answer_time" if new stuff has been written to the
* server's out file.
*/
-static void test_server_activity(time_t * last_server_answer_time);
+static void server_activity_test(time_t * last_server_answer_time);
break;
}
int old_size = 0;
- if (NULL != world.player_inventory)
+ if (world.player_inventory)
{
old_size = strlen(world.player_inventory);
}
while (try_fgets(read_buf, linemax + 1, file, __func__))
{
int old_size = 0;
- if (NULL != world.log)
+ if (world.log)
{
old_size = strlen(world.log);
}
-static uint8_t read_world()
+static uint8_t read_worldstate()
{
char * path = "server/worldstate";
char * quit_msg = "No worldstate file found to read. Server may be down.";
-static void test_ping_pong(time_t last_server_answer_time)
+static void ping_pong_test(time_t last_server_answer_time)
{
static uint8_t ping_sent = 0;
time_t now = time(0);
- if (ping_sent && last_server_answer_time > now - 3)
- {
- ping_sent = 0;
+ if (ping_sent && last_server_answer_time > now - 3) /* Re-set if last */
+ { /* ping was answered */
+ ping_sent = 0; /* with server */
+ return; /* activity. */
}
if (!ping_sent && last_server_answer_time < now - 3)
{
-static void test_server_activity(time_t * last_server_answer_time)
+static void server_activity_test(time_t * last_server_answer_time)
{
int test = try_fgetc(world.file_server_out, __func__);
if (EOF == test)
extern void send(char * msg)
{
uint32_t msg_size = strlen(msg) + 1;
- char * err = "send() tries to send message larger than PIPE_BUF bytes.";
+ char * err = "send() tried to send message larger than PIPE_BUF bytes.";
exit_err(msg_size > PIPE_BUF, err);
try_fwrite(msg, strlen(msg), 1, world.file_server_in, __func__);
try_fputc('\n', world.file_server_in, __func__);
extern char * io_loop()
{
- world.halfdelay = 1; /* Ensures read_world() is only called 10 */
- halfdelay(world.halfdelay); /* times a second during user inactivity. */
+ world.halfdelay = 1; /* Ensures read_worldstate() is only called */
+ halfdelay(world.halfdelay); /* 10 times a second during user inactivity. */
uint8_t change_in_client = 0;
uint16_t last_focused_turn = world.turn;
time_t last_server_answer_time = time(0);
while (1)
{
- test_server_activity(&last_server_answer_time);
- test_ping_pong(last_server_answer_time);
+ server_activity_test(&last_server_answer_time);
+ ping_pong_test(last_server_answer_time);
if (world.winch)
{
reset_windows_on_winch();
world.winch = 0;
change_in_client++;
}
- if (change_in_client || read_world())
+ if (change_in_client || read_worldstate())
{
if (world.turn != last_focused_turn && world.focus_each_turn)
{