hyperlane_core/server/impl.rs
1use super::*;
2
3/// Provides a default implementation for Server.
4impl Default for Server {
5 /// Creates a new Server instance with default values.
6 ///
7 /// # Returns
8 ///
9 /// - `Self` - A new instance with default configuration.
10 #[inline(always)]
11 fn default() -> Self {
12 Self {
13 server_config: ServerConfig::default(),
14 request_config: RequestConfig::default(),
15 task_panic: Vec::new(),
16 request_error: Vec::new(),
17 route_matcher: RouteMatcher::new(),
18 request_middleware: Vec::new(),
19 response_middleware: Vec::new(),
20 }
21 }
22}
23
24/// Implements the `PartialEq` trait for `Server`.
25///
26/// This allows for comparing two `Server` instances for equality.
27impl PartialEq for Server {
28 /// Checks if two `Server` instances are equal.
29 ///
30 /// # Arguments
31 ///
32 /// - `&Self`- The other `Server` instance to compare against.
33 ///
34 /// # Returns
35 ///
36 /// - `bool`- `true` if the instances are equal, `false` otherwise.
37 #[inline]
38 fn eq(&self, other: &Self) -> bool {
39 self.get_server_config() == other.get_server_config()
40 && self.get_request_config() == other.get_request_config()
41 && self.get_route_matcher() == other.get_route_matcher()
42 && self.get_task_panic().len() == other.get_task_panic().len()
43 && self.get_request_error().len() == other.get_request_error().len()
44 && self.get_request_middleware().len() == other.get_request_middleware().len()
45 && self.get_response_middleware().len() == other.get_response_middleware().len()
46 && self
47 .get_task_panic()
48 .iter()
49 .zip(other.get_task_panic().iter())
50 .all(|pair: (&ServerHookHandler, &ServerHookHandler)| Arc::ptr_eq(pair.0, pair.1))
51 && self
52 .get_request_error()
53 .iter()
54 .zip(other.get_request_error().iter())
55 .all(|pair: (&ServerHookHandler, &ServerHookHandler)| Arc::ptr_eq(pair.0, pair.1))
56 && self
57 .get_request_middleware()
58 .iter()
59 .zip(other.get_request_middleware().iter())
60 .all(|pair: (&ServerHookHandler, &ServerHookHandler)| Arc::ptr_eq(pair.0, pair.1))
61 && self
62 .get_response_middleware()
63 .iter()
64 .zip(other.get_response_middleware().iter())
65 .all(|pair: (&ServerHookHandler, &ServerHookHandler)| Arc::ptr_eq(pair.0, pair.1))
66 }
67}
68
69/// Implements the `Eq` trait for `Server`.
70///
71/// This indicates that `Server` has a total equality relation.
72impl Eq for Server {}
73
74/// Implementation of `From` trait for converting `usize` address into `Server`.
75impl From<usize> for Server {
76 /// Converts a memory address into an owned `Server` by cloning from the reference.
77 ///
78 /// # Arguments
79 ///
80 /// - `usize` - The memory address of the `Server` instance.
81 ///
82 /// # Returns
83 ///
84 /// - `Server` - A cloned `Server` instance from the given address.
85 #[inline(always)]
86 fn from(address: usize) -> Self {
87 let server: &Server = address.into();
88 server.clone()
89 }
90}
91
92/// Implementation of `From` trait for converting `usize` address into `&Server`.
93impl From<usize> for &'static Server {
94 /// Converts a memory address into a reference to `Server`.
95 ///
96 /// # Arguments
97 ///
98 /// - `usize` - The memory address of the `Server` instance.
99 ///
100 /// # Returns
101 ///
102 /// - `&'static Server` - A reference to the `Server` at the given address.
103 ///
104 /// # Safety
105 ///
106 /// - The address is guaranteed to be a valid `Server` instance
107 /// that was previously converted from a reference and is managed by the runtime.
108 #[inline(always)]
109 fn from(address: usize) -> &'static Server {
110 unsafe { &*(address as *const Server) }
111 }
112}
113
114/// Implementation of `From` trait for converting `usize` address into `&mut Server`.
115impl From<usize> for &'static mut Server {
116 /// Converts a memory address into a mutable reference to `Server`.
117 ///
118 /// # Arguments
119 ///
120 /// - `usize` - The memory address of the `Server` instance.
121 ///
122 /// # Returns
123 ///
124 /// - `&'static mut Server` - A mutable reference to the `Server` at the given address.
125 ///
126 /// # Safety
127 ///
128 /// - The address is guaranteed to be a valid `Server` instance
129 /// that was previously converted from a reference and is managed by the runtime.
130 #[inline(always)]
131 fn from(address: usize) -> &'static mut Server {
132 unsafe { &mut *(address as *mut Server) }
133 }
134}
135
136/// Implementation of `From` trait for converting `&Server` into `usize` address.
137impl From<&Server> for usize {
138 /// Converts a reference to `Server` into its memory address.
139 ///
140 /// # Arguments
141 ///
142 /// - `&Server` - The reference to the `Server` instance.
143 ///
144 /// # Returns
145 ///
146 /// - `usize` - The memory address of the `Server` instance.
147 #[inline(always)]
148 fn from(server: &Server) -> Self {
149 server as *const Server as usize
150 }
151}
152
153/// Implementation of `From` trait for converting `&mut Server` into `usize` address.
154impl From<&mut Server> for usize {
155 /// Converts a mutable reference to `Server` into its memory address.
156 ///
157 /// # Arguments
158 ///
159 /// - `&mut Server` - The mutable reference to the `Server` instance.
160 ///
161 /// # Returns
162 ///
163 /// - `usize` - The memory address of the `Server` instance.
164 #[inline(always)]
165 fn from(server: &mut Server) -> Self {
166 server as *mut Server as usize
167 }
168}
169
170/// Implementation of `AsRef` trait for `Server`.
171impl AsRef<Server> for Server {
172 /// Converts `&Server` to `&Server` via memory address conversion.
173 ///
174 /// # Returns
175 ///
176 /// - `&Server` - A reference to the `Server` instance.
177 #[inline(always)]
178 fn as_ref(&self) -> &Self {
179 let address: usize = self.into();
180 address.into()
181 }
182}
183
184/// Implementation of `AsMut` trait for `Server`.
185impl AsMut<Server> for Server {
186 /// Converts `&mut Server` to `&mut Server` via memory address conversion.
187 ///
188 /// # Returns
189 ///
190 /// - `&mut Server` - A mutable reference to the `Server` instance.
191 #[inline(always)]
192 fn as_mut(&mut self) -> &mut Self {
193 let address: usize = self.into();
194 address.into()
195 }
196}
197
198/// Converts a `ServerConfig` into a `Server` instance.
199///
200/// This allows creating a `Server` directly from its configuration,
201/// using default values for other fields.
202impl From<ServerConfig> for Server {
203 /// Creates a new `Server` instance from the given `ServerConfig`.
204 ///
205 /// # Arguments
206 ///
207 /// - `ServerConfig` - The server configuration to use.
208 ///
209 /// # Returns
210 ///
211 /// - `Self` - A new `Server` instance with the provided configuration.
212 #[inline(always)]
213 fn from(server_config: ServerConfig) -> Self {
214 Self {
215 server_config,
216 ..Default::default()
217 }
218 }
219}
220
221/// Converts a `RequestConfig` into a `Server` instance.
222///
223/// This allows creating a `Server` directly from its request configuration,
224/// using default values for other fields.
225impl From<RequestConfig> for Server {
226 /// Creates a new `Server` instance from the given `RequestConfig`.
227 ///
228 /// # Arguments
229 ///
230 /// - `RequestConfig` - The request configuration to use.
231 ///
232 /// # Returns
233 ///
234 /// - `Self` - A new `Server` instance with the provided request configuration.
235 #[inline(always)]
236 fn from(request_config: RequestConfig) -> Self {
237 Self {
238 request_config,
239 ..Default::default()
240 }
241 }
242}
243
244/// Implementation of `Lifetime` trait for `Server`.
245impl Lifetime for Server {
246 /// Converts a reference to the server into a `'static` reference.
247 ///
248 /// # Returns
249 ///
250 /// - `&'static Self`: A reference to the server with a `'static` lifetime.
251 ///
252 /// # Safety
253 ///
254 /// - The address is guaranteed to be a valid `Server` instance
255 /// that was previously converted from a reference and is managed by the runtime.
256 #[inline(always)]
257 unsafe fn leak(&self) -> &'static Self {
258 let address: usize = self.into();
259 address.into()
260 }
261
262 /// Converts a reference to the server into a `'static` mutable reference.
263 ///
264 /// # Returns
265 ///
266 /// - `&'static mut Self`: A mutable reference to the server with a `'static` lifetime.
267 ///
268 /// # Safety
269 ///
270 /// - The address is guaranteed to be a valid `Server` instance
271 /// that was previously converted from a reference and is managed by the runtime.
272 #[inline(always)]
273 unsafe fn leak_mut(&self) -> &'static mut Self {
274 let address: usize = self.into();
275 address.into()
276 }
277}
278
279/// Represents the server, providing methods to configure and run it.
280///
281/// This struct wraps the `Server` configuration and routing logic,
282/// offering a high-level API for setting up the HTTP and WebSocket server.
283impl Server {
284 /// Registers a hook into the server's processing pipeline.
285 ///
286 /// This function dispatches the provided `HookType` to the appropriate
287 /// internal hook collection based on its variant. The hook will be executed
288 /// at the corresponding stage of request processing according to its type:
289 /// - `Panic` - Added to panic handlers for error recovery
290 /// - `RequestError` - Added to request error handlers
291 /// - `RequestMiddleware` - Added to pre-route middleware chain
292 /// - `Route` - Registered as a route handler for the specified path
293 /// - `ResponseMiddleware` - Added to post-route middleware chain
294 ///
295 /// # Arguments
296 ///
297 /// - `HookType` - The `HookType` instance containing the hook configuration and factory.
298 #[inline]
299 pub fn handle_hook(&mut self, hook: HookType) {
300 match hook {
301 HookType::TaskPanic(_, hook) => {
302 self.get_mut_task_panic().push(hook());
303 }
304 HookType::RequestError(_, hook) => {
305 self.get_mut_request_error().push(hook());
306 }
307 HookType::RequestMiddleware(_, hook) => {
308 self.get_mut_request_middleware().push(hook());
309 }
310 HookType::Route(path, hook) => {
311 self.get_mut_route_matcher().add(path, hook()).unwrap();
312 }
313 HookType::ResponseMiddleware(_, hook) => {
314 self.get_mut_response_middleware().push(hook());
315 }
316 };
317 }
318
319 /// Sets the server configuration from a JSON string.
320 ///
321 /// # Arguments
322 ///
323 /// - `AsRef<str>` - The configuration.
324 ///
325 /// # Returns
326 ///
327 /// - `&mut Self` - Reference to self for method chaining.
328 #[inline]
329 pub fn config_from_json<C>(&mut self, json: C) -> &mut Self
330 where
331 C: AsRef<str>,
332 {
333 let config: ServerConfig = serde_json::from_str(json.as_ref()).unwrap();
334 self.set_server_config(config);
335 self
336 }
337
338 /// Sets the server configuration.
339 ///
340 /// # Arguments
341 ///
342 /// - `ServerConfig` - The server configuration.
343 ///
344 /// # Returns
345 ///
346 /// - `&mut Self` - Reference to self for method chaining.
347 #[inline(always)]
348 pub fn server_config(&mut self, config: ServerConfig) -> &mut Self {
349 self.set_server_config(config);
350 self
351 }
352
353 /// Sets the HTTP request config.
354 ///
355 /// # Arguments
356 ///
357 /// - `RequestConfig`- The HTTP request config to set.
358 ///
359 /// # Returns
360 ///
361 /// - `&mut Self` - Reference to self for method chaining.
362 #[inline(always)]
363 pub fn request_config(&mut self, config: RequestConfig) -> &mut Self {
364 self.set_request_config(config);
365 self
366 }
367
368 /// Registers a task panic handler to the processing pipeline.
369 ///
370 /// This method allows registering task panic handlers that implement the `ServerHook` trait,
371 /// which will be executed when a panic occurs during request processing.
372 ///
373 /// # Returns
374 ///
375 /// - `&mut Self` - Reference to self for method chaining.
376 #[inline(always)]
377 pub fn task_panic<S>(&mut self) -> &mut Self
378 where
379 S: ServerHook,
380 {
381 self.get_mut_task_panic().push(Hook::factory::<S>());
382 self
383 }
384
385 /// Registers a request error handler to the processing pipeline.
386 ///
387 /// This method allows registering request error handlers that implement the `ServerHook` trait,
388 /// which will be executed when a request error occurs during HTTP request processing.
389 ///
390 /// # Returns
391 ///
392 /// - `&mut Self` - Reference to self for method chaining.
393 #[inline(always)]
394 pub fn request_error<S>(&mut self) -> &mut Self
395 where
396 S: ServerHook,
397 {
398 self.get_mut_request_error().push(Hook::factory::<S>());
399 self
400 }
401
402 /// Registers a route hook for a specific path.
403 ///
404 /// This method allows registering route handlers that implement the `ServerHook` trait,
405 /// providing type safety and better code organization.
406 ///
407 /// # Arguments
408 ///
409 /// - `AsRef<str>` - The route path pattern.
410 ///
411 /// # Returns
412 ///
413 /// - `&mut Self` - Reference to self for method chaining.
414 #[inline(always)]
415 pub fn route<S>(&mut self, path: impl AsRef<str>) -> &mut Self
416 where
417 S: ServerHook,
418 {
419 self.get_mut_route_matcher()
420 .add(path.as_ref(), Hook::factory::<S>())
421 .unwrap();
422 self
423 }
424
425 /// Registers request middleware to the processing pipeline.
426 ///
427 /// This method allows registering middleware that implements the `ServerHook` trait,
428 /// which will be executed before route handlers for every incoming request.
429 ///
430 /// # Returns
431 ///
432 /// - `&mut Self` - Reference to self for method chaining.
433 #[inline(always)]
434 pub fn request_middleware<S>(&mut self) -> &mut Self
435 where
436 S: ServerHook,
437 {
438 self.get_mut_request_middleware().push(Hook::factory::<S>());
439 self
440 }
441
442 /// Registers response middleware to the processing pipeline.
443 ///
444 /// This method allows registering middleware that implements the `ServerHook` trait,
445 /// which will be executed after route handlers for every outgoing response.
446 ///
447 /// # Returns
448 ///
449 /// - `&mut Self` - Reference to self for method chaining.
450 #[inline(always)]
451 pub fn response_middleware<S>(&mut self) -> &mut Self
452 where
453 S: ServerHook,
454 {
455 self.get_mut_response_middleware()
456 .push(Hook::factory::<S>());
457 self
458 }
459
460 /// Format the host and port into a bindable address string.
461 ///
462 /// # Arguments
463 ///
464 /// - `AsRef<str>` - The host address.
465 /// - `u16` - The port number.
466 ///
467 /// # Returns
468 ///
469 /// - `String` - The formatted address string in the form "host:port".
470 #[inline(always)]
471 pub fn format_bind_address<H>(host: H, port: u16) -> String
472 where
473 H: AsRef<str>,
474 {
475 format!("{}{COLON}{port}", host.as_ref())
476 }
477
478 /// Flushes the standard output stream.
479 ///
480 /// # Returns
481 ///
482 /// - `io::Result<()>` - The result of the flush operation.
483 #[inline(always)]
484 pub fn try_flush_stdout() -> io::Result<()> {
485 stdout().flush()
486 }
487
488 /// Flushes the standard output stream.
489 ///
490 /// # Panics
491 ///
492 /// This function will panic if the flush operation fails.
493 #[inline(always)]
494 pub fn flush_stdout() {
495 stdout().flush().unwrap();
496 }
497
498 /// Flushes the standard error stream.
499 ///
500 /// # Returns
501 ///
502 /// - `io::Result<()>` - The result of the flush operation.
503 #[inline(always)]
504 pub fn try_flush_stderr() -> io::Result<()> {
505 stderr().flush()
506 }
507
508 /// Flushes the standard error stream.
509 ///
510 /// # Panics
511 ///
512 /// This function will panic if the flush operation fails.
513 #[inline(always)]
514 pub fn flush_stderr() {
515 stderr().flush().unwrap();
516 }
517
518 /// Flushes both the standard output and error streams.
519 ///
520 /// # Returns
521 ///
522 /// - `io::Result<()>` - The result of the flush operation.
523 #[inline(always)]
524 pub fn try_flush_stdout_and_stderr() -> io::Result<()> {
525 Self::try_flush_stdout()?;
526 Self::try_flush_stderr()
527 }
528
529 /// Flushes both the standard output and error streams.
530 ///
531 /// # Panics
532 ///
533 /// This function will panic if either flush operation fails.
534 #[inline(always)]
535 pub fn flush_stdout_and_stderr() {
536 Self::flush_stdout();
537 Self::flush_stderr();
538 }
539
540 /// Spawns a task handler for a given stream and hook.
541 ///
542 /// # Arguments
543 ///
544 /// - `usize` - The address of the stream.
545 /// - `usize` - The address of the context.
546 /// - `Future<Output = ()> + Send + 'static` - The hook to execute.
547 ///
548 /// # Safety
549 ///
550 /// - The address is guaranteed to be a valid `Context` instance
551 /// that was previously converted from a reference and is managed by the runtime.
552 async fn task_handler<F>(&'static self, stream_address: usize, ctx_address: usize, hook: F)
553 where
554 F: Future<Output = ()> + Send + 'static,
555 {
556 if let Err(error) = spawn(hook).await
557 && error.is_panic()
558 {
559 let ctx: &mut Context = ctx_address.into();
560 let stream: &mut Stream = stream_address.into();
561 let panic: PanicData = PanicData::from_join_error(error);
562 ctx.set_task_panic(panic)
563 .get_mut_response()
564 .set_status_code(HttpStatus::InternalServerError.code());
565 stream.set_closed(false);
566 for hook in self.get_task_panic().iter() {
567 if hook(stream, ctx).await.is_reject() {
568 break;
569 }
570 }
571 unsafe {
572 let _: Box<Context> = Box::from_raw(ctx);
573 let _: Box<Stream> = Box::from_raw(stream);
574 }
575 };
576 }
577
578 /// Configures socket options for a newly accepted `TcpStream`.
579 ///
580 /// This applies settings like `TCP_NODELAY`, and `IP_TTL` from the server's configuration.
581 ///
582 /// # Arguments
583 ///
584 /// - `&TcpStream` - A reference to the `TcpStream` to configure.
585 fn configure_stream(&self, stream: &TcpStream) {
586 let config: &ServerConfig = self.get_server_config();
587 if let Some(nodelay) = config.try_get_nodelay() {
588 let _: Result<(), std::io::Error> = stream.set_nodelay(*nodelay);
589 }
590 if let Some(ttl) = config.try_get_ttl() {
591 let _: Result<(), std::io::Error> = stream.set_ttl(*ttl);
592 }
593 }
594
595 /// Executes trait-based request middleware in sequence.
596 ///
597 /// # Arguments
598 ///
599 /// - `&mut Stream` - The `Stream` for the current request.
600 /// - `&mut Context` - The `Context` for the current request.
601 ///
602 /// # Returns
603 ///
604 /// - `bool` - `true` if the lifecycle was aborted, `false` otherwise.
605 pub(super) async fn handle_request_middleware(
606 &self,
607 stream: &mut Stream,
608 ctx: &mut Context,
609 ) -> bool {
610 for hook in self.get_request_middleware().iter() {
611 if hook(stream, ctx).await.is_reject() {
612 return true;
613 }
614 }
615 false
616 }
617
618 /// Executes a trait-based route hook if one matches.
619 ///
620 /// # Arguments
621 ///
622 /// - `&mut Stream` - The `Stream` for the current request.
623 /// - `&mut Context` - The `Context` for the current request.
624 /// - `&str` - The request path to match.
625 ///
626 /// # Returns
627 ///
628 /// - `bool` - `true` if the lifecycle was aborted, `false` otherwise.
629 pub(super) async fn handle_route_matcher(
630 &self,
631 stream: &mut Stream,
632 ctx: &mut Context,
633 path: &str,
634 ) -> bool {
635 if let Some(hook) = self.get_route_matcher().try_resolve_route(ctx, path)
636 && hook(stream, ctx).await.is_reject()
637 {
638 return true;
639 }
640 false
641 }
642
643 /// Executes trait-based response middleware in sequence.
644 ///
645 /// # Arguments
646 ///
647 /// - `&mut Stream` - The `Stream` for the current request.
648 /// - `&mut Context` - The `Context` for the current request.
649 ///
650 /// # Returns
651 ///
652 /// - `bool` - `true` if the lifecycle was aborted, `false` otherwise.
653 pub(super) async fn handle_response_middleware(
654 &self,
655 stream: &mut Stream,
656 ctx: &mut Context,
657 ) -> bool {
658 for hook in self.get_response_middleware().iter() {
659 if hook(stream, ctx).await.is_reject() {
660 return true;
661 }
662 }
663 false
664 }
665
666 /// Handles errors that occur while processing HTTP requests.
667 ///
668 /// # Arguments
669 ///
670 /// - `&mut Stream` - The `Stream` for the current request.
671 /// - `&mut Context` - The `Context` for the current request.
672 /// - `&RequestError` - The error that occurred.
673 pub async fn handle_request_error(
674 &self,
675 stream: &mut Stream,
676 ctx: &mut Context,
677 error: &RequestError,
678 ) {
679 ctx.set_request_error_data(error.clone());
680 stream.set_closed(false);
681 for hook in self.get_request_error().iter() {
682 if hook(stream, ctx).await.is_reject() {
683 return;
684 }
685 }
686 }
687
688 /// The core request handling pipeline.
689 ///
690 /// This function orchestrates the execution of request middleware, the route hook,
691 /// and response middleware. It supports both function-based and trait-based handlers.
692 ///
693 /// # Arguments
694 ///
695 /// - `&mut Stream` - The `Stream` for the current request.
696 /// - `&mut Context` - The `Context` for the current request.
697 /// - `&Request` - The incoming request to be processed.
698 ///
699 /// # Returns
700 ///
701 /// - `bool` - A boolean indicating whether the connection should be kept alive.
702 async fn request_hook(
703 &self,
704 stream: &mut Stream,
705 ctx: &mut Context,
706 request: &Request,
707 ) -> bool {
708 let mut response: Response = Response::default();
709 response.set_version(request.get_version().clone());
710 ctx.set_request(request.clone());
711 ctx.set_response(response);
712 ctx.set_route_params(RouteParams::default());
713 ctx.clear_attribute();
714 stream.set_closed(false);
715 let keep_alive: bool = request.is_enable_keep_alive();
716 if self.handle_request_middleware(stream, ctx).await {
717 return stream.is_keep_alive(keep_alive);
718 }
719 let route: &str = request.get_path();
720 if self.handle_route_matcher(stream, ctx, route).await {
721 return stream.is_keep_alive(keep_alive);
722 }
723 if self.handle_response_middleware(stream, ctx).await {
724 return stream.is_keep_alive(keep_alive);
725 }
726 stream.is_keep_alive(keep_alive)
727 }
728
729 /// Handles subsequent HTTP requests on a persistent (keep-alive) connection.
730 ///
731 /// # Arguments
732 ///
733 /// - `&mut Stream` - The `Stream` for the current request.
734 /// - `&mut Context` - The `Context` for the current request.
735 /// - `&Request` - The initial request that established the keep-alive connection.
736 async fn handle_http_requests(
737 &self,
738 stream: &mut Stream,
739 ctx: &mut Context,
740 request: &Request,
741 ) {
742 if !self.request_hook(stream, ctx, request).await {
743 return;
744 }
745 loop {
746 match stream.try_get_http_request().await {
747 Ok(new_request) => {
748 if !self.request_hook(stream, ctx, &new_request).await {
749 return;
750 }
751 }
752 Err(error) => {
753 self.handle_request_error(stream, ctx, &error).await;
754 return;
755 }
756 }
757 }
758 }
759
760 /// Handles a single client connection, determining whether it's an HTTP or WebSocket request.
761 ///
762 /// It reads the initial request from the stream and dispatches it to the appropriate hook.
763 ///
764 /// # Arguments
765 ///
766 /// - `&mut Stream` - The `Stream` for the current request.
767 /// - `&mut Context` - The `Context` for the current request.
768 ///
769 /// # Safety
770 ///
771 /// - The `ctx` is a valid pointer to a `Context` that was
772 /// originally created via `Box::into_raw` and is now being reclaimed.
773 async fn handle_connection(&self, stream: &mut Stream, ctx: &mut Context) {
774 match stream.try_get_http_request().await {
775 Ok(request) => {
776 self.handle_http_requests(stream, ctx, &request).await;
777 }
778 Err(error) => {
779 self.handle_request_error(stream, ctx, &error).await;
780 }
781 }
782 unsafe {
783 let _: Box<Context> = Box::from_raw(ctx);
784 let _: Box<Stream> = Box::from_raw(stream);
785 }
786 }
787
788 /// Enters a loop to accept incoming TCP connections and spawn handlers for them.
789 ///
790 /// # Arguments
791 ///
792 /// - `&TcpListener` - A reference to the `TcpListener` to accept connections from.
793 async fn tcp_accept(&'static self, tcp_listener: &TcpListener) {
794 loop {
795 if let Ok((stream, _)) = tcp_listener.accept().await {
796 self.configure_stream(&stream);
797 let request_config: RequestConfig = *self.get_request_config();
798 let stream: &'static mut Stream =
799 Box::leak(Box::new(Stream::new(stream, request_config, false)));
800 let ctx: &'static mut Context = Box::leak(Box::new(Context::default()));
801 spawn(self.task_handler(
802 stream.into(),
803 ctx.into(),
804 self.handle_connection(stream, ctx),
805 ));
806 }
807 }
808 }
809
810 /// Starts the server, binds to the configured address, and begins listening for connections.
811 ///
812 /// This is the main entry point to launch the server. It will initialize the panic hook,
813 /// create a TCP listener, and then enter the connection acceptance loop in a background task.
814 ///
815 /// # Returns
816 ///
817 /// Returns a `Result` containing a shutdown function on success.
818 /// Calling this function will shut down the server by aborting its main task.
819 /// Returns an error if the server fails to start.
820 pub async fn run(&self) -> Result<ServerControlHook, Box<ServerError>> {
821 let bind_address: &String = self.get_server_config().get_address();
822 let tcp_listener: TcpListener = TcpListener::bind(&bind_address)
823 .await
824 .map_err(|error: std::io::Error| Box::new(ServerError::from(error)))?;
825 let server: &'static Self = unsafe { self.leak() };
826 let (wait_sender, wait_receiver) = channel(());
827 let (shutdown_sender, mut shutdown_receiver) = channel(());
828 let accept_connections: JoinHandle<()> = spawn(async move {
829 server.tcp_accept(&tcp_listener).await;
830 let _: Result<(), tokio::sync::watch::error::SendError<()>> = wait_sender.send(());
831 });
832 let wait_hook: ServerControlHookHandler<()> = Arc::new(move || {
833 let mut wait_receiver_clone: Receiver<()> = wait_receiver.clone();
834 Box::pin(async move {
835 let _: Result<(), tokio::sync::watch::error::RecvError> =
836 wait_receiver_clone.changed().await;
837 })
838 });
839 let shutdown_hook: ServerControlHookHandler<()> = Arc::new(move || {
840 let shutdown_sender_clone: Sender<()> = shutdown_sender.clone();
841 Box::pin(async move {
842 let _: Result<(), tokio::sync::watch::error::SendError<()>> =
843 shutdown_sender_clone.send(());
844 })
845 });
846 spawn(async move {
847 let _: Result<(), tokio::sync::watch::error::RecvError> =
848 shutdown_receiver.changed().await;
849 accept_connections.abort();
850 });
851 let mut server_control_hook: ServerControlHook = ServerControlHook::default();
852 server_control_hook.set_shutdown_hook(shutdown_hook);
853 server_control_hook.set_wait_hook(wait_hook);
854 Ok(server_control_hook)
855 }
856}