Struct NodeApi 

pub struct NodeApi(/* private fields */);

Available on crate feature nodeapi only.

Implementations

impl NodeApi

pub fn new(node_info: NodeInfo) -> NodeApi

Creates a new instance of NodeApi.

Arguments

• node_info - A NodeInfo instance that holds the node information.

Returns

A new instance of NodeApi with the provided node information.

pub fn start_server( &self, ip_port_addr: &str, ) -> Result<Server<Connection>, Error>

Function to create the Ntex HTTP server This function sets up the server and routes. External users can call this function to create and run the server.

pub fn update_health(&mut self, new_health: NodeHealth)

Updates the health status of the node.

Arguments

• new_health - The new health status to be set for the node.

pub fn register_service( &mut self, id: &str, name: &str, description: &str, status: ServiceStatus, ) -> Result<(), NodeApiError>

Registers a new service with the node.

Arguments

• id - A string slice that holds the unique identifier of the service.
• name - A string slice that holds the name of the service.
• description - A string slice that holds the description of the service.
• status - The status of the service, represented by the ServiceStatus enum.

pub fn update_service_status( &mut self, service_id: &str, status: ServiceStatus, ) -> Result<(), NodeApiError>

Updates the status of a registered service.

Arguments

• service_id - A string slice that holds the unique identifier of the service.
• status - The new status to be set for the service, represented by the ServiceStatus enum.

Returns

A Result which is Ok(()) if the service status was updated successfully, or an Err with a message if the service with the specified id was not found.

pub fn deregister_service( &mut self, service_id: &str, ) -> Result<(), NodeApiError>

Deregisters a service from the node.

Arguments

• service_id - A string slice that holds the unique identifier of the service.

Returns

A Result which is Ok(()) if the service was deregistered successfully, or an Err with a message if the service with the specified id was not found.

Trait Implementations

impl Clone for NodeApi

fn clone(&self) -> NodeApi

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.