Struct splinter::orchestrator::ServiceOrchestrator

pub struct ServiceOrchestrator { /* fields omitted */ }

The ServiceOrchestrator manages initialization and shutdown of services.

Implementations

impl ServiceOrchestrator

pub fn new(
    service_factories: Vec<Box<dyn ServiceFactory>>,
    connection: Box<dyn Connection>,
    incoming_capacity: usize,
    outgoing_capacity: usize,
    channel_capacity: usize
) -> Result<Self, NewOrchestratorError>

👎 Deprecated since 0.5.1:

please use ServiceOrchestratorBuilder instead

Create a new ServiceOrchestrator. This starts up 3 threads for relaying messages to and from services. Returns the ServiceOrchestrator and the threads JoinHandles

pub fn take_shutdown_handle(
    &mut self
) -> Option<ServiceOrchestratorShutdownHandle>

pub fn initialize_service(
    &self,
    service_definition: ServiceDefinition,
    args: HashMap<String, String>
) -> Result<(), InitializeServiceError>

Initialize (create and start) a service according to the specified definition. The arguments provided must match those required to create the service.

pub fn stop_service(
    &self,
    service_definition: &ServiceDefinition
) -> Result<(), ShutdownServiceError>

Stop the specified service.

pub fn purge_service(
    &self,
    service_definition: &ServiceDefinition
) -> Result<(), InternalError>

Purge the specified service state, based on its service implementation.

pub fn shutdown_all_services(&self) -> Result<(), ShutdownServiceError>

Shut down (stop and destroy) all services managed by this ServiceOrchestrator and single the ServiceOrchestrator to shutdown

pub fn list_services(
    &self,
    circuits: Vec<String>,
    service_types: Vec<String>
) -> Result<Vec<ServiceDefinition>, ListServicesError>

List services managed by this ServiceOrchestrator; filters may be provided to only show services on specified circuit(s) and of given service type(s).

pub fn add_stopped_service(
    &self,
    service_definition: ServiceDefinition,
    args: HashMap<String, String>
) -> Result<(), AddServiceError>

Create a service that has previously been stopped according to the specified definition. The arguments provided must match those required to create the service.

pub fn supported_service_types(&self) -> &[String]

Trait Implementations

impl RestResourceProvider for ServiceOrchestrator

The ServiceOrchestrator exposes REST API resources provided by the ServiceFactory::get_rest_endpoints methods of its factories. Each factory defines the endpoints provided by the services it creates; the ServiceOrchestrator then exposes these endpoints under the /{service_type}/{circuit}/{service_id} route.

fn resources(&self) -> Vec<Resource>