Struct AgentClient 

pub struct AgentClient { /* private fields */ }

Agent client for remote custom component execution.

Connects to an AgentServer to delegate custom recognition and action execution to a separate process.

Implementations

impl AgentClient

pub fn new(identifier: Option<&str>) -> MaaResult<Self>

Create a new agent client.

Uses IPC mode by default. On older Windows versions that don’t support AF_UNIX (before Build 17063), it will automatically fall back to TCP mode.

Arguments

• identifier - Optional connection identifier for matching specific AgentServer

Example

use maa_framework::agent_client::AgentClient;

// Create with auto-generated identifier
let client = AgentClient::new(None).expect("Failed to create client");

// Create with specific identifier
let client = AgentClient::new(Some("my_agent")).expect("Failed to create client");
let id = client.identifier().expect("Failed to get identifier");
println!("Identifier: {}", id);

pub fn create_tcp(port: u16) -> MaaResult<Self>

Create an agent client with TCP connection.

The client listens on 127.0.0.1 at the specified port. If 0 is passed, an available port is automatically selected. AgentServer can use the port number from identifier() to connect via TCP.

Arguments

• port - TCP port (0-65535), 0 for auto-select

Example

use maa_framework::agent_client::AgentClient;

let client = AgentClient::create_tcp(0).expect("Failed to create TCP client");
let port = client.identifier().expect("Failed to get port");
println!("Listening on port: {}", port);

pub fn identifier(&self) -> Option<String>

Get the connection identifier.

pub fn bind(&mut self, resource: Resource) -> MaaResult<()>

Bind a resource to receive custom recognitions and actions from AgentServer.

Takes ownership of the Resource to ensure it stays alive while bound.

pub fn register_resource_sink(&mut self, resource: Resource) -> MaaResult<()>

Register resource event sink to forward events to AgentServer.

pub fn register_controller_sink( &mut self, controller: Controller, ) -> MaaResult<()>

Register controller event sink to forward events to AgentServer.

pub fn register_tasker_sink(&mut self, tasker: Tasker) -> MaaResult<()>

Register tasker event sink to forward events to AgentServer.

pub fn register_sinks( &mut self, resource: Resource, controller: Controller, tasker: Tasker, ) -> MaaResult<()>

Register all event sinks (resource, controller, tasker) at once.

pub fn connect(&self) -> MaaResult<()>

Connect to the AgentServer.

On failure, registrations added by this connection attempt are removed and MaaFramework attempts to shut down the remote session before returning an error.

pub fn disconnect(&self) -> MaaResult<()>

Disconnect from the AgentServer.

pub fn connected(&self) -> bool

Check if currently connected to AgentServer.

pub fn alive(&self) -> bool

Check if the connection is alive.

pub fn set_timeout(&self, milliseconds: i64) -> MaaResult<()>

Set the connection timeout.

Arguments

• milliseconds - Timeout in milliseconds

pub fn custom_recognition_list(&self) -> MaaResult<Vec<String>>

Get the list of custom recognitions available on the AgentServer.

pub fn custom_action_list(&self) -> MaaResult<Vec<String>>

Get the list of custom actions available on the AgentServer.

pub fn raw(&self) -> *mut MaaAgentClient

Get the raw handle pointer.

Trait Implementations

impl Drop for AgentClient

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for AgentClient

impl Sync for AgentClient