socha 0.2.2

Communication layer for the software challenge germany 2025
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

use std::process::exit;

use log::info;

use crate::{
    i_client_handler::ComCancelHandler,
    internal::{GameResult, GameState, PreparedRoom},
    neutral::Move,
};

// todo: add on error
pub trait IClientHandler {
    /// called when a move was requested by the server
    fn calculate_move(&mut self) -> Move;

    /// called when the server sends a game_state_update
    /// this function is used to save the current gamestate into the struct, that implements IClientHandler
    fn on_gamestate_update(&mut self, state: GameState);

    /// called when the client has successfully joined a room
    fn on_game_joined(&mut self, room_id: &str) {
        println!("joined game with id: {}", room_id);
    }

    /// called when client left the room
    fn on_game_left(&mut self) {
        info!("client is not in game room anymore");
    }

    /// called when the result of the current game has been received
    fn on_game_result(&mut self, res: &GameResult) {
        println!("game over, exiting");
        println!("final result: \n{:#?}", res);
        exit(0)
    }

    /// called when the welcome message was received from the server
    fn on_welcome_message(&mut self) {
        info!("received welcome")
    }

    /// is ran, while the enemy is calculating their move
    /// if cancel_handler.is_canceled() returns true, the while waiting function should return as soon as possible
    #[allow(unused_variables)]
    fn while_waiting(&mut self, cancel_handler: ComCancelHandler) {}

    /// ADMIN
    /// called when a game is prepared
    #[allow(unused_variables)]
    fn on_game_prepared(&mut self, prepared: &PreparedRoom) {}

    /// ADMIN
    /// when a game was created
    fn on_create_game(&mut self) {}

    /// ADMIN
    /// called when client starts observing a room
    #[allow(unused_variables)]
    fn on_observed(&mut self, room_id: &str) {}
}