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 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
use event_imp::{Ready, ready_as_usize, ready_from_usize}; use std::ops; use std::fmt; /// Unix specific extensions to `Ready` /// /// Provides additional readiness event kinds that are available on unix /// platforms. Unix platforms are able to provide readiness events for /// additional socket events, such as HUP and error. /// /// HUP events occur when the remote end of a socket hangs up. In the TCP case, /// this occurs when the remote end of a TCP socket shuts down writes. /// /// Error events occur when the socket enters an error state. In this case, the /// socket will also receive a readable or writable event. Reading or writing to /// the socket will result in an error. /// /// Conversion traits are implemented between `Ready` and `UnixReady`. See the /// examples. /// /// For high level documentation on polling and readiness, see [`Poll`]. /// /// # Examples /// /// Most of the time, all that is needed is using bit operations /// /// ``` /// use mio::Ready; /// use mio::unix::UnixReady; /// /// let ready = Ready::readable() | UnixReady::hup(); /// /// assert!(ready.is_readable()); /// assert!(UnixReady::from(ready).is_hup()); /// ``` /// /// Basic conversion between ready types. /// /// ``` /// use mio::Ready; /// use mio::unix::UnixReady; /// /// // Start with a portable ready /// let ready = Ready::readable(); /// /// // Convert to a unix ready, adding HUP /// let mut unix_ready = UnixReady::from(ready) | UnixReady::hup(); /// /// unix_ready.insert(UnixReady::error()); /// /// // `unix_ready` maintains readable interest /// assert!(unix_ready.is_readable()); /// assert!(unix_ready.is_hup()); /// assert!(unix_ready.is_error()); /// /// // Convert back to `Ready` /// let ready = Ready::from(unix_ready); /// /// // Readable is maintained /// assert!(ready.is_readable()); /// ``` /// /// Registering readable and error interest on a socket /// /// ``` /// # use std::error::Error; /// # fn try_main() -> Result<(), Box<Error>> { /// use mio::{Ready, Poll, PollOpt, Token}; /// use mio::net::TcpStream; /// use mio::unix::UnixReady; /// /// let addr = "216.58.193.68:80".parse()?; /// let socket = TcpStream::connect(&addr)?; /// /// let poll = Poll::new()?; /// /// poll.register(&socket, /// Token(0), /// Ready::readable() | UnixReady::error(), /// PollOpt::edge())?; /// # Ok(()) /// # } /// # /// # fn main() { /// # try_main().unwrap(); /// # } /// ``` /// /// [`Poll`]: ../struct.Poll.html /// [readiness]: struct.Poll.html#readiness-operations #[derive(Copy, PartialEq, Eq, Clone, PartialOrd, Ord)] pub struct UnixReady(Ready); const ERROR: usize = 0b000100; const HUP: usize = 0b001000; #[cfg(any(target_os = "dragonfly", target_os = "freebsd", target_os = "ios", target_os = "macos"))] const AIO: usize = 0b010000; #[cfg(not(any(target_os = "dragonfly", target_os = "freebsd", target_os = "ios", target_os = "macos")))] const AIO: usize = 0b000000; #[cfg(any(target_os = "freebsd"))] const LIO: usize = 0b100000; #[cfg(not(any(target_os = "freebsd")))] const LIO: usize = 0b000000; // Export to support `Ready::all` pub const READY_ALL: usize = ERROR | HUP | AIO | LIO; impl UnixReady { /// Returns a `Ready` representing AIO completion readiness /// /// See [`Poll`] for more documentation on polling. /// /// # Examples /// /// ``` /// use mio::unix::UnixReady; /// /// let ready = UnixReady::aio(); /// /// assert!(ready.is_aio()); /// ``` /// /// [`Poll`]: ../struct.Poll.html #[inline] #[cfg(any(target_os = "dragonfly", target_os = "freebsd", target_os = "ios", target_os = "macos"))] pub fn aio() -> UnixReady { UnixReady(ready_from_usize(AIO)) } #[cfg(not(any(target_os = "dragonfly", target_os = "freebsd", target_os = "ios", target_os = "macos")))] #[deprecated(since = "0.6.12", note = "this function is now platform specific")] #[doc(hidden)] pub fn aio() -> UnixReady { UnixReady(Ready::empty()) } /// Returns a `Ready` representing error readiness. /// /// **Note that only readable and writable readiness is guaranteed to be /// supported on all platforms**. This means that `error` readiness /// should be treated as a hint. For more details, see [readiness] in the /// poll documentation. /// /// See [`Poll`] for more documentation on polling. /// /// # Examples /// /// ``` /// use mio::unix::UnixReady; /// /// let ready = UnixReady::error(); /// /// assert!(ready.is_error()); /// ``` /// /// [`Poll`]: ../struct.Poll.html /// [readiness]: ../struct.Poll.html#readiness-operations #[inline] pub fn error() -> UnixReady { UnixReady(ready_from_usize(ERROR)) } /// Returns a `Ready` representing HUP readiness. /// /// A HUP (or hang-up) signifies that a stream socket **peer** closed the /// connection, or shut down the writing half of the connection. /// /// **Note that only readable and writable readiness is guaranteed to be /// supported on all platforms**. This means that `hup` readiness /// should be treated as a hint. For more details, see [readiness] in the /// poll documentation. /// /// See [`Poll`] for more documentation on polling. /// /// # Examples /// /// ``` /// use mio::unix::UnixReady; /// /// let ready = UnixReady::hup(); /// /// assert!(ready.is_hup()); /// ``` /// /// [`Poll`]: ../struct.Poll.html /// [readiness]: ../struct.Poll.html#readiness-operations #[inline] pub fn hup() -> UnixReady { UnixReady(ready_from_usize(HUP)) } /// Returns a `Ready` representing LIO completion readiness /// /// See [`Poll`] for more documentation on polling. /// /// # Examples /// /// ``` /// use mio::unix::UnixReady; /// /// let ready = UnixReady::lio(); /// /// assert!(ready.is_lio()); /// ``` /// /// [`Poll`]: struct.Poll.html #[inline] #[cfg(any(target_os = "freebsd"))] pub fn lio() -> UnixReady { UnixReady(ready_from_usize(LIO)) } /// Returns true if `Ready` contains AIO readiness /// /// See [`Poll`] for more documentation on polling. /// /// # Examples /// /// ``` /// use mio::unix::UnixReady; /// /// let ready = UnixReady::aio(); /// /// assert!(ready.is_aio()); /// ``` /// /// [`Poll`]: ../struct.Poll.html #[inline] #[cfg(any(target_os = "dragonfly", target_os = "freebsd", target_os = "ios", target_os = "macos"))] pub fn is_aio(&self) -> bool { self.contains(ready_from_usize(AIO)) } #[deprecated(since = "0.6.12", note = "this function is now platform specific")] #[cfg(feature = "with-deprecated")] #[cfg(not(any(target_os = "dragonfly", target_os = "freebsd", target_os = "ios", target_os = "macos")))] #[doc(hidden)] pub fn is_aio(&self) -> bool { false } /// Returns true if the value includes error readiness /// /// **Note that only readable and writable readiness is guaranteed to be /// supported on all platforms**. This means that `error` readiness should /// be treated as a hint. For more details, see [readiness] in the poll /// documentation. /// /// See [`Poll`] for more documentation on polling. /// /// # Examples /// /// ``` /// use mio::unix::UnixReady; /// /// let ready = UnixReady::error(); /// /// assert!(ready.is_error()); /// ``` /// /// [`Poll`]: ../struct.Poll.html /// [readiness]: ../struct.Poll.html#readiness-operations #[inline] pub fn is_error(&self) -> bool { self.contains(ready_from_usize(ERROR)) } /// Returns true if the value includes HUP readiness /// /// A HUP (or hang-up) signifies that a stream socket **peer** closed the /// connection, or shut down the writing half of the connection. /// /// **Note that only readable and writable readiness is guaranteed to be /// supported on all platforms**. This means that `hup` readiness /// should be treated as a hint. For more details, see [readiness] in the /// poll documentation. /// /// See [`Poll`] for more documentation on polling. /// /// # Examples /// /// ``` /// use mio::unix::UnixReady; /// /// let ready = UnixReady::hup(); /// /// assert!(ready.is_hup()); /// ``` /// /// [`Poll`]: ../struct.Poll.html /// [readiness]: ../struct.Poll.html#readiness-operations #[inline] pub fn is_hup(&self) -> bool { self.contains(ready_from_usize(HUP)) } /// Returns true if `Ready` contains LIO readiness /// /// See [`Poll`] for more documentation on polling. /// /// # Examples /// /// ``` /// use mio::unix::UnixReady; /// /// let ready = UnixReady::lio(); /// /// assert!(ready.is_lio()); /// ``` #[inline] #[cfg(any(target_os = "freebsd"))] pub fn is_lio(&self) -> bool { self.contains(ready_from_usize(LIO)) } } impl From<Ready> for UnixReady { fn from(src: Ready) -> UnixReady { UnixReady(src) } } impl From<UnixReady> for Ready { fn from(src: UnixReady) -> Ready { src.0 } } impl ops::Deref for UnixReady { type Target = Ready; fn deref(&self) -> &Ready { &self.0 } } impl ops::DerefMut for UnixReady { fn deref_mut(&mut self) -> &mut Ready { &mut self.0 } } impl ops::BitOr for UnixReady { type Output = UnixReady; #[inline] fn bitor(self, other: UnixReady) -> UnixReady { (self.0 | other.0).into() } } impl ops::BitXor for UnixReady { type Output = UnixReady; #[inline] fn bitxor(self, other: UnixReady) -> UnixReady { (self.0 ^ other.0).into() } } impl ops::BitAnd for UnixReady { type Output = UnixReady; #[inline] fn bitand(self, other: UnixReady) -> UnixReady { (self.0 & other.0).into() } } impl ops::Sub for UnixReady { type Output = UnixReady; #[inline] fn sub(self, other: UnixReady) -> UnixReady { ready_from_usize(ready_as_usize(self.0) & !ready_as_usize(other.0)).into() } } #[deprecated(since = "0.6.10", note = "removed")] #[cfg(feature = "with-deprecated")] #[doc(hidden)] impl ops::Not for UnixReady { type Output = UnixReady; #[inline] fn not(self) -> UnixReady { (!self.0).into() } } impl fmt::Debug for UnixReady { fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result { let mut one = false; let flags = [ (UnixReady(Ready::readable()), "Readable"), (UnixReady(Ready::writable()), "Writable"), (UnixReady::error(), "Error"), (UnixReady::hup(), "Hup"), #[allow(deprecated)] (UnixReady::aio(), "Aio")]; for &(flag, msg) in &flags { if self.contains(flag) { if one { write!(fmt, " | ")? } write!(fmt, "{}", msg)?; one = true } } if !one { fmt.write_str("(empty)")?; } Ok(()) } }