netxserver 2.2.0

netx server assembly.
Documentation
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
use anyhow::{bail, Result};
use bytes::BufMut;
use data_rw::Data;
use std::sync::{Arc, Weak};
use tokio::io::{AsyncReadExt, ReadHalf};

#[cfg(all(feature = "tcpserver", not(feature = "tcp-channel-server")))]
use tcpserver::{Builder, IPeer, ITCPServer, TCPPeer};

use crate::async_token::{IAsyncToken, IAsyncTokenInner, NetxToken};
use crate::async_token_manager::{IAsyncTokenManager, TokenManager};
use crate::controller::ICreateController;
use crate::owned_read_half_ex::ReadHalfExt;
use crate::server::async_token_manager::{
    AsyncTokenManager, IAsyncTokenManagerCreateToken, ITokenManager,
};
use crate::server::maybe_stream::MaybeStream;
use crate::{RetResult, ServerOption};
#[cfg(feature = "tcp-channel-server")]
use tcp_channel_server::{Builder, ITCPServer, TCPPeer};

cfg_if::cfg_if! {
if #[cfg(feature = "use_openssl")]{
   use openssl::ssl::{Ssl,SslAcceptor};
   use tokio_openssl::SslStream;
   use std::time::Duration;
   use tokio::time::sleep;
   use std::pin::Pin;
}else if #[cfg(feature = "use_rustls")]{
   use tokio_rustls::TlsAcceptor;
}}

/// Type alias for `NetPeer` when the `tcpserver` feature is enabled and the `tcp-channel-server` feature is not enabled.
#[cfg(all(feature = "tcpserver", not(feature = "tcp-channel-server")))]
pub type NetPeer = aqueue::Actor<TCPPeer<MaybeStream>>;

/// Type alias for `NetPeer` when the `tcp-channel-server` feature is enabled.
#[cfg(feature = "tcp-channel-server")]
pub type NetPeer = TCPPeer<MaybeStream>;

/// Type alias for `NetReadHalf` which is a `ReadHalf` of `MaybeStream`.
pub type NetReadHalf = ReadHalf<MaybeStream>;

/// Enum representing special function tags.
pub(crate) enum SpecialFunctionTag {
    Connect = 2147483647,
    Disconnect = 2147483646,
    Closed = 2147483645,
}

/// Inner structure of `NetXServer` containing server options and async tokens.
struct NetXServerInner<T: ICreateController + 'static> {
    option: ServerOption,
    async_tokens: TokenManager<T>,
}

/// NetX Service structure.
pub struct NetXServer<T: ICreateController + 'static> {
    inner: Arc<NetXServerInner<T>>,
    serv: Arc<dyn ITCPServer<Arc<NetXServerInner<T>>>>,
}

/// Implement `Send` for `NetXServer`.
unsafe impl<T: ICreateController + 'static> Send for NetXServer<T> {}

/// Implement `Sync` for `NetXServer`.
unsafe impl<T: ICreateController + 'static> Sync for NetXServer<T> {}

impl<T> NetXServer<T>
where
    T: ICreateController + 'static,
{
    cfg_if::cfg_if! {
        if #[cfg(feature = "use_openssl")] {
            /// Creates a new `NetXServer` instance with OpenSSL TLS encryption.
            ///
            /// # Arguments
            ///
            /// * `ssl_acceptor` - A reference to the `SslAcceptor` used for SSL/TLS connections.
            /// * `option` - The server options.
            /// * `impl_controller` - The controller implementation.
            ///
            /// # Returns
            ///
            /// A new instance of `NetXServer`.
            ///
            /// # Errors
            ///
            /// This function will return an error if the SSL/TLS stream initialization fails.
            #[inline]
            pub async fn new_ssl(
                ssl_acceptor: &'static SslAcceptor,
                option: ServerOption,
                impl_controller: T,
            ) -> NetXServer<T> {
                let request_out_time = option.request_out_time;
                let session_save_time = option.session_save_time;
                let async_tokens =
                    AsyncTokenManager::new(impl_controller, request_out_time, session_save_time);
                let inner = Arc::new(NetXServerInner {
                    option,
                    async_tokens,
                });
                let serv = Builder::new(&inner.option.addr)
                    .set_connect_event(|addr| {
                        log::debug!("{} connect", addr);
                        true
                    })
                    .set_stream_init(move |tcp_stream| async move {
                        let ssl = Ssl::new(ssl_acceptor.context())?;
                        let mut stream = SslStream::new(ssl, tcp_stream)?;
                        sleep(Duration::from_millis(200)).await;
                        Pin::new(&mut stream).accept().await?;
                        Ok(MaybeStream::ServerSsl(stream))
                    })
                    .set_input_event(|mut reader, peer, inner| async move {
                        let addr = peer.addr();
                        let token = match Self::get_peer_token(&mut reader, &peer, &inner).await {
                            Ok(token) => token,
                            Err(er) => {
                                log::debug!("user:{}:{},disconnect it", addr, er);
                                return Ok(());
                            }
                        };
                        token.set_peer(Some(peer)).await;
                        let res=Self::read_buff_byline(&mut reader, &token).await;
                        token.set_peer(None).await;
                        token
                            .call_special_function(SpecialFunctionTag::Disconnect as i32)
                            .await?;
                        inner
                            .async_tokens
                            .peer_disconnect(token.get_session_id())
                            .await;
                        res?;
                        Ok(())
                    })
                    .build()
                    .await;
                NetXServer { inner, serv }
            }
        } else if #[cfg(feature = "use_rustls")] {
            /// Creates a new `NetXServer` instance with Rustls TLS encryption.
            ///
            /// # Arguments
            ///
            /// * `acceptor` - A reference to the `TlsAcceptor` used for TLS connections.
            /// * `option` - The server options.
            /// * `impl_controller` - The controller implementation.
            ///
            /// # Returns
            ///
            /// A new instance of `NetXServer`.
            ///
            /// # Errors
            ///
            /// This function will return an error if the TLS stream initialization fails.
            #[inline]
            pub async fn new_tls(
                acceptor:&'static TlsAcceptor,
                option: ServerOption,
                impl_controller: T,
            ) -> NetXServer<T> {
                let request_out_time = option.request_out_time;
                let session_save_time = option.session_save_time;
                let async_tokens =
                    AsyncTokenManager::new(impl_controller, request_out_time, session_save_time);
                let inner = Arc::new(NetXServerInner {
                    option,
                    async_tokens,
                });
                let serv = Builder::new(&inner.option.addr)
                    .set_connect_event(|addr| {
                        log::debug!("{} connect", addr);
                        true
                    })
                    .set_stream_init(move |tcp_stream| async move {
                       Ok(MaybeStream::ServerTls(acceptor.accept(tcp_stream).await?))
                    })
                    .set_input_event(|mut reader, peer, inner| async move {
                        let addr = peer.addr();
                        let token = match Self::get_peer_token(&mut reader, &peer, &inner).await {
                            Ok(token) => token,
                            Err(er) => {
                                log::debug!("user:{}:{},disconnect it", addr, er);
                                return Ok(());
                            }
                        };
                        token.set_peer(Some(peer)).await;
                        let res=Self::read_buff_byline(&mut reader,  &token).await;
                        token.set_peer(None).await;
                        token
                            .call_special_function(SpecialFunctionTag::Disconnect as i32)
                            .await?;
                        inner
                            .async_tokens
                            .peer_disconnect(token.get_session_id())
                            .await;
                        res?;
                        Ok(())
                    })
                    .build()
                    .await;
                NetXServer { inner, serv }
            }
        }
    }

    /// Creates a new `NetXServer` instance.
    ///
    /// # Arguments
    ///
    /// * `option` - The server options.
    /// * `impl_controller` - The controller implementation.
    ///
    /// # Returns
    ///
    /// A new instance of `NetXServer`.
    ///
    /// # Errors
    ///
    /// This function will return an error if the server initialization fails.
    #[inline]
    pub async fn new(option: ServerOption, impl_controller: T) -> NetXServer<T> {
        let request_out_time = option.request_out_time;
        let session_save_time = option.session_save_time;
        let async_tokens =
            AsyncTokenManager::new(impl_controller, request_out_time, session_save_time);
        let inner = Arc::new(NetXServerInner {
            option,
            async_tokens,
        });
        let serv = Builder::new(&inner.option.addr)
            .set_connect_event(|addr| {
                log::debug!("{} connect", addr);
                true
            })
            .set_stream_init(|tcp_stream| async move { Ok(MaybeStream::Plain(tcp_stream)) })
            .set_input_event(|mut reader, peer, inner| async move {
                let addr = peer.addr();
                let token = match Self::get_peer_token(&mut reader, &peer, &inner).await {
                    Ok(token) => token,
                    Err(er) => {
                        log::debug!("user:{}:{},disconnect it", addr, er);
                        return Ok(());
                    }
                };
                token.set_peer(Some(peer)).await;
                let res = Self::read_buff_byline(&mut reader, &token).await;
                token.set_peer(None).await;
                token
                    .call_special_function(SpecialFunctionTag::Disconnect as i32)
                    .await?;
                inner
                    .async_tokens
                    .peer_disconnect(token.get_session_id())
                    .await;
                res?;
                Ok(())
            })
            .build()
            .await;
        NetXServer { inner, serv }
    }

    /// Retrieves the peer token by reading and verifying the peer's credentials.
    ///
    /// # Arguments
    ///
    /// * `reader` - A mutable reference to the `NetReadHalf` reader.
    /// * `peer` - An `Arc` reference to the `NetPeer`.
    /// * `inner` - An `Arc` reference to the `NetXServerInner` containing server options and async tokens.
    ///
    /// # Returns
    ///
    /// A `Result` containing the `NetxToken` if successful, or an error if the verification fails.
    ///
    /// # Errors
    ///
    /// This function will return an error if the verification key, service name, or password is incorrect.
    #[inline]
    async fn get_peer_token(
        mut reader: &mut NetReadHalf,
        peer: &Arc<NetPeer>,
        inner: &Arc<NetXServerInner<T>>,
    ) -> Result<NetxToken<T::Controller>> {
        let cmd = reader.read_i32_le().await?;
        if cmd != 1000 {
            Self::send_to_key_verify_msg(peer, true, "not verify key").await?;
            bail!("not verify key")
        }
        let name = reader.read_string().await?;
        if !inner.option.service_name.is_empty() && name != inner.option.service_name {
            Self::send_to_key_verify_msg(peer, true, "service name error").await?;
            bail!("IP:{} service name:{} error", peer.addr(), name)
        }
        let password = reader.read_string().await?;
        if !inner.option.verify_key.is_empty() && password != inner.option.verify_key {
            Self::send_to_key_verify_msg(peer, true, "service verify key error").await?;
            bail!("IP:{} verify key:{} error", peer.addr(), name)
        }
        Self::send_to_key_verify_msg(peer, false, "verify success").await?;
        let session = reader.read_i64_le().await?;
        let token = if session == 0 {
            inner
                .async_tokens
                .create_token(Arc::downgrade(&inner.async_tokens))
                .await?
        } else {
            match inner.async_tokens.get_token(session).await {
                Some(token) => token,
                None => {
                    inner
                        .async_tokens
                        .create_token(Arc::downgrade(&inner.async_tokens))
                        .await?
                }
            }
        };

        Ok(token)
    }

    /// Reads data from the buffer line by line and processes it.
    ///
    /// # Arguments
    ///
    /// * `reader` - A mutable reference to the `NetReadHalf` reader.
    /// * `token` - A reference to the `NetxToken`.
    ///
    /// # Returns
    ///
    /// A `Result` indicating success or failure.
    #[inline]
    async fn read_buff_byline(
        reader: &mut NetReadHalf,
        token: &NetxToken<T::Controller>,
    ) -> Result<()> {
        token
            .call_special_function(SpecialFunctionTag::Connect as i32)
            .await?;
        Self::data_reading(reader, token).await?;
        Ok(())
    }

    /// Reads data from the buffer and processes commands.
    ///
    /// # Arguments
    ///
    /// * `reader` - A mutable reference to the `NetReadHalf` reader.
    /// * `token` - A reference to the `NetxToken`.
    ///
    /// # Returns
    ///
    /// A `Result` indicating success or failure.
    #[inline]
    async fn data_reading(
        mut reader: &mut NetReadHalf,
        token: &NetxToken<T::Controller>,
    ) -> Result<()> {
        while let Ok(mut dr) = reader.read_buff().await {
            let cmd = dr.read_fixed::<i32>()?;
            match cmd {
                2000 => {
                    Self::send_to_session_id(token).await?;
                }
                2400 => {
                    let tt = dr.read_fixed::<u8>()?;
                    let cmd = dr.read_fixed::<i32>()?;
                    let serial = dr.read_fixed::<i64>()?;
                    match tt {
                        0 => {
                            let run_token = token.clone();
                            tokio::spawn(async move {
                                let _ = run_token.execute_controller(tt, cmd, dr).await;
                            });
                        }
                        1 => {
                            let run_token = token.clone();
                            tokio::spawn(async move {
                                let res = run_token.execute_controller(tt, cmd, dr).await;
                                if let Err(er) = run_token
                                    .send(Self::get_result_buff(serial, res).into_inner())
                                    .await
                                {
                                    log::error!("send buff 1 error:{}", er);
                                }
                            });
                        }
                        2 => {
                            let run_token = token.clone();
                            tokio::spawn(async move {
                                let res = run_token.execute_controller(tt, cmd, dr).await;
                                if let Err(er) = run_token
                                    .send(Self::get_result_buff(serial, res).into_inner())
                                    .await
                                {
                                    log::error!("send buff {} error:{}", serial, er);
                                }
                            });
                        }
                        _ => {
                            log::error!("not found call type:{}", tt)
                        }
                    }
                }
                2500 => {
                    let serial = dr.read_fixed::<i64>()?;
                    token.set_result(serial, dr).await?;
                }
                _ => {
                    log::error!("not found cmd:{}", cmd)
                }
            }
        }
        Ok(())
    }

    /// Constructs a result buffer from the given serial and result.
    ///
    /// # Arguments
    ///
    /// * `serial` - The serial number.
    /// * `result` - The result to be included in the buffer.
    ///
    /// # Returns
    ///
    /// A `Data` object containing the serialized result.
    #[inline]
    fn get_result_buff(serial: i64, result: RetResult) -> Data {
        let mut data = Data::with_capacity(1024);

        data.write_fixed(0u32);
        data.write_fixed(2500u32);
        data.write_fixed(serial);

        if result.is_error {
            data.write_fixed(true);
            data.write_fixed(result.error_id);
            data.write_fixed(result.msg);
        } else {
            data.write_fixed(false);
            data.write_fixed(result.arguments.len() as u32);
            for argument in result.arguments {
                data.write_fixed(argument.into_inner());
            }
        }

        let len = data.len();
        (&mut data[0..4]).put_u32_le(len as u32);
        data
    }

    /// Sends the session ID to the client.
    ///
    /// # Arguments
    ///
    /// * `token` - A reference to the `NetxToken`.
    ///
    /// # Returns
    ///
    /// A `Result` indicating success or failure.
    #[inline]
    async fn send_to_session_id(token: &NetxToken<T::Controller>) -> crate::error::Result<()> {
        let session_id = token.get_session_id();
        let mut data = Data::new();
        data.write_fixed(0u32);
        data.write_fixed(2000i32);
        data.write_fixed(session_id);
        let len = data.len();
        (&mut data[0..4]).put_u32_le(len as u32);
        token.send(data.into_inner()).await
    }

    /// Sends a key verification message to the peer.
    ///
    /// # Arguments
    ///
    /// * `peer` - An `Arc` reference to the `NetPeer`.
    /// * `is_err` - A boolean indicating if there was an error.
    /// * `msg` - A message string.
    ///
    /// # Returns
    ///
    /// A `Result` indicating success or failure.
    #[inline]
    async fn send_to_key_verify_msg(
        peer: &Arc<NetPeer>,
        is_err: bool,
        msg: &str,
    ) -> crate::error::Result<()> {
        let mut data = Data::new();
        data.write_fixed(0u32);
        data.write_fixed(1000i32);
        data.write_fixed(is_err);
        data.write_fixed(msg);
        data.write_fixed(1u8);
        let len = data.len();
        (&mut data[0..4]).put_u32_le(len as u32);
        Ok(peer.send_all(data.into_inner()).await?)
    }

    /// Retrieves the token manager as a weak reference.
    ///
    /// # Returns
    ///
    /// A `Weak` reference to the `ITokenManager`.
    #[inline]
    pub fn get_token_manager(&self) -> Weak<dyn ITokenManager<T::Controller>> {
        Arc::downgrade(&self.inner.async_tokens) as Weak<dyn ITokenManager<T::Controller>>
    }

    /// Starts the server asynchronously.
    ///
    /// # Returns
    ///
    /// A `Result` containing a `JoinHandle` that resolves to a `Result`.
    #[inline]
    pub async fn start(&self) -> crate::error::Result<tokio::task::JoinHandle<Result<()>>> {
        Ok(self.serv.start(self.inner.clone()).await?)
    }

    /// Starts the server and blocks until it stops.
    ///
    /// # Returns
    ///
    /// A `Result` indicating success or failure.
    #[inline]
    pub async fn start_block(&self) -> crate::error::Result<()> {
        Ok(self.serv.start_block(self.inner.clone()).await?)
    }
}