Struct splinter::orchestrator::ServiceOrchestrator

source · [−]

pub struct ServiceOrchestrator { /* private fields */ }

Expand description

The ServiceOrchestrator manages initialization and shutdown of services.

Implementations

source

impl ServiceOrchestrator

source

pub fn new(
 service_factories: Vec<Box<dyn OrchestratableServiceFactory>>,
 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

source

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

source

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.

source

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

Stop the specified service.

source

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

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

source

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

source

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).

source

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.

source

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

Trait Implementations

source

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.

source

fn resources(&self) -> Vec<Resource>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Auto Trait Implementations

impl !RefUnwindSafe for ServiceOrchestrator

impl Send for ServiceOrchestrator

impl !Sync for ServiceOrchestrator

impl Unpin for ServiceOrchestrator

impl !UnwindSafe for ServiceOrchestrator

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

fn into_sql<T>(self) -> Self::Expression where
Self: AsExpression<T>,

Convert self to an expression for Diesel’s query builder. Read more

source

fn as_sql<'a, T>(&'a self) -> <&'a Self as AsExpression<T>>::Expression where
&'a Self: AsExpression<T>,

Convert &self to an expression for Diesel’s query builder. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct splinter::orchestrator::ServiceOrchestrator

Implementations

impl ServiceOrchestrator

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

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

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

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

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

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

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

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

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

Trait Implementations

impl RestResourceProvider for ServiceOrchestrator

fn resources(&self) -> Vec<Resource>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

Auto Trait Implementations

impl !RefUnwindSafe for ServiceOrchestrator

impl Send for ServiceOrchestrator

impl !Sync for ServiceOrchestrator

impl Unpin for ServiceOrchestrator

impl !UnwindSafe for ServiceOrchestrator

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<P, N> IntoBytes<P> for N where P: Message + FromNative<N>,

fn into_bytes(self) -> Result<Vec<u8, Global>, ProtoConversionError>

impl<N, P> IntoNative<N> for P where N: FromProto<P>,

fn into_native(self) -> Result<N, ProtoConversionError>

impl<N, P> IntoProto<P> for N where P: FromNative<N>,

fn into_proto(self) -> Result<P, ProtoConversionError>

impl<T> IntoSql for T

fn into_sql<T>(self) -> Self::Expression where Self: AsExpression<T>,

fn as_sql<'a, T>(&'a self) -> <&'a Self as AsExpression<T>>::Expression where &'a Self: AsExpression<T>,

impl<T> Same<T> for T

type Output = T

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

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

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

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

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

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

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

fn resources(&self) -> Vec<Resource>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<P, N> IntoBytes<P> for N where
P: Message + FromNative<N>,

impl<N, P> IntoNative<N> for P where
N: FromProto<P>,

impl<N, P> IntoProto<P> for N where
P: FromNative<N>,

fn into_sql<T>(self) -> Self::Expression where
Self: AsExpression<T>,

fn as_sql<'a, T>(&'a self) -> <&'a Self as AsExpression<T>>::Expression where
&'a Self: AsExpression<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,