naia-client 0.24.0

Provides a cross-platform client that can send/receive messages to/from a server, and has a pool of in-scope entities/components that is synced with the server.
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

cfg_if! {
    if #[cfg(feature = "transport_webrtc")] {
        pub mod webrtc;
    } else {}
}
cfg_if! {
    if #[cfg(feature = "transport_udp")] {
        pub mod udp;
    } else {}
}

mod server_addr;

pub use server_addr::ServerAddr;

pub use inner::{
    IdentityReceiver, IdentityReceiverResult, PacketReceiver, PacketSender, RecvError, SendError,
    Socket,
};

mod inner {

    use naia_shared::IdentityToken;
    pub enum IdentityReceiverResult {
        Waiting,
        Success(IdentityToken),
        ErrorResponseCode(u16),
    }

    use super::ServerAddr;

    pub struct SendError;

    pub struct RecvError;

    pub trait Socket {
        fn connect(
            self: Box<Self>,
        ) -> (
            Box<dyn IdentityReceiver>,
            Box<dyn PacketSender>,
            Box<dyn PacketReceiver>,
        );
        fn connect_with_auth(
            self: Box<Self>,
            auth_bytes: Vec<u8>,
        ) -> (
            Box<dyn IdentityReceiver>,
            Box<dyn PacketSender>,
            Box<dyn PacketReceiver>,
        );
        fn connect_with_auth_headers(
            self: Box<Self>,
            auth_headers: Vec<(String, String)>,
        ) -> (
            Box<dyn IdentityReceiver>,
            Box<dyn PacketSender>,
            Box<dyn PacketReceiver>,
        );
        fn connect_with_auth_and_headers(
            self: Box<Self>,
            auth_bytes: Vec<u8>,
            auth_headers: Vec<(String, String)>,
        ) -> (
            Box<dyn IdentityReceiver>,
            Box<dyn PacketSender>,
            Box<dyn PacketReceiver>,
        );
    }

    pub trait PacketSender: Send + Sync {
        /// Sends a packet from the Client Socket
        fn send(&self, payload: &[u8]) -> Result<(), SendError>;
        /// Get the Server's Socket address
        fn server_addr(&self) -> ServerAddr;
    }

    pub trait PacketReceiver: PacketReceiverClone + Send + Sync {
        /// Receives a packet from the Client Socket
        fn receive(&mut self) -> Result<Option<&[u8]>, RecvError>;
        /// Get the Server's Socket address
        fn server_addr(&self) -> ServerAddr;
    }

    /// Used to clone Box<dyn PacketReceiver>
    pub trait PacketReceiverClone {
        /// Clone the boxed PacketReceiver
        fn clone_box(&self) -> Box<dyn PacketReceiver>;
    }

    impl<T: 'static + PacketReceiver + Clone> PacketReceiverClone for T {
        fn clone_box(&self) -> Box<dyn PacketReceiver> {
            Box::new(self.clone())
        }
    }

    impl Clone for Box<dyn PacketReceiver> {
        fn clone(&self) -> Box<dyn PacketReceiver> {
            PacketReceiverClone::clone_box(self.as_ref())
        }
    }

    // Identity

    pub trait IdentityReceiver: IdentityReceiverClone + Send + Sync {
        ///
        fn receive(&mut self) -> IdentityReceiverResult;
    }

    /// Used to clone Box<dyn IdentityReceiver>
    pub trait IdentityReceiverClone {
        /// Clone the boxed IdentityReceiver
        fn clone_box(&self) -> Box<dyn IdentityReceiver>;
    }

    impl<T: 'static + IdentityReceiver + Clone> IdentityReceiverClone for T {
        fn clone_box(&self) -> Box<dyn IdentityReceiver> {
            Box::new(self.clone())
        }
    }

    impl Clone for Box<dyn IdentityReceiver> {
        fn clone(&self) -> Box<dyn IdentityReceiver> {
            IdentityReceiverClone::clone_box(self.as_ref())
        }
    }
}