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
//
// Eventum
//   Copyright (C) 2020 Toshiaki Takada
//
// Unix Domain Socket Client.
//

use std::cell::RefCell;
use std::io::Read;
use std::io::Write;
use std::path::PathBuf;
use std::sync::Arc;
use std::sync::Weak;
use std::sync::Mutex;
use std::time::Duration;

//use log::debug;
use mio::net::UnixStream;

use super::core::*;

/// Trait UdsClient handler.
pub trait UdsClientHandler {
    /// callback when client connects to server.
    fn handle_connect(&self, entry: &UdsClient) -> Result<(), EventError>;

    /// callback when client detects server disconnected.
    fn handle_disconnect(&self, entry: &UdsClient) -> Result<(), EventError>;

    /// callback when client received message.
    fn handle_message(&self, entry: &UdsClient) -> Result<(), EventError>;
}

//unsafe impl Send for UdsClient {}
//unsafe impl Sync for UdsClient {}

/// Unix Domain Socket client entry, created per connect.
pub struct UdsClient {
    /// UdsClient Inner.
    inner: RefCell<Option<Arc<UdsClientInner>>>,
}

/// UdsClient implementation.
impl UdsClient {
    /// Constructor.
    pub fn new() -> UdsClient {
        UdsClient {
            inner: RefCell::new(None),
        }
    }

    /// Release inner.
    pub fn release(&self) {
        self.inner.replace(None);
    }

    /// Return UdsClientInner.
    pub fn get_inner(&self) -> Arc<UdsClientInner> {
        if let Some(ref mut inner) = *self.inner.borrow_mut() {
            return inner.clone();
        }

        // should not happen.
        panic!("No inner exists");
    }

    /// Start UdsClient.
    pub fn start(
        event_manager: Arc<Mutex<EventManager>>,
        handler: Arc<dyn UdsClientHandler>,
        path: &PathBuf,
    ) -> Arc<Mutex<UdsClient>> {
        let client = Arc::new(Mutex::new(UdsClient::new()));
        let inner = Arc::new(UdsClientInner::new(
            client.clone(),
            event_manager.clone(),
            handler.clone(),
            path,
        ));

        client.lock().unwrap().inner.borrow_mut().replace(inner);
        client
    }

    /// Connect to server.
    pub fn connect(&self) {
        let inner = self.get_inner();
        let event_manager = inner.get_event_manager();

        match inner.connect(self) {
            Ok(_) => {
                if let Some(ref mut stream) = *inner.stream.borrow_mut() {
                    if let Err(_) = event_manager
                        .lock()
                        .unwrap()
                        .register_read_write(stream, inner.clone())
                    {
                        self.connect_timer();
                    }
                }
            }
            Err(_) => self.connect_timer(),
        }
    }

    /// Start connect timer.
    pub fn connect_timer(&self) {
        let inner = self.get_inner();
        let event_manager = inner.get_event_manager();

        event_manager
            .lock()
            .unwrap()
            .register_timer(Duration::from_secs(5), inner.clone());
    }

    /// Send message.
    pub fn stream_send(&self, message: &str) -> Result<(), EventError> {
        self.get_inner().stream_send(message)
    }

    /// Receive message.
    pub fn stream_read(&self) -> Result<String, EventError> {
        self.get_inner().stream_read()
    }
}

impl Drop for UdsClient {
    fn drop(&mut self) {
        println!("Drop UdsClient");

        let inner = self.inner.replace(None);
        drop(inner);
    }
}

unsafe impl Send for UdsClientInner {}
unsafe impl Sync for UdsClientInner {}

/// UdsClient Inner.
pub struct UdsClientInner {
    /// Server path.
    path: PathBuf,

    /// UdsClient.
    client: Weak<Mutex<UdsClient>>,

    /// Event manager.
    event_manager: Arc<Mutex<EventManager>>,

    /// Message Client handler.
    handler: RefCell<Arc<dyn UdsClientHandler>>,

    /// Client stream.
    stream: RefCell<Option<UnixStream>>,
}

/// UdsClientInner implementation.
impl UdsClientInner {
    /// Constructdor.
    pub fn new(
        client: Arc<Mutex<UdsClient>>,
        event_manager: Arc<Mutex<EventManager>>,
        handler: Arc<dyn UdsClientHandler>,
        path: &PathBuf,
    ) -> UdsClientInner {
        UdsClientInner {
            path: path.clone(),
            client: Arc::downgrade(&client),
            event_manager: event_manager,
            handler: RefCell::new(handler),
            stream: RefCell::new(None),
        }
    }

    /// Connect to server.
    pub fn connect(&self, client: &UdsClient) -> Result<(), EventError> {
        match UnixStream::connect(&self.path) {
            Ok(stream) => {
                self.stream.borrow_mut().replace(stream);
                let _ = self.handler.borrow_mut().handle_connect(client);
                Ok(())
            }
            Err(_) => Err(EventError::ConnectError("UDS".to_string())),
        }
    }

    /// Return event manager.
    pub fn get_event_manager(&self) -> Arc<Mutex<EventManager>> {
        self.event_manager.clone()
    }

    /// Send a message through UnixStream.
    pub fn stream_send(&self, message: &str) -> Result<(), EventError> {
        match *self.stream.borrow_mut() {
            Some(ref mut stream) => {
                if let Err(_err) = stream.write_all(message.as_bytes()) {
                    return Err(EventError::WriteError("UDS".to_string()));
                }
            }
            None => return Err(EventError::WriteError("UDS".to_string())),
        }

        Ok(())
    }

    /// Receive a message through UnixStream.
    /// Return UTF8 string. If it is empty, consider an error.
    pub fn stream_read(&self) -> Result<String, EventError> {
        match *self.stream.borrow_mut() {
            Some(ref mut stream) => {
                let mut buffer = Vec::new();

                if let Err(err) = stream.read_to_end(&mut buffer) {
                    if err.kind() != std::io::ErrorKind::WouldBlock {
                        return Err(EventError::ReadError(err.to_string()));
                    }
                }

                let str = std::str::from_utf8(&buffer).unwrap();
                if str.len() > 0 {
                    let message = String::from(str);
                    Ok(message)
                } else {
                    Err(EventError::ReadError(
                        "Empty string from stream".to_string(),
                    ))
                }
            }
            None => Err(EventError::NoStream),
        }
    }
}

impl Drop for UdsClientInner {
    fn drop(&mut self) {
        println!("Drop UdsClientInner");
    }
}

/// EventHandler implementation for UdsClient.
impl EventHandler for UdsClientInner {
    /// Handle event.
    fn handle(&self, e: EventType) -> Result<(), EventError> {
        match e {
            EventType::TimerEvent => {
                // Reconnect timer expired.
                let client = self.client.upgrade().unwrap();
                let client = client.lock().unwrap();
                client.connect();

                Ok(())
            }
            EventType::ReadEvent => {
                let handler = self.handler.borrow_mut();
                let client = self.client.upgrade().unwrap();
                let client = client.lock().unwrap();

                // Dispatch message to message handler.
                if let Err(_) = handler.handle_message(&*client) {
                    // If read causes an error, most likely server disconnected,
                    // so schedule reconnect.
                    client.connect_timer();
                }

                Ok(())
            }
            EventType::ErrorEvent => {
                self.stream.borrow_mut().take();

                // TODO: Schedule reconnect timer.
                let client = self.client.upgrade().unwrap();
                let client = client.lock().unwrap();
                client.connect_timer();

                let handler = self.handler.borrow_mut();

                // Dispatch message to Client message handler.
                handler.handle_disconnect(&*client)
            }
            _ => Err(EventError::InvalidEvent),
        }
    }
}


#[cfg(test)]
mod tests {
    use super::*;
    use std::path::Path;

    struct TestClientHandler {
    }

    impl UdsClientHandler for TestClientHandler {
        /// callback when client connects to server.
        fn handle_connect(&self, _entry: &UdsClient) -> Result<(), EventError> {
            Ok(())
        }

        /// callback when client detects server disconnected.
        fn handle_disconnect(&self, _entry: &UdsClient) -> Result<(), EventError> {
            Ok(())
        }

        /// callback when client received message.
        fn handle_message(&self, _entry: &UdsClient) -> Result<(), EventError> {
            Ok(())
        }
    }

    #[test]
    pub fn test_uds_client() {
        let mut path = PathBuf::new();
        path.push("/tmp/test_uds.sock");
        let em = EventManager::new();
        let handler = TestClientHandler { };
        {
            let uds_client = UdsClient::start(Arc::new(Mutex::new(em)),
                                              Arc::new(handler), &path);
            drop(uds_client);
        }
    }
}