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
// // DO NOT EDIT. THIS FILE IS GENERATED FROM ../../../dist/idl/nsISocketTransportService.idl // /// `interface nsISocketTransportService : 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 nsISocketTransportService { vtable: *const nsISocketTransportServiceVTable, /// 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 nsISocketTransportService. unsafe impl XpCom for nsISocketTransportService { const IID: nsIID = nsID(0xad56b25f, 0xe6bb, 0x4db3, [0x9f, 0x7b, 0x5b, 0x7d, 0xb3, 0x3f, 0xd2, 0xb1]); } // 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 nsISocketTransportService { #[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 nsISocketTransportService. // 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 nsISocketTransportServiceCoerce { /// Cheaply cast a value of this type from a `nsISocketTransportService`. fn coerce_from(v: &nsISocketTransportService) -> &Self; } // The trivial implementation: We can obviously coerce ourselves to ourselves. impl nsISocketTransportServiceCoerce for nsISocketTransportService { #[inline] fn coerce_from(v: &nsISocketTransportService) -> &Self { v } } impl nsISocketTransportService { /// Cast this `nsISocketTransportService` to one of its base interfaces. #[inline] pub fn coerce<T: nsISocketTransportServiceCoerce>(&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 nsISocketTransportService { 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> nsISocketTransportServiceCoerce for T { #[inline] fn coerce_from(v: &nsISocketTransportService) -> &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 nsISocketTransportService // 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 nsISocketTransportServiceVTable { /// We need to include the members from the base interface's vtable at the start /// of the VTable definition. pub __base: nsISupportsVTable, /* nsISocketTransport createTransport ([array, size_is (aTypeCount)] in string aSocketTypes, in unsigned long aTypeCount, in AUTF8String aHost, in long aPort, in nsIProxyInfo aProxyInfo); */ pub CreateTransport: unsafe extern "system" fn (this: *const nsISocketTransportService, aSocketTypes: *mut *const libc::c_char, aTypeCount: libc::uint32_t, aHost: &::nsstring::nsACString, aPort: libc::int32_t, aProxyInfo: *const nsIProxyInfo, _retval: *mut *const nsISocketTransport) -> nsresult, /* nsISocketTransport createUnixDomainTransport (in nsIFile aPath); */ pub CreateUnixDomainTransport: unsafe extern "system" fn (this: *const nsISocketTransportService, aPath: *const nsIFile, _retval: *mut *const nsISocketTransport) -> nsresult, /* [noscript] void attachSocket (in PRFileDescPtr aFd, in nsASocketHandlerPtr aHandler); */ /// Unable to generate binding because `native type PRFileDesc is unsupported` pub AttachSocket: *const ::libc::c_void, /* [noscript] void notifyWhenCanAttachSocket (in nsIRunnable aEvent); */ pub NotifyWhenCanAttachSocket: unsafe extern "system" fn (this: *const nsISocketTransportService, aEvent: *const nsIRunnable) -> 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 nsISocketTransportService { /// ```text /// /** /// * Creates a transport for a specified host and port. /// * /// * @param aSocketTypes /// * array of socket type strings. null if using default socket type. /// * @param aTypeCount /// * specifies length of aSocketTypes. /// * @param aHost /// * specifies the target hostname or IP address literal of the peer /// * for this socket. /// * @param aPort /// * specifies the target port of the peer for this socket. /// * @param aProxyInfo /// * specifies the transport-layer proxy type to use. null if no /// * proxy. used for communicating information about proxies like /// * SOCKS (which are transparent to upper protocols). /// * /// * @see nsIProxiedProtocolHandler /// * @see nsIProtocolProxyService::GetProxyInfo /// * /// * NOTE: this function can be called from any thread /// */ /// ``` /// /// `nsISocketTransport createTransport ([array, size_is (aTypeCount)] in string aSocketTypes, in unsigned long aTypeCount, in AUTF8String aHost, in long aPort, in nsIProxyInfo aProxyInfo);` #[inline] pub unsafe fn CreateTransport(&self, aSocketTypes: *mut *const libc::c_char, aTypeCount: libc::uint32_t, aHost: &::nsstring::nsACString, aPort: libc::int32_t, aProxyInfo: *const nsIProxyInfo, _retval: *mut *const nsISocketTransport) -> nsresult { ((*self.vtable).CreateTransport)(self, aSocketTypes, aTypeCount, aHost, aPort, aProxyInfo, _retval) } /// ```text /// /** /// * Create a transport built on a Unix domain socket, connecting to the /// * given filename. /// * /// * Since Unix domain sockets are always local to the machine, they are /// * not affected by the nsIIOService's 'offline' flag. /// * /// * On systems that don't support Unix domain sockets at all, this /// * returns NS_ERROR_SOCKET_ADDRESS_NOT_SUPPORTED. /// * /// * The system-level socket API may impose restrictions on the length of /// * the filename that are stricter than those of the underlying /// * filesystem. If the file name is too long, this returns /// * NS_ERROR_FILE_NAME_TOO_LONG. /// * /// * The |aPath| parameter must specify an existing directory entry. /// * Otherwise, this returns NS_ERROR_FILE_NOT_FOUND. /// * /// * The program must have search permission on all components of the /// * path prefix of |aPath|, and read and write permission on |aPath| /// * itself. Without such permission, this returns /// * NS_ERROR_CONNECTION_REFUSED. /// * /// * The |aPath| parameter must refer to a unix-domain socket. Otherwise, /// * this returns NS_ERROR_CONNECTION_REFUSED. (POSIX specifies /// * ECONNREFUSED when "the target address was not listening for /// * connections", and this is what Linux returns.) /// * /// * @param aPath /// * The file name of the Unix domain socket to which we should /// * connect. /// */ /// ``` /// /// `nsISocketTransport createUnixDomainTransport (in nsIFile aPath);` #[inline] pub unsafe fn CreateUnixDomainTransport(&self, aPath: *const nsIFile, _retval: *mut *const nsISocketTransport) -> nsresult { ((*self.vtable).CreateUnixDomainTransport)(self, aPath, _retval) } /// ```text /// /** /// * Adds a new socket to the list of controlled sockets. /// * /// * This will fail with the error code NS_ERROR_NOT_AVAILABLE if the maximum /// * number of sockets is already reached. /// * In this case, the notifyWhenCanAttachSocket method should be used. /// * /// * @param aFd /// * Open file descriptor of the socket to control. /// * @param aHandler /// * Socket handler that will receive notifications when the socket is /// * ready or detached. /// * /// * NOTE: this function may only be called from an event dispatch on the /// * socket thread. /// */ /// ``` /// /// `[noscript] void attachSocket (in PRFileDescPtr aFd, in nsASocketHandlerPtr aHandler);` const _AttachSocket: () = (); /// ```text /// /** /// * if the number of sockets reaches the limit, then consumers can be /// * notified when the number of sockets becomes less than the limit. the /// * notification is asynchronous, delivered via the given nsIRunnable /// * instance on the socket transport thread. /// * /// * @param aEvent /// * Event that will receive the notification when a new socket can /// * be attached /// * /// * NOTE: this function may only be called from an event dispatch on the /// * socket thread. /// */ /// ``` /// /// `[noscript] void notifyWhenCanAttachSocket (in nsIRunnable aEvent);` #[inline] pub unsafe fn NotifyWhenCanAttachSocket(&self, aEvent: *const nsIRunnable) -> nsresult { ((*self.vtable).NotifyWhenCanAttachSocket)(self, aEvent) } } /// `interface nsIRoutedSocketTransportService : nsISocketTransportService` /// // 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 nsIRoutedSocketTransportService { vtable: *const nsIRoutedSocketTransportServiceVTable, /// 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 nsIRoutedSocketTransportService. unsafe impl XpCom for nsIRoutedSocketTransportService { const IID: nsIID = nsID(0xc5204623, 0x5b58, 0x4a16, [0x8b, 0x2e, 0x67, 0xc3, 0x4d, 0xd0, 0x2e, 0x3f]); } // 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 nsIRoutedSocketTransportService { #[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 nsIRoutedSocketTransportService. // 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 nsIRoutedSocketTransportServiceCoerce { /// Cheaply cast a value of this type from a `nsIRoutedSocketTransportService`. fn coerce_from(v: &nsIRoutedSocketTransportService) -> &Self; } // The trivial implementation: We can obviously coerce ourselves to ourselves. impl nsIRoutedSocketTransportServiceCoerce for nsIRoutedSocketTransportService { #[inline] fn coerce_from(v: &nsIRoutedSocketTransportService) -> &Self { v } } impl nsIRoutedSocketTransportService { /// Cast this `nsIRoutedSocketTransportService` to one of its base interfaces. #[inline] pub fn coerce<T: nsIRoutedSocketTransportServiceCoerce>(&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 nsIRoutedSocketTransportService { type Target = nsISocketTransportService; #[inline] fn deref(&self) -> &nsISocketTransportService { 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: nsISocketTransportServiceCoerce> nsIRoutedSocketTransportServiceCoerce for T { #[inline] fn coerce_from(v: &nsIRoutedSocketTransportService) -> &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 nsIRoutedSocketTransportService // 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 nsIRoutedSocketTransportServiceVTable { /// We need to include the members from the base interface's vtable at the start /// of the VTable definition. pub __base: nsISocketTransportServiceVTable, /* nsISocketTransport createRoutedTransport ([array, size_is (aTypeCount)] in string aSocketTypes, in unsigned long aTypeCount, in AUTF8String aHost, in long aPort, in AUTF8String aHostRoute, in long aPortRoute, in nsIProxyInfo aProxyInfo); */ pub CreateRoutedTransport: unsafe extern "system" fn (this: *const nsIRoutedSocketTransportService, aSocketTypes: *mut *const libc::c_char, aTypeCount: libc::uint32_t, aHost: &::nsstring::nsACString, aPort: libc::int32_t, aHostRoute: &::nsstring::nsACString, aPortRoute: libc::int32_t, aProxyInfo: *const nsIProxyInfo, _retval: *mut *const nsISocketTransport) -> 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 nsIRoutedSocketTransportService { /// `nsISocketTransport createRoutedTransport ([array, size_is (aTypeCount)] in string aSocketTypes, in unsigned long aTypeCount, in AUTF8String aHost, in long aPort, in AUTF8String aHostRoute, in long aPortRoute, in nsIProxyInfo aProxyInfo);` #[inline] pub unsafe fn CreateRoutedTransport(&self, aSocketTypes: *mut *const libc::c_char, aTypeCount: libc::uint32_t, aHost: &::nsstring::nsACString, aPort: libc::int32_t, aHostRoute: &::nsstring::nsACString, aPortRoute: libc::int32_t, aProxyInfo: *const nsIProxyInfo, _retval: *mut *const nsISocketTransport) -> nsresult { ((*self.vtable).CreateRoutedTransport)(self, aSocketTypes, aTypeCount, aHost, aPort, aHostRoute, aPortRoute, aProxyInfo, _retval) } }