Struct WebServerManager

Source
pub struct WebServerManager(/* private fields */);
Expand description

Resource to track running server tasks with shutdown capabilities

Implementations§

Source§

impl WebServerManager

Source

pub fn cleanup_finished_tasks(manager: ResMut<'_, Self>)

Source

pub fn check_retry_servers(manager: ResMut<'_, Self>)

Source

pub fn changed( manager: ResMut<'_, Self>, async_executor: NonSend<'_, AsyncExecutor>, )

Source

pub fn add_server(&mut self, server: WebServer) -> WebServerResult<()>

Source

pub fn remove_server(&mut self, port: &WebPort)

Source

pub fn stop_server(&mut self, port: &WebPort)

Source

pub fn server_error(&self, port: &WebPort) -> Option<&str>

Get the last error for a server, if any

Source

pub fn server_failed(&self, port: &WebPort) -> bool

Check if a server has failed to start

Source

pub fn server_status_report( &self, ) -> Vec<(WebPort, ServerStatus, Option<String>)>

Get all servers with their status and any errors

Source

pub fn stop_all(&mut self)

Source

pub fn graceful_shutdown(&mut self, port: &WebPort)

Request graceful shutdown for a specific server

Source

pub fn graceful_shutdown_with_timeout( &mut self, port: &WebPort, timeout: Duration, commands: &mut Commands<'_, '_>, )

Request graceful shutdown for a specific server with timeout (spawns async task) This method can be called from Bevy systems and will handle the shutdown internally

Source

pub async fn graceful_shutdown_server( &mut self, port: &WebPort, timeout: Duration, ) -> bool

Source

pub async fn graceful_shutdown_all( &mut self, timeout: Duration, ) -> HashMap<WebPort, bool>

Source

pub fn has_server(&self, port: &WebPort) -> bool

Source

pub fn ports(&self) -> Vec<WebPort>

Source

pub fn len(&self) -> usize

Source

pub fn shutdown_requested(&self, port: &WebPort) -> bool

Source

pub fn active_connections(&self, port: &WebPort) -> usize

Source

pub fn shutdown_status(&self) -> HashMap<WebPort, (bool, usize)>

Source

pub fn router(&self, port: &WebPort) -> Option<&Router>

Source

pub fn router_mut(&mut self, port: &WebPort) -> Option<&mut Router>

Source

pub fn set_router(&mut self, port: &WebPort, router: Router)

Source

pub fn iter(&self) -> impl Iterator<Item = (&WebPort, &WebServer)>

Source

pub fn iter_mut(&mut self) -> impl Iterator<Item = (&WebPort, &mut WebServer)>

Source

pub fn start_server( &mut self, port: &WebPort, executor: &AsyncExecutor, ) -> WebServerResult<()>

Source

pub async fn wait_for_server_start( &self, port: &WebPort, timeout: Duration, ) -> WebServerResult<()>

Wait for server to start and return result This method will block until the server either starts successfully or fails

Source

pub fn test_bind(ip: IpAddr, port: WebPort) -> WebServerResult<()>

Test if we can bind to a specific IP and port using reliable OS-level port checking

Trait Implementations§

Source§

impl Default for WebServerManager

Source§

fn default() -> WebServerManager

Returns the “default value” for a type. Read more
Source§

impl From<WebServerConfig> for WebServerManager

Source§

fn from(config: WebServerConfig) -> Self

Converts to this type from the input type.
Source§

impl Resource for WebServerManager
where Self: Send + Sync + 'static,

Auto Trait Implementations§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> FetchWorld<ResourceMarker> for T
where T: Resource,

Source§

type Out = AsyncResource<T>

Source§

fn fetch() -> <T as FetchWorld<ResourceMarker>>::Out

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromWorld for T
where T: Default,

Source§

fn from_world(_world: &mut World) -> T

Creates Self using default().

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<U> for T
where U: From<T>,

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§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
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
Source§

impl<T> ConditionalSend for T
where T: Send,

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Settings for T
where T: 'static + Send + Sync,