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 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
// // DO NOT EDIT. THIS FILE IS GENERATED FROM ../../../dist/idl/nsIThreadPool.idl // /// `interface nsIThreadPoolListener : nsISupports` /// // The actual type definition for the interface. This struct has methods // declared on it which will call through its vtable. You never want to pass // this type around by value, always pass it behind a reference. #[repr(C)] pub struct nsIThreadPoolListener { vtable: *const nsIThreadPoolListenerVTable, /// This field is a phantomdata to ensure that the VTable type and any /// struct containing it is not safe to send across threads, as XPCOM is /// generally not threadsafe. /// /// XPCOM interfaces in general are not safe to send across threads. __nosync: ::std::marker::PhantomData<::std::rc::Rc<u8>>, } // Implementing XpCom for an interface exposes its IID, which allows for easy // use of the `.query_interface<T>` helper method. This also defines that // method for nsIThreadPoolListener. unsafe impl XpCom for nsIThreadPoolListener { const IID: nsIID = nsID(0xef194cab, 0x3f86, 0x4b61, [0xb1, 0x32, 0xe5, 0xe9, 0x6a, 0x79, 0xe5, 0xd1]); } // We need to implement the RefCounted trait so we can be used with `RefPtr`. // This trait teaches `RefPtr` how to manage our memory. unsafe impl RefCounted for nsIThreadPoolListener { #[inline] unsafe fn addref(&self) { self.AddRef(); } #[inline] unsafe fn release(&self) { self.Release(); } } // This trait is implemented on all types which can be coerced to from nsIThreadPoolListener. // It is used in the implementation of `fn coerce<T>`. We hide it from the // documentation, because it clutters it up a lot. #[doc(hidden)] pub trait nsIThreadPoolListenerCoerce { /// Cheaply cast a value of this type from a `nsIThreadPoolListener`. fn coerce_from(v: &nsIThreadPoolListener) -> &Self; } // The trivial implementation: We can obviously coerce ourselves to ourselves. impl nsIThreadPoolListenerCoerce for nsIThreadPoolListener { #[inline] fn coerce_from(v: &nsIThreadPoolListener) -> &Self { v } } impl nsIThreadPoolListener { /// Cast this `nsIThreadPoolListener` to one of its base interfaces. #[inline] pub fn coerce<T: nsIThreadPoolListenerCoerce>(&self) -> &T { T::coerce_from(self) } } // Every interface struct type implements `Deref` to its base interface. This // causes methods on the base interfaces to be directly avaliable on the // object. For example, you can call `.AddRef` or `.QueryInterface` directly // on any interface which inherits from `nsISupports`. impl ::std::ops::Deref for nsIThreadPoolListener { type Target = nsISupports; #[inline] fn deref(&self) -> &nsISupports { unsafe { ::std::mem::transmute(self) } } } // Ensure we can use .coerce() to cast to our base types as well. Any type which // our base interface can coerce from should be coercable from us as well. impl<T: nsISupportsCoerce> nsIThreadPoolListenerCoerce for T { #[inline] fn coerce_from(v: &nsIThreadPoolListener) -> &Self { T::coerce_from(v) } } // This struct represents the interface's VTable. A pointer to a statically // allocated version of this struct is at the beginning of every nsIThreadPoolListener // object. It contains one pointer field for each method in the interface. In // the case where we can't generate a binding for a method, we include a void // pointer. #[doc(hidden)] #[repr(C)] pub struct nsIThreadPoolListenerVTable { /// We need to include the members from the base interface's vtable at the start /// of the VTable definition. pub __base: nsISupportsVTable, /* void onThreadCreated (); */ pub OnThreadCreated: unsafe extern "system" fn (this: *const nsIThreadPoolListener) -> nsresult, /* void onThreadShuttingDown (); */ pub OnThreadShuttingDown: unsafe extern "system" fn (this: *const nsIThreadPoolListener) -> nsresult, } // The implementations of the function wrappers which are exposed to rust code. // Call these methods rather than manually calling through the VTable struct. impl nsIThreadPoolListener { /// ```text /// /** /// * Called when a new thread is created by the thread pool. The notification /// * happens on the newly-created thread. /// */ /// ``` /// /// `void onThreadCreated ();` #[inline] pub unsafe fn OnThreadCreated(&self, ) -> nsresult { ((*self.vtable).OnThreadCreated)(self, ) } /// ```text /// /** /// * Called when a thread is about to be destroyed by the thread pool. The /// * notification happens on the thread that is about to be destroyed. /// */ /// ``` /// /// `void onThreadShuttingDown ();` #[inline] pub unsafe fn OnThreadShuttingDown(&self, ) -> nsresult { ((*self.vtable).OnThreadShuttingDown)(self, ) } } /// `interface nsIThreadPool : nsIEventTarget` /// /// ```text /// /** /// * An interface to a thread pool. A thread pool creates a limited number of /// * anonymous (unnamed) worker threads. An event dispatched to the thread pool /// * will be run on the next available worker thread. /// */ /// ``` /// // The actual type definition for the interface. This struct has methods // declared on it which will call through its vtable. You never want to pass // this type around by value, always pass it behind a reference. #[repr(C)] pub struct nsIThreadPool { vtable: *const nsIThreadPoolVTable, /// This field is a phantomdata to ensure that the VTable type and any /// struct containing it is not safe to send across threads, as XPCOM is /// generally not threadsafe. /// /// XPCOM interfaces in general are not safe to send across threads. __nosync: ::std::marker::PhantomData<::std::rc::Rc<u8>>, } // Implementing XpCom for an interface exposes its IID, which allows for easy // use of the `.query_interface<T>` helper method. This also defines that // method for nsIThreadPool. unsafe impl XpCom for nsIThreadPool { const IID: nsIID = nsID(0x76ce99c9, 0x8e43, 0x489a, [0x97, 0x89, 0xf2, 0x7c, 0xc4, 0x42, 0x49, 0x65]); } // We need to implement the RefCounted trait so we can be used with `RefPtr`. // This trait teaches `RefPtr` how to manage our memory. unsafe impl RefCounted for nsIThreadPool { #[inline] unsafe fn addref(&self) { self.AddRef(); } #[inline] unsafe fn release(&self) { self.Release(); } } // This trait is implemented on all types which can be coerced to from nsIThreadPool. // It is used in the implementation of `fn coerce<T>`. We hide it from the // documentation, because it clutters it up a lot. #[doc(hidden)] pub trait nsIThreadPoolCoerce { /// Cheaply cast a value of this type from a `nsIThreadPool`. fn coerce_from(v: &nsIThreadPool) -> &Self; } // The trivial implementation: We can obviously coerce ourselves to ourselves. impl nsIThreadPoolCoerce for nsIThreadPool { #[inline] fn coerce_from(v: &nsIThreadPool) -> &Self { v } } impl nsIThreadPool { /// Cast this `nsIThreadPool` to one of its base interfaces. #[inline] pub fn coerce<T: nsIThreadPoolCoerce>(&self) -> &T { T::coerce_from(self) } } // Every interface struct type implements `Deref` to its base interface. This // causes methods on the base interfaces to be directly avaliable on the // object. For example, you can call `.AddRef` or `.QueryInterface` directly // on any interface which inherits from `nsISupports`. impl ::std::ops::Deref for nsIThreadPool { type Target = nsIEventTarget; #[inline] fn deref(&self) -> &nsIEventTarget { unsafe { ::std::mem::transmute(self) } } } // Ensure we can use .coerce() to cast to our base types as well. Any type which // our base interface can coerce from should be coercable from us as well. impl<T: nsIEventTargetCoerce> nsIThreadPoolCoerce for T { #[inline] fn coerce_from(v: &nsIThreadPool) -> &Self { T::coerce_from(v) } } // This struct represents the interface's VTable. A pointer to a statically // allocated version of this struct is at the beginning of every nsIThreadPool // object. It contains one pointer field for each method in the interface. In // the case where we can't generate a binding for a method, we include a void // pointer. #[doc(hidden)] #[repr(C)] pub struct nsIThreadPoolVTable { /// We need to include the members from the base interface's vtable at the start /// of the VTable definition. pub __base: nsIEventTargetVTable, /* void shutdown (); */ pub Shutdown: unsafe extern "system" fn (this: *const nsIThreadPool) -> nsresult, /* attribute unsigned long threadLimit; */ pub GetThreadLimit: unsafe extern "system" fn (this: *const nsIThreadPool, aThreadLimit: *mut libc::uint32_t) -> nsresult, /* attribute unsigned long threadLimit; */ pub SetThreadLimit: unsafe extern "system" fn (this: *const nsIThreadPool, aThreadLimit: libc::uint32_t) -> nsresult, /* attribute unsigned long idleThreadLimit; */ pub GetIdleThreadLimit: unsafe extern "system" fn (this: *const nsIThreadPool, aIdleThreadLimit: *mut libc::uint32_t) -> nsresult, /* attribute unsigned long idleThreadLimit; */ pub SetIdleThreadLimit: unsafe extern "system" fn (this: *const nsIThreadPool, aIdleThreadLimit: libc::uint32_t) -> nsresult, /* attribute unsigned long idleThreadTimeout; */ pub GetIdleThreadTimeout: unsafe extern "system" fn (this: *const nsIThreadPool, aIdleThreadTimeout: *mut libc::uint32_t) -> nsresult, /* attribute unsigned long idleThreadTimeout; */ pub SetIdleThreadTimeout: unsafe extern "system" fn (this: *const nsIThreadPool, aIdleThreadTimeout: libc::uint32_t) -> nsresult, /* attribute unsigned long threadStackSize; */ pub GetThreadStackSize: unsafe extern "system" fn (this: *const nsIThreadPool, aThreadStackSize: *mut libc::uint32_t) -> nsresult, /* attribute unsigned long threadStackSize; */ pub SetThreadStackSize: unsafe extern "system" fn (this: *const nsIThreadPool, aThreadStackSize: libc::uint32_t) -> nsresult, /* attribute nsIThreadPoolListener listener; */ pub GetListener: unsafe extern "system" fn (this: *const nsIThreadPool, aListener: *mut *const nsIThreadPoolListener) -> nsresult, /* attribute nsIThreadPoolListener listener; */ pub SetListener: unsafe extern "system" fn (this: *const nsIThreadPool, aListener: *const nsIThreadPoolListener) -> nsresult, /* void setName (in ACString aName); */ pub SetName: unsafe extern "system" fn (this: *const nsIThreadPool, aName: &::nsstring::nsACString) -> nsresult, } // The implementations of the function wrappers which are exposed to rust code. // Call these methods rather than manually calling through the VTable struct. impl nsIThreadPool { /// ```text /// /** /// * Shutdown the thread pool. This method may not be executed from any thread /// * in the thread pool. Instead, it is meant to be executed from another /// * thread (usually the thread that created this thread pool). When this /// * function returns, the thread pool and all of its threads will be shutdown, /// * and it will no longer be possible to dispatch tasks to the thread pool. /// * /// * As a side effect, events on the current thread will be processed. /// */ /// ``` /// /// `void shutdown ();` #[inline] pub unsafe fn Shutdown(&self, ) -> nsresult { ((*self.vtable).Shutdown)(self, ) } /// ```text /// /** /// * Get/set the maximum number of threads allowed at one time in this pool. /// */ /// ``` /// /// `attribute unsigned long threadLimit;` #[inline] pub unsafe fn GetThreadLimit(&self, aThreadLimit: *mut libc::uint32_t) -> nsresult { ((*self.vtable).GetThreadLimit)(self, aThreadLimit) } /// ```text /// /** /// * Get/set the maximum number of threads allowed at one time in this pool. /// */ /// ``` /// /// `attribute unsigned long threadLimit;` #[inline] pub unsafe fn SetThreadLimit(&self, aThreadLimit: libc::uint32_t) -> nsresult { ((*self.vtable).SetThreadLimit)(self, aThreadLimit) } /// ```text /// /** /// * Get/set the maximum number of idle threads kept alive. /// */ /// ``` /// /// `attribute unsigned long idleThreadLimit;` #[inline] pub unsafe fn GetIdleThreadLimit(&self, aIdleThreadLimit: *mut libc::uint32_t) -> nsresult { ((*self.vtable).GetIdleThreadLimit)(self, aIdleThreadLimit) } /// ```text /// /** /// * Get/set the maximum number of idle threads kept alive. /// */ /// ``` /// /// `attribute unsigned long idleThreadLimit;` #[inline] pub unsafe fn SetIdleThreadLimit(&self, aIdleThreadLimit: libc::uint32_t) -> nsresult { ((*self.vtable).SetIdleThreadLimit)(self, aIdleThreadLimit) } /// ```text /// /** /// * Get/set the amount of time in milliseconds before an idle thread is /// * destroyed. /// */ /// ``` /// /// `attribute unsigned long idleThreadTimeout;` #[inline] pub unsafe fn GetIdleThreadTimeout(&self, aIdleThreadTimeout: *mut libc::uint32_t) -> nsresult { ((*self.vtable).GetIdleThreadTimeout)(self, aIdleThreadTimeout) } /// ```text /// /** /// * Get/set the amount of time in milliseconds before an idle thread is /// * destroyed. /// */ /// ``` /// /// `attribute unsigned long idleThreadTimeout;` #[inline] pub unsafe fn SetIdleThreadTimeout(&self, aIdleThreadTimeout: libc::uint32_t) -> nsresult { ((*self.vtable).SetIdleThreadTimeout)(self, aIdleThreadTimeout) } /// ```text /// /** /// * Get/set the number of bytes reserved for the stack of all threads in /// * the pool. By default this is nsIThreadManager::DEFAULT_STACK_SIZE. /// */ /// ``` /// /// `attribute unsigned long threadStackSize;` #[inline] pub unsafe fn GetThreadStackSize(&self, aThreadStackSize: *mut libc::uint32_t) -> nsresult { ((*self.vtable).GetThreadStackSize)(self, aThreadStackSize) } /// ```text /// /** /// * Get/set the number of bytes reserved for the stack of all threads in /// * the pool. By default this is nsIThreadManager::DEFAULT_STACK_SIZE. /// */ /// ``` /// /// `attribute unsigned long threadStackSize;` #[inline] pub unsafe fn SetThreadStackSize(&self, aThreadStackSize: libc::uint32_t) -> nsresult { ((*self.vtable).SetThreadStackSize)(self, aThreadStackSize) } /// ```text /// /** /// * An optional listener that will be notified when a thread is created or /// * destroyed in the course of the thread pool's operation. /// * /// * A listener will only receive notifications about threads created after the /// * listener is set so it is recommended that the consumer set the listener /// * before dispatching the first event. A listener that receives an /// * onThreadCreated() notification is guaranteed to always receive the /// * corresponding onThreadShuttingDown() notification. /// * /// * The thread pool takes ownership of the listener and releases it when the /// * shutdown() method is called. Threads created after the listener is set will /// * also take ownership of the listener so that the listener will be kept alive /// * long enough to receive the guaranteed onThreadShuttingDown() notification. /// */ /// ``` /// /// `attribute nsIThreadPoolListener listener;` #[inline] pub unsafe fn GetListener(&self, aListener: *mut *const nsIThreadPoolListener) -> nsresult { ((*self.vtable).GetListener)(self, aListener) } /// ```text /// /** /// * An optional listener that will be notified when a thread is created or /// * destroyed in the course of the thread pool's operation. /// * /// * A listener will only receive notifications about threads created after the /// * listener is set so it is recommended that the consumer set the listener /// * before dispatching the first event. A listener that receives an /// * onThreadCreated() notification is guaranteed to always receive the /// * corresponding onThreadShuttingDown() notification. /// * /// * The thread pool takes ownership of the listener and releases it when the /// * shutdown() method is called. Threads created after the listener is set will /// * also take ownership of the listener so that the listener will be kept alive /// * long enough to receive the guaranteed onThreadShuttingDown() notification. /// */ /// ``` /// /// `attribute nsIThreadPoolListener listener;` #[inline] pub unsafe fn SetListener(&self, aListener: *const nsIThreadPoolListener) -> nsresult { ((*self.vtable).SetListener)(self, aListener) } /// ```text /// /** /// * Set the label for threads in the pool. All threads will be named /// * "<aName> #<n>", where <n> is a serial number. /// */ /// ``` /// /// `void setName (in ACString aName);` #[inline] pub unsafe fn SetName(&self, aName: &::nsstring::nsACString) -> nsresult { ((*self.vtable).SetName)(self, aName) } }