Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Introduce recv_blocking() method on PayloadReceiver #1

Closed
wants to merge 1 commit into from
Closed

Introduce recv_blocking() method on PayloadReceiver #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 17 additions & 23 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,30 +62,24 @@ camera.load_context().unwrap();
// Start streaming. Channel capacity is set to 3.
let payload_rx = camera.start_streaming(3).unwrap();

let mut payload_count = 0;
while payload_count < 10 {
match payload_rx.try_recv() {
Ok(payload) => {
println!(
"payload received! block_id: {:?}, timestamp: {:?}",
payload.id(),
payload.timestamp()
);
if let Some(image_info) = payload.image_info() {
println!("{:?}\n", image_info);
let image = payload.image();
// do something with the image.
// ...
}
payload_count += 1;

// Send back payload to streaming loop to reuse the buffer. This is optional.
payload_rx.send_back(payload);
}
Err(_err) => {
continue;
}
for _ in 0..10 {
let payload = payload_rx
.recv_blocking()
.expect("should receive a payload");
println!(
"payload received! block_id: {:?}, timestamp: {:?}",
payload.id(),
payload.timestamp()
);
if let Some(image_info) = payload.image_info() {
println!("{:?}\n", image_info);
let image = payload.image();
// do something with the image.
// ...
}

// Send back payload to streaming loop to reuse the buffer. This is optional.
payload_rx.send_back(payload);
}

// Closes the camera.
Expand Down
41 changes: 17 additions & 24 deletions cameleon/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,30 +62,24 @@ camera.load_context().unwrap();
// Start streaming. Channel capacity is set to 3.
let payload_rx = camera.start_streaming(3).unwrap();

let mut payload_count = 0;
while payload_count < 10 {
match payload_rx.try_recv() {
Ok(payload) => {
println!(
"payload received! block_id: {:?}, timestamp: {:?}",
payload.id(),
payload.timestamp()
);
if let Some(image_info) = payload.image_info() {
println!("{:?}\n", image_info);
let image = payload.image();
// do something with the image.
// ...
}
payload_count += 1;

// Send back payload to streaming loop to reuse the buffer. This is optional.
payload_rx.send_back(payload);
}
Err(_err) => {
continue;
}
for _ in 0..10 {
let payload = payload_rx
.recv_blocking()
.expect("should receive a payload");
println!(
"payload received! block_id: {:?}, timestamp: {:?}",
payload.id(),
payload.timestamp()
);
if let Some(image_info) = payload.image_info() {
println!("{:?}\n", image_info);
let image = payload.image();
// do something with the image.
// ...
}

// Send back payload to streaming loop to reuse the buffer. This is optional.
payload_rx.send_back(payload);
}

// Closes the camera.
Expand Down Expand Up @@ -188,4 +182,3 @@ To start developing, please refer to [CONTRIBUTING.md][contributing].
This project is licenced under [MPL 2.0][license].

[license]: https://github.com/cameleon-rs/cameleon/blob/main/LICENSE

34 changes: 14 additions & 20 deletions cameleon/examples/stream.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,27 +25,21 @@ fn main() {
// Start streaming. Channel capacity is set to 3.
let payload_rx = camera.start_streaming(3).unwrap();

let mut payload_count = 0_usize;
while payload_count < 10 {
match payload_rx.try_recv() {
Ok(payload) => {
println!(
"payload received! block_id: {:?}, timestamp: {:?}",
payload.id(),
payload.timestamp()
);
if let Some(image_info) = payload.image_info() {
println!("{:?}\n", image_info);
}
payload_count += 1;

// Send back payload to streaming loop to reuse the buffer.
payload_rx.send_back(payload);
}
Err(_err) => {
continue;
}
for _ in 0..10 {
let payload = payload_rx
.recv_blocking()
.expect("should receive a payload");
println!(
"payload received! block_id: {:?}, timestamp: {:?}",
payload.id(),
payload.timestamp()
);
if let Some(image_info) = payload.image_info() {
println!("{:?}\n", image_info);
}

// Send back payload to streaming loop to reuse the buffer.
payload_rx.send_back(payload);
}

camera.close().ok();
Expand Down
6 changes: 6 additions & 0 deletions cameleon/src/payload.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,12 @@ impl PayloadReceiver {
self.rx.try_recv()?
}

/// Receives [`Payload`] sent from the device.
/// If the channel is empty, this method blocks until the device produces it.
pub fn recv_blocking(&self) -> StreamResult<Payload> {
self.rx.recv_blocking()?
}

/// Sends back [`Payload`] to the device to reuse already allocated `payload`.
///
/// Sending back `payload` may improve performance of streaming, but not required to call this
Expand Down