Struct ControlPlane 

pub struct ControlPlane { /* private fields */ }

The ControlPlane service is the main entry point for the controller service.

Implementations

impl ControlPlane

ControlPlane implements the service trait for the controller service.

pub fn new(config: ControlPlaneSettings) -> Self

Create a new ControlPlane service instance This function initializes the ControlPlane with the given ID, servers, clients, and message processor. It also sets up the internal state, including the connections and channels.

Arguments

• id - The ID of the SLIM instance.
• servers - A vector of server configurations.
• clients - A vector of client configurations.
• drain_rx - A drain watch channel for graceful shutdown.
• message_processor - An Arc to the message processor instance.
• pubsub_servers - A slice of server configurations for pub/sub connections.

Returns

A new instance of ControlPlane.

pub fn with_clients(self, clients: Vec<ClientConfig>) -> Self

Take an existing ControlPlane instance and return a new one with the provided clients.

pub fn with_servers(self, servers: Vec<ServerConfig>) -> Self

Take an existing ControlPlane instance and return a new one with the provided servers.

pub async fn run(&mut self) -> Result<(), ControllerError>

Run the clients and servers of the ControlPlane service. This function starts all the servers and clients defined in the ControlPlane.

Returns

A Result indicating success or failure of the operation.

Errors

If there is an error starting any of the servers or clients, it will return a ControllerError.

pub async fn shutdown(&self) -> Result<(), ControllerError>

pub fn stop(&mut self)

Stop the ControlPlane service. This function stops all running listeners and cancels any ongoing operations. It cleans up the internal state and ensures that all resources are released properly.

pub async fn run_server( &mut self, config: ServerConfig, ) -> Result<(), ControllerError>

Run a server configuration. This function starts a server using the provided server configuration. It checks if the server is already running and if not, it starts a new server.

Trait Implementations

impl Drop for ControlPlane

ControllerServiceInternal implements Drop trait to cancel all running listeners and clean up resources.

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.