1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584
use crate::broadcast::{Broadcast, Parent}; use crate::children::Children; use crate::children_ref::ChildrenRef; use crate::config::Config; use crate::context::{BastionContext, BastionId}; use crate::envelope::Envelope; use crate::message::{BastionMessage, Message}; use crate::path::BastionPathElement; use crate::supervisor::{Supervisor, SupervisorRef}; use crate::system::SYSTEM; use core::future::Future; use tracing::{debug, trace}; use std::fmt::{self, Debug, Formatter}; distributed_api! { use std::sync::Arc; use crate::distributed::*; use artillery_core::cluster::ap::*; } /// A `struct` allowing to access the system's API to initialize it, /// start, stop and kill it and to create new supervisors and top-level /// children groups. /// /// # Example /// /// ```rust /// use bastion::prelude::*; /// /// fn main() { /// /// Creating the system's configuration... /// let config = Config::new().hide_backtraces(); /// // ...and initializing the system with it (this is required)... /// Bastion::init_with(config); /// /// // Note that `Bastion::init();` would work too and initialize /// // the system with the default config. /// /// // Starting the system... /// Bastion::start(); /// /// // Creating a new supervisor... /// let supervisor = Bastion::supervisor(|sp| { /// sp /// // ...with a specific supervision strategy... /// .with_strategy(SupervisionStrategy::OneForAll) /// // ...and some supervised children groups... /// .children(|children| { /// // ... /// # children /// }) /// .children(|children| { /// // ... /// # children /// }) /// // ...or even supervised supervisors... /// .supervisor(|sp| { /// // ... /// # sp /// }) /// }).expect("Couldn't create the supervisor."); /// /// // ...which can start supervising new children groups /// // later on... /// supervisor.children(|children| { /// // ... /// # children /// }).expect("Couldn't create the supervised children group."); /// /// // ...or broadcast messages to all its supervised children /// // and supervisors... /// supervisor.broadcast("A message containing data.").expect("Couldn't broadcast the message."); /// /// // ...and then can even be stopped or killed... /// supervisor.stop().expect("Couldn't stop the supervisor"); /// // supervisor.kill().expect("Couldn't kill the supervisor"); /// /// // Creating a new top-level children group... /// let children = Bastion::children(|children| { /// children /// // ...containing a defined number of elements... /// .with_redundancy(4) /// // ...all executing a similar future... /// .with_exec(|ctx: BastionContext| { /// async move { /// // ...receiving and matching messages... /// msg! { ctx.recv().await?, /// ref msg: &'static str => { /// // ... /// }; /// msg: &'static str => { /// // ... /// }; /// msg: &'static str =!> { /// // ... /// }; /// // ... /// _: _ => (); /// } /// /// // ... /// /// Ok(()) /// } /// }) /// }).expect("Couldn't create the children group."); /// /// // ...which can broadcast messages to all its elements... /// children.broadcast("A message containing data.").expect("Couldn't broadcast the message."); /// /// // ...and then can even be stopped or killed... /// children.stop().expect("Couldn't stop the children group."); /// // children.kill().expect("Couldn't kill the children group."); /// /// // Create a new top-level children group and getting a list /// // of reference to its elements... /// let children = Bastion::children(|children| { /// // ... /// # children.with_exec(|ctx: BastionContext| { /// # async move { /// # msg! { ctx.recv().await?, /// # _: _ => (); /// # } /// # Ok(()) /// # } /// # }) /// }).expect("Couldn't create the children group."); /// let elems: &[ChildRef] = children.elems(); /// /// // ...to then get one of its elements' reference... /// let child = &elems[0]; /// /// // ...to then "tell" it messages... /// child.tell_anonymously("A message containing data.").expect("Couldn't send the message."); /// /// // ...or "ask" it messages... /// let answer: Answer = child.ask_anonymously("A message containing data.").expect("Couldn't send the message."); /// # async { /// // ...until the child eventually answers back... /// let answer: Result<SignedMessage, ()> = run!(answer); /// # }; /// /// // ...and then even stop or kill it... /// child.stop().expect("Couldn't stop the child."); /// // child.kill().expect("Couldn't kill the child."); /// /// // Broadcasting a message to all the system's children... /// Bastion::broadcast("A message containing data.").expect("Couldn't send the message."); /// /// // Stopping or killing the system... /// Bastion::stop(); /// // Bastion::kill(); /// /// // Blocking until the system has stopped (or got killed)... /// Bastion::block_until_stopped(); /// } /// ``` pub struct Bastion { _priv: (), } impl Bastion { /// Initializes the system if it hasn't already been done, using /// the default [`Config`]. /// /// **It is required that you call `Bastion::init` or /// [`Bastion::init_with`] at least once before using any of /// bastion's features.** /// /// # Example /// /// ```rust /// use bastion::prelude::*; /// /// Bastion::init(); /// /// // You can now use bastion... /// # /// # Bastion::start(); /// # Bastion::stop(); /// # Bastion::block_until_stopped(); /// ``` /// /// [`Config`]: struct.Config.html /// [`Bastion::init_with`]: #method.init_with pub fn init() { let config = Config::default(); Bastion::init_with(config) } /// Initializes the system if it hasn't already been done, using /// the specified [`Config`]. /// /// **It is required that you call [`Bastion::init`] or /// `Bastion::init_with` at least once before using any of /// bastion's features.** /// /// # Arguments /// /// * `config` - The configuration used to initialize the system. /// /// # Example /// /// ```rust /// use bastion::prelude::*; /// /// let config = Config::new() /// .show_backtraces(); /// /// Bastion::init_with(config); /// /// // You can now use bastion... /// # /// # Bastion::start(); /// # Bastion::stop(); /// # Bastion::block_until_stopped(); /// ``` /// /// [`Config`]: struct.Config.html /// [`Bastion::init`]: #method.init pub fn init_with(config: Config) { debug!("Bastion: Initializing with config: {:?}", config); if config.backtraces().is_hide() { debug!("Bastion: Hiding backtraces."); std::panic::set_hook(Box::new(|_| ())); } lazy_static::initialize(&SYSTEM); } /// Creates a new [`Supervisor`], passes it through the specified /// `init` closure and then sends it to the system for it to /// start supervising children. /// /// This method returns a [`SupervisorRef`] referencing the newly /// created supervisor if it succeeded, or `Err(())` /// otherwise. /// /// # Arguments /// /// * `init` - The closure taking the new [`Supervisor`] as an /// argument and returning it once configured. /// /// # Example /// /// ```rust /// # use bastion::prelude::*; /// # /// # Bastion::init(); /// # /// let sp_ref: SupervisorRef = Bastion::supervisor(|sp| { /// // Configure the supervisor... /// sp.with_strategy(SupervisionStrategy::OneForOne) /// // ...and return it. /// }).expect("Couldn't create the supervisor."); /// # /// # Bastion::start(); /// # Bastion::stop(); /// # Bastion::block_until_stopped(); /// ``` /// /// [`Supervisor`]: supervisor/struct.Supervisor.html /// [`SupervisorRef`]: supervisor/struct.SupervisorRef.html pub fn supervisor<S>(init: S) -> Result<SupervisorRef, ()> where S: FnOnce(Supervisor) -> Supervisor, { debug!("Bastion: Creating supervisor."); let parent = Parent::system(); let bcast = Broadcast::new(parent, BastionPathElement::Supervisor(BastionId::new())); debug!("Bastion: Initializing Supervisor({}).", bcast.id()); let supervisor = Supervisor::new(bcast); let supervisor = init(supervisor); debug!("Supervisor({}): Initialized.", supervisor.id()); let supervisor_ref = supervisor.as_ref(); debug!("Bastion: Deploying Supervisor({}).", supervisor.id()); let msg = BastionMessage::deploy_supervisor(supervisor); let envelope = Envelope::new(msg, SYSTEM.path().clone(), SYSTEM.sender().clone()); trace!("Bastion: Sending envelope: {:?}", envelope); SYSTEM.sender().unbounded_send(envelope).map_err(|_| ())?; Ok(supervisor_ref) } /// Creates a new [`Children`], passes it through the specified /// `init` closure and then sends it to the system's default /// supervisor for it to start supervising it. /// /// This methods returns a [`ChildrenRef`] referencing the newly /// created children group it it succeeded, or `Err(())` /// otherwise. /// /// Note that the "system supervisor" is a supervisor created /// by the system at startup. /// /// # Arguments /// /// * `init` - The closure taking the new [`Children`] as an /// argument and returning it once configured. /// /// # Example /// /// ```rust /// # use bastion::prelude::*; /// # /// # Bastion::init(); /// # /// let children_ref: ChildrenRef = Bastion::children(|children| { /// // Configure the children group... /// children.with_exec(|ctx: BastionContext| { /// async move { /// // Send and receive messages... /// let opt_msg: Option<SignedMessage> = ctx.try_recv().await; /// // ...and return `Ok(())` or `Err(())` when you are done... /// Ok(()) /// /// // Note that if `Err(())` was returned, the supervisor would /// // restart the children group. /// } /// }) /// // ...and return it. /// }).expect("Couldn't create the children group."); /// # /// # Bastion::start(); /// # Bastion::stop(); /// # Bastion::block_until_stopped(); /// ``` /// /// [`Children`]: children/struct.Children.html /// [`ChildrenRef`]: children/struct.ChildrenRef.html pub fn children<C>(init: C) -> Result<ChildrenRef, ()> where C: FnOnce(Children) -> Children, { debug!("Bastion: Creating children group."); SYSTEM.supervisor().children(init) } /// Creates a new [`Children`] which will have the given closure /// as action and then sends it to the system's default supervisor. /// /// This method returns a [`ChildrenRef`] referencing the newly created children /// if the creation was successful, otherwise returns an `Err(())`. /// /// Internally this method uses the [`Bastion::children`] and [`Children::with_exec`] methods /// to create a new children. /// /// # Arguments /// * `action` - The closure which gets executed by the child. /// /// # Example /// /// ```rust /// # use bastion::prelude::*; /// # /// # Bastion::init(); /// # /// let children_ref: ChildrenRef = Bastion::spawn(|ctx: BastionContext| { /// async move { /// // ... /// Ok(()) /// } /// }).expect("Couldn't create the children group."); /// # /// # Bastion::start(); /// # Bastion::stop(); /// # Bastion::block_until_stopped(); /// ``` /// /// [`Children::with_exec`]: children/struct.Children.html#method.with_exec /// [`Bastion::children`]: #method.children /// [`Children`]: children/struct.Children.html /// [`ChildrenRef`]: children/struct.ChildrenRef.html pub fn spawn<I, F>(action: I) -> Result<ChildrenRef, ()> where I: Fn(BastionContext) -> F + Send + 'static, F: Future<Output = Result<(), ()>> + Send + 'static, { Bastion::children(|ch| ch.with_redundancy(1).with_exec(action)) } distributed_api! { // FIXME! #[allow(missing_docs)] pub fn distributed<I, F>(cluster_config: &'static ArtilleryAPClusterConfig, action: I) -> Result<ChildrenRef, ()> where I: Fn(Arc<DistributedContext>) -> F + Send + Sync + 'static, F: Future<Output = Result<(), ()>> + Send + 'static, { cluster_actor(cluster_config, action) } } /// Sends a message to the system which will then send it to all /// the root-level supervisors and their supervised children and /// supervisors, etc. /// /// This method returns `()` if it succeeded, or `Err(msg)` /// otherwise. /// /// # Arguments /// /// * `msg` - The message to send. /// /// # Example /// /// ```rust /// # use bastion::prelude::*; /// # /// # fn main() { /// # Bastion::init(); /// # /// let msg = "A message containing data."; /// Bastion::broadcast(msg).expect("Couldn't send the message."); /// /// # Bastion::children(|children| { /// # children.with_exec(|ctx: BastionContext| { /// # async move { /// // And then in every children groups's elements' future... /// msg! { ctx.recv().await?, /// ref msg: &'static str => { /// assert_eq!(msg, &"A message containing data."); /// }; /// // We are only broadcasting a `&'static str` in this /// // example, so we know that this won't happen... /// _: _ => (); /// } /// # /// # Ok(()) /// # } /// # }) /// # }).unwrap(); /// # /// # Bastion::start(); /// # Bastion::stop(); /// # Bastion::block_until_stopped(); /// # } /// ``` pub fn broadcast<M: Message>(msg: M) -> Result<(), M> { debug!("Bastion: Broadcasting message: {:?}", msg); let msg = BastionMessage::broadcast(msg); let envelope = Envelope::from_dead_letters(msg); trace!("Bastion: Sending envelope: {:?}", envelope); // FIXME: panics? SYSTEM .sender() .unbounded_send(envelope) .map_err(|err| err.into_inner().into_msg().unwrap()) } /// Sends a message to the system to tell it to start /// handling messages and running children. /// /// # Example /// /// ```rust /// use bastion::prelude::*; /// /// Bastion::init(); /// /// // Use bastion, spawn children and supervisors... /// /// Bastion::start(); /// /// // The system will soon start, messages will /// // now be handled... /// # /// # Bastion::stop(); /// # Bastion::block_until_stopped(); /// ``` pub fn start() { debug!("Bastion: Starting."); let msg = BastionMessage::start(); let envelope = Envelope::from_dead_letters(msg); trace!("Bastion: Sending envelope: {:?}", envelope); // FIXME: Err(Error) SYSTEM.sender().unbounded_send(envelope).ok(); } /// Sends a message to the system to tell it to stop /// every running children groups and supervisors. /// /// # Example /// /// ```rust /// use bastion::prelude::*; /// /// Bastion::init(); /// /// // Use bastion, spawn children and supervisors... /// /// Bastion::start(); /// /// // Send messages to children and/or do some /// // work until you decide to stop the system... /// /// Bastion::stop(); /// # Bastion::block_until_stopped(); /// ``` pub fn stop() { debug!("Bastion: Stopping."); let msg = BastionMessage::stop(); let envelope = Envelope::from_dead_letters(msg); trace!("Bastion: Sending envelope: {:?}", envelope); // FIXME: Err(Error) SYSTEM.sender().unbounded_send(envelope).ok(); } /// Sends a message to the system to tell it to kill every /// running children groups and supervisors /// /// # Example /// /// ```rust /// use bastion::prelude::*; /// /// Bastion::init(); /// /// // Use bastion, spawn children and supervisors... /// /// Bastion::start(); /// // Send messages to children and/or do some /// // work until you decide to kill the system... /// /// Bastion::kill(); /// # Bastion::block_until_stopped(); /// ``` pub fn kill() { debug!("Bastion: Killing."); let msg = BastionMessage::kill(); let envelope = Envelope::from_dead_letters(msg); trace!("Bastion: Sending envelope: {:?}", envelope); // FIXME: Err(Error) SYSTEM.sender().unbounded_send(envelope).ok(); let handle = SYSTEM.handle(); let system = crate::executor::run(async { handle.lock().await.take() }); if let Some(system) = system { debug!("Bastion: Cancelling system handle."); system.cancel(); } SYSTEM.notify_stopped(); } /// Blocks the current thread until the system is stopped /// (either by calling [`Bastion::stop()`] or /// [`Bastion::kill`]). /// /// # Example /// /// ```rust /// use bastion::prelude::*; /// /// Bastion::init(); /// /// // Use bastion, spawn children and supervisors... /// /// Bastion::start(); /// // Send messages to children and/or do some /// // work... /// /// # Bastion::stop(); /// Bastion::block_until_stopped(); /// // The system is now stopped. A child might have /// // stopped or killed it... /// ``` /// /// [`Bastion::stop()`]: #method.stop /// [`Bastion::kill()`]: #method.kill pub fn block_until_stopped() { debug!("Bastion: Blocking until system is stopped."); SYSTEM.wait_until_stopped(); } } impl Debug for Bastion { fn fmt(&self, fmt: &mut Formatter) -> fmt::Result { fmt.debug_struct("Bastion").finish() } }