gn_communicator

Trait Communicator

Source 
pub trait Communicator
where
    Self: Sized,
{

Show 15 methods    // Required methods
    async fn on_match_abrupt_close<F, Fut>(&self, callback: F)
       where F: MessageHandler<MatchAbrubtClose, Fut>,
             Fut: Future<Output = ()> + Send + Sync + 'static;
    async fn on_match_result<F, Fut>(&self, callback: F)
       where F: MessageHandler<MatchResult, Fut>,
             Fut: Future<Output = ()> + Send + Sync + 'static;
    async fn on_match_created<F, Fut>(&self, callback: F)
       where F: MessageHandler<CreatedMatch, Fut>,
             Fut: Future<Output = ()> + Send + Sync + 'static;
    async fn on_game_create<F, Fut>(&self, callback: F)
       where F: MessageHandler<GameServerCreate, Fut>,
             Fut: Future<Output = String> + Send + Sync + 'static;
    async fn on_health_check<F, Fut>(&self, callback: F)
       where F: MessageHandler<String, Fut>,
             Fut: Future<Output = ()> + Send + Sync + 'static;
    async fn on_match_create<F, Fut>(&self, callback: F)
       where F: MessageHandler<CreateMatch, Fut>,
             Fut: Future<Output = ()> + Send + Sync + 'static;
    async fn on_ai_register<F, Fut>(&self, callback: F)
       where F: MessageHandler<AIPlayerRegister, Fut>,
             Fut: Future<Output = ()> + Send + Sync + 'static;
    async fn create_game(
        &self,
        game_server: &GameServerCreate,
    ) -> Result<String, Box<dyn Error>>;
    async fn send_health_check(&self, client_id: String);
    async fn create_match(&self, match_request: &CreateMatch);
    async fn report_match_created(&self, created_match: &CreatedMatch);
    async fn report_match_result(&self, match_result: &MatchResult);
    async fn report_match_abrupt_close(&self, match_close: &MatchAbrubtClose);
    async fn create_ai_task(&self, task: &Task);
    async fn register_ai_player(&self, ai_player: &AIPlayerRegister);

}
Expand description

Handles communication between the game server and the matchmaker. Structs which implement the Communicator trait enable multi-device communication. This means that if a callback is registered with an “on”-function, it may be called when any device calls a “report” or “send” function.

Required Methods§

Source

async fn on_match_abrupt_close<F, Fut>(&self, callback: F)
where F: MessageHandler<MatchAbrubtClose, Fut>, Fut: Future<Output = ()> + Send + Sync + 'static,

Registers a callback for when a match is abruptly closed.

§Arguments
  • callback - A function that handles MatchAbrubtClose events.
Source

async fn on_match_result<F, Fut>(&self, callback: F)
where F: MessageHandler<MatchResult, Fut>, Fut: Future<Output = ()> + Send + Sync + 'static,

Registers a callback for when a match result is reported.

§Arguments
  • callback - A function that handles MatchResult events.
Source

async fn on_match_created<F, Fut>(&self, callback: F)
where F: MessageHandler<CreatedMatch, Fut>, Fut: Future<Output = ()> + Send + Sync + 'static,

Registers a callback for when a match is created.

§Arguments
  • callback - A function that handles CreatedMatch events.
Source

async fn on_game_create<F, Fut>(&self, callback: F)
where F: MessageHandler<GameServerCreate, Fut>, Fut: Future<Output = String> + Send + Sync + 'static,

Registers a callback for when a game server is created.

§Arguments
  • callback - A function that handles GameServerCreate events.
Source

async fn on_health_check<F, Fut>(&self, callback: F)
where F: MessageHandler<String, Fut>, Fut: Future<Output = ()> + Send + Sync + 'static,

Registers a callback for health check events.

§Arguments
  • callback - A function that handles health check events.
Source

async fn on_match_create<F, Fut>(&self, callback: F)
where F: MessageHandler<CreateMatch, Fut>, Fut: Future<Output = ()> + Send + Sync + 'static,

Registers a callback for when a match creation request is received.

§Arguments
  • callback - A function that handles CreateMatch events.
Source

async fn on_ai_register<F, Fut>(&self, callback: F)
where F: MessageHandler<AIPlayerRegister, Fut>, Fut: Future<Output = ()> + Send + Sync + 'static,

Registers a callback for when a new ai-player is registered.

§Arguments
  • callback - A function that handles AIPlayerRegister events.
Source

async fn create_game( &self, game_server: &GameServerCreate, ) -> Result<String, Box<dyn Error>>

Creates a game on the game server.

§Arguments
  • game_server - The game server creation request.
§Returns

A result containing the game server ID or an error.

Source

async fn send_health_check(&self, client_id: String)

Sends a health check to the specified client.

§Arguments
  • client_id - The ID of the client to send the health check to.
Source

async fn create_match(&self, match_request: &CreateMatch)

Creates a match based on the provided match request.

§Arguments
  • match_request - The match creation request.
Source

async fn report_match_created(&self, created_match: &CreatedMatch)

Reports that a match has been created.

§Arguments
  • created_match - The created match information.
Source

async fn report_match_result(&self, match_result: &MatchResult)

Reports the result of a match.

§Arguments
  • match_result - The match result information.
Source

async fn report_match_abrupt_close(&self, match_close: &MatchAbrubtClose)

Reports that a match was abruptly closed.

§Arguments
  • match_close - The abrupt match close information.
Source

async fn create_ai_task(&self, task: &Task)

Sends a message to create a new AI-Task.

§Arguments
  • task - The AI task information.
Source

async fn register_ai_player(&self, ai_player: &AIPlayerRegister)

Sends a message to create a new AI-Player.

§Arguments
  • ai_player - AI-Player Information.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§