Struct channel_protocol::ChannelProtocol
source · [−]pub struct ChannelProtocol { /* private fields */ }
Expand description
Channel protocol structure
Implementations
sourceimpl Protocol
impl Protocol
sourcepub fn new(host_ip: &str, remote_addr: &str, data_len: u32) -> Self
pub fn new(host_ip: &str, remote_addr: &str, data_len: u32) -> Self
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
use channel_protocol::*;
let channel_protocol = ChannelProtocol::new("0.0.0.0", "192.168.0.1:7000", 4096);
sourcepub fn set_remote(&mut self, remote: SocketAddr)
pub fn set_remote(&mut self, remote: SocketAddr)
sourcepub fn send(&self, vec: &[u8]) -> Result<(), ProtocolError>
pub fn send(&self, vec: &[u8]) -> Result<(), ProtocolError>
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
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);
sourcepub fn recv_raw(&self, timeout: Option<Duration>) -> Result<Value, ProtocolError>
pub fn recv_raw(&self, timeout: Option<Duration>) -> Result<Value, ProtocolError>
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
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),
};
sourcepub fn recv_message(
&self,
timeout: Option<Duration>
) -> Result<Message, ProtocolError>
pub fn recv_message(
&self,
timeout: Option<Duration>
) -> Result<Message, ProtocolError>
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
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),
};
Auto Trait Implementations
impl !RefUnwindSafe for Protocol
impl Send for Protocol
impl !Sync for Protocol
impl Unpin for Protocol
impl UnwindSafe for Protocol
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more