README.md
1# wepoll-ffi
2
3Bindings for wepoll (epoll on windows)
4
5This crate provides unsafe bindings. Please refer to https://github.com/piscisaureus/wepoll for more details.
6
7The version of wepoll included is currently 1.58 with an optional patch. (use the
8`null-overlapped-wakeups-patch` crate feature to enable it, see below for more details.)
9
10## Feature Flags
11
12### null-overlapped-wakeups-patch
13
14In the `polling` crate, in order to implement notify(), PostQueuedCompletionStatus is called with a null
15lpOverlapped parameter. This will result in GetQueuedCompletionStatusEx providing an event that also
16has a null lpOverlapped parameter. Unmodified wepoll will crash, as it assumes lpOverlapped is not null.
17
18This feature will instead treat this as an indication to break out of a wait early. The change is based on the
19following:
20- https://github.com/piscisaureus/wepoll/pull/20
21- https://github.com/piscisaureus/wepoll/pull/20#issuecomment-677646507
22
23[Patch diff here](https://github.com/aclysma/wepoll/commit/3cf5cf446b9b30bd98803cbdc7c7ab8a791789c9)
24
25## License
26
27The bindings are licensed under either of
28
29* BSD 2-clause ([LICENSE-BSD-2-CLAUSE](LICENSE-BSD-2-CLAUSE) or https://opensource.org/licenses/BSD-2-Clause)
30* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
31* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
32
33at your option.
34
35The BSD 2-clause license is also used by the wrapped library.
36
37### Upstream Dependencies
38
39Some dependencies may be licensed under other terms. These licenses currently include "BSD-2-Clause",
40"MIT", and "Apache-2.0". This is validated on a best-effort basis in every CI run using cargo-deny.
41
42`wepoll` is licensed under BSD-2-clause:
43
44wepoll - epoll for Windows
45https://github.com/piscisaureus/wepoll
46
47Copyright 2012-2020, Bert Belder <bertbelder@gmail.com>
48All rights reserved.
49
50Redistribution and use in source and binary forms, with or without
51modification, are permitted provided that the following conditions are
52met:
53
54* Redistributions of source code must retain the above copyright
55 notice, this list of conditions and the following disclaimer.
56
57* Redistributions in binary form must reproduce the above copyright
58 notice, this list of conditions and the following disclaimer in the
59 documentation and/or other materials provided with the distribution.
60
61THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
62"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
63LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
64A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
65OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
66SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
67LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
68DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
69THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
70(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
71OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
72
73## Contribution
74
75Unless you explicitly state otherwise, any contribution intentionally
76submitted for inclusion in the work by you, as defined in the Apache-2.0
77license, shall be licensed as above, without any additional terms or
78conditions.
79
80See [LICENSE-BSD-2-CLAUSE](LICENSE-BSD-2-CLAUSE) [LICENSE-APACHE](LICENSE-APACHE), and [LICENSE-MIT](LICENSE-MIT).
81