When using tokio::spawn we might wish to pass through a cancellation token to allow us to cancel a long running thread.<\/p>\n
We can create a cancellation token like this<\/p>\n
\r\nlet token = CancellationToken::new();\r\n<\/pre>\nFrom this we could take one or more child tokens like this<\/p>\n
\r\nlet child = token.child_token();\r\n<\/pre>\nUsing child token’s allows us to cancel all child tokens from the parent or we can cancel each one individually<\/p>\n
Now if we spawn our threads, in this case we’ll create two concurrent branches. The first one that completes is the returning value. In this instance we’ll store the JoinHandle just to allow us to force the application to wait upon completion so we get something meaningful output to the console<\/p>\n
\r\nlet handle = tokio::spawn(async move {\r\n tokio::select! {\r\n _ = child.cancelled() => {\r\n println!("Child1 task cancelled");\r\n }\r\n _ = tokio::time::sleep(Duration::from_secs(30)) => {\r\n println!("Child2 task cancelled");\r\n }\r\n }\r\n});\r\n<\/pre>\nHere’s the full code, starting with cargo.toml dependencies<\/p>\n
\r\n[dependencies]\r\ntokio-util = "0.7.17"\r\ntokio = { version = "1.48.0", features = ["rt", "rt-multi-thread", "macros", "time"] }\r\nselect = "0.6.1"\r\nanyhow = "1.0.100"\r\n<\/pre>\nNow the main.rs code<\/p>\n
\r\nuse std::io;\r\nuse std::time::Duration;\r\nuse tokio_util::sync::CancellationToken;\r\n\r\n#[tokio::main]\r\nasync fn main() -> anyhow::Result<()> {\r\n let token = CancellationToken::new();\r\n let child = token.child_token();\r\n\r\n let handle = tokio::spawn(async move {\r\n tokio::select! {\r\n _ = child.cancelled() => {\r\n println!("Child1 task cancelled");\r\n }\r\n _ = tokio::time::sleep(Duration::from_secs(30)) => {\r\n println!("Child2 task cancelled");\r\n }\r\n }\r\n });\r\n\r\n io::stdin().read_line(&mut String::new())?;\r\n token.cancel();\r\n\r\n handle.await.expect("Task panicked");\r\n println!("Task Completed");\r\n\r\n Ok(())\r\n}\r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"When using tokio::spawn we might wish to pass through a cancellation token to allow us to cancel a long running thread. We can create a cancellation token like this let token = CancellationToken::new(); From this we could take one or more child tokens like this let child = token.child_token(); Using child token’s allows us to […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[191],"tags":[],"class_list":["post-11821","post","type-post","status-publish","format-standard","hentry","category-rust"],"jetpack_sharing_enabled":true,"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/11821","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/comments?post=11821"}],"version-history":[{"count":3,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/11821\/revisions"}],"predecessor-version":[{"id":12058,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/11821\/revisions\/12058"}],"wp:attachment":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/media?parent=11821"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/categories?post=11821"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/tags?post=11821"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}