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
// // Copyright (C) 2018 Kubos Corporation // // Licensed under the Apache License, Version 2.0 (the "License") // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // use cbor_protocol::Protocol as CborProtocol; use error::ProtocolError; use parsers::parse_message; use serde_cbor::Value; use std::cell::Cell; use std::net::SocketAddr; use std::time::Duration; /// Channel message structure #[derive(Clone, Debug)] pub struct Message { /// Channel ID pub channel_id: u32, /// Message name pub name: String, /// Message payload pub payload: Vec<Value>, } /// Channel protocol structure pub struct Protocol { cbor_proto: CborProtocol, remote_addr: Cell<SocketAddr>, } impl Protocol { /// Create a new channel protocol instance using an automatically assigned UDP socket /// /// # Arguments /// /// * host_ip - The local IP address /// * remote_addr - The remote IP and port to communicate with /// * data_len - Max payload length /// /// # Errors /// /// If this function encounters any errors, it will panic /// /// # Examples /// /// ```no_run /// use channel_protocol::*; /// /// let channel_protocol = ChannelProtocol::new("0.0.0.0", "192.168.0.1:7000", 4096); /// ``` /// pub fn new(host_ip: &str, remote_addr: &str, data_len: u32) -> Self { // Get a local UDP socket (Bind) let c_protocol = CborProtocol::new(format!("{}:0", host_ip), data_len as usize); // Set up the full connection info Protocol { cbor_proto: c_protocol, remote_addr: Cell::new(remote_addr.parse::<SocketAddr>().unwrap()), } } /// Set new remote address on existing channel procotol structure /// /// # Arguments /// /// * remote - New remote address /// pub fn set_remote(&mut self, remote: SocketAddr) -> () { self.remote_addr.set(remote); } /// Send CBOR packet to the destination port /// /// # Arguments /// /// * vec - CBOR packet to send /// /// # Errors /// /// If this function encounters any errors, it will return an error message string /// /// # Examples /// /// ```no_run /// extern crate channel_protocol; /// extern crate serde_cbor; /// /// use channel_protocol::*; /// use serde_cbor::ser; /// /// let c_protocol = ChannelProtocol::new("0.0.0.0", "0.0.0.0:7000", 4096); /// let message = ser::to_vec_packed(&"ping").unwrap(); /// /// c_protocol.send(message); /// ``` /// pub fn send(&self, vec: Vec<u8>) -> Result<(), ProtocolError> { self.cbor_proto.send_message(&vec, self.remote_addr.get())?; Ok(()) } /// Receive a raw cbor message message /// /// # Arguments /// /// * timeout - Maximum time to wait for a reply. If `None`, will block indefinitely /// /// # Errors /// /// - If this function times out, it will return `Err(ProtocolError::ReceiveTimeout)` /// - If this function encounters any errors, it will return an error message string /// /// # Examples /// /// ```no_run /// extern crate channel_protocol; /// /// use channel_protocol::*; /// use std::time::Duration; /// /// let c_protocol = ChannelProtocol::new("0.0.0.0", "0.0.0.0:7000", 4096); /// /// let message = match c_protocol.recv_raw(Some(Duration::from_secs(1))) { /// Ok(data) => data, /// Err(ProtocolError::ReceiveTimeout) => { /// println!("Timeout waiting for message"); /// return; /// } /// Err(err) => panic!("Failed to receive message: {}", err), /// }; /// ``` /// pub fn recv_raw(&self, timeout: Option<Duration>) -> Result<Value, ProtocolError> { match timeout { Some(value) => Ok(self.cbor_proto.recv_message_timeout(value)?), None => Ok(self.cbor_proto.recv_message()?), } } /// Receive a parsed channel procotol message /// /// # Arguments /// /// * timeout - Maximum time to wait for a reply. If `None`, will block indefinitely /// /// # Errors /// /// - If this function times out, it will return `Err(ProtocolError::ReceiveTimeout)` /// - If this function encounters any errors, it will return an error message string /// /// # Examples /// /// ```no_run /// extern crate channel_protocol; /// /// use channel_protocol::*; /// use std::time::Duration; /// /// let c_protocol = ChannelProtocol::new("0.0.0.0", "0.0.0.0:7000", 4096); /// /// let message = match c_protocol.recv_message(Some(Duration::from_secs(1))) { /// Ok(data) => data, /// Err(ProtocolError::ReceiveTimeout) => { /// println!("Timeout waiting for message"); /// return; /// } /// Err(err) => panic!("Failed to receive message: {}", err), /// }; /// ``` /// pub fn recv_message(&self, timeout: Option<Duration>) -> Result<Message, ProtocolError> { let raw = self.recv_raw(timeout)?; Ok(parse_message(raw)?) } }