diff options
Diffstat (limited to 'lib/Net.Transport.SimpleTCP')
| -rw-r--r-- | lib/Net.Transport.SimpleTCP/LICENSE.txt | 195 | ||||
| -rw-r--r-- | lib/Net.Transport.SimpleTCP/README.md | 61 | ||||
| -rw-r--r-- | lib/Net.Transport.SimpleTCP/src/ITransportInterface.cs | 85 | ||||
| -rw-r--r-- | lib/Net.Transport.SimpleTCP/src/ReusableNetworkStream.cs | 153 | ||||
| -rw-r--r-- | lib/Net.Transport.SimpleTCP/src/SocketPipeLineWorker.cs | 521 | ||||
| -rw-r--r-- | lib/Net.Transport.SimpleTCP/src/TCPConfig.cs | 97 | ||||
| -rw-r--r-- | lib/Net.Transport.SimpleTCP/src/TcpServer.cs | 289 | ||||
| -rw-r--r-- | lib/Net.Transport.SimpleTCP/src/TransportEventContext.cs | 123 | ||||
| -rw-r--r-- | lib/Net.Transport.SimpleTCP/src/VNLib.Net.Transport.SimpleTCP.csproj | 45 | ||||
| -rw-r--r-- | lib/Net.Transport.SimpleTCP/src/VnSocketAsyncArgs.cs | 181 |
10 files changed, 1750 insertions, 0 deletions
diff --git a/lib/Net.Transport.SimpleTCP/LICENSE.txt b/lib/Net.Transport.SimpleTCP/LICENSE.txt new file mode 100644 index 0000000..147bcd6 --- /dev/null +++ b/lib/Net.Transport.SimpleTCP/LICENSE.txt @@ -0,0 +1,195 @@ +Copyright (c) 2022 Vaughn Nugent + +Contact information + Name: Vaughn Nugent + Email: public[at]vaughnnugent[dot]com + Website: https://www.vaughnnugent.com + +The software in this repository is licensed under the GNU Affero GPL version 3.0 (or any later version). + +GNU AFFERO GENERAL PUBLIC LICENSE + +Version 3, 19 November 2007 + +Copyright © 2007 Free Software Foundation, Inc. <https://fsf.org/> +Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. +Preamble + +The GNU Affero General Public License is a free, copyleft license for software and other kinds of works, specifically designed to ensure cooperation with the community in the case of network server software. + +The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, our General Public Licenses are intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. + +When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. + +Developers that use our General Public Licenses protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License which gives you legal permission to copy, distribute and/or modify the software. + +A secondary benefit of defending all users' freedom is that improvements made in alternate versions of the program, if they receive widespread use, become available for other developers to incorporate. Many developers of free software are heartened and encouraged by the resulting cooperation. However, in the case of software used on network servers, this result may fail to come about. The GNU General Public License permits making a modified version and letting the public access it on a server without ever releasing its source code to the public. + +The GNU Affero General Public License is designed specifically to ensure that, in such cases, the modified source code becomes available to the community. It requires the operator of a network server to provide the source code of the modified version running there to the users of that server. Therefore, public use of a modified version, on a publicly accessible server, gives the public access to the source code of the modified version. + +An older license, called the Affero General Public License and published by Affero, was designed to accomplish similar goals. This is a different license, not a version of the Affero GPL, but Affero has released a new version of the Affero GPL which permits relicensing under this license. + +The precise terms and conditions for copying, distribution and modification follow. +TERMS AND CONDITIONS +0. Definitions. + +"This License" refers to version 3 of the GNU Affero General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based on the Program. + +To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. + +An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. +1. Source Code. + +The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. + +A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same work. +2. Basic Permissions. + +All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. +3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. + +When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. +4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. +5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified it, and giving a relevant date. + b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". + c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. + d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. + +A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. +6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: + + a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. + b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. + c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. + d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. + e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. + +"Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. + +If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). + +The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. + +Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. +7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or + b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or + c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or + d) Limiting the use for publicity purposes of names of licensors or authors of the material; or + e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or + f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. + +All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. +8. Termination. + +You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). + +However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. + +Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. + +Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. +9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. +10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. +11. Patents. + +A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. + +If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. + +A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. +12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. +13. Remote Network Interaction; Use with the GNU General Public License. + +Notwithstanding any other provision of this License, if you modify the Program, your modified version must prominently offer all users interacting with it remotely through a computer network (if your version supports such interaction) an opportunity to receive the Corresponding Source of your version by providing access to the Corresponding Source from a network server at no charge, through some standard or customary means of facilitating copying of software. This Corresponding Source shall include the Corresponding Source for any work covered by version 3 of the GNU General Public License that is incorporated pursuant to the following paragraph. + +Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the work with which it is combined will remain governed by version 3 of the GNU General Public License. +14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions of the GNU Affero General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU Affero General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU Affero General Public License, you may choose any version ever published by the Free Software Foundation. + +If the Program specifies that a proxy can decide which future versions of the GNU Affero General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. + +Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. +15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. +16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. +17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS
\ No newline at end of file diff --git a/lib/Net.Transport.SimpleTCP/README.md b/lib/Net.Transport.SimpleTCP/README.md new file mode 100644 index 0000000..2db8775 --- /dev/null +++ b/lib/Net.Transport.SimpleTCP/README.md @@ -0,0 +1,61 @@ +# VNLib.Net.Transport.SimpleTCP + +_A managed .NET simple, high performance - single process, low/no allocation, fully asynchronous, tcp socket server._ + +This library was created for use with the VNLib.Net.Http library and subsequent stacked framework libraries, however it was designed to be useful as a standalone high-performance .NET tcp listener. This library relies on the managed .NET [System.IO.Pipelines](https://github.com/dotnet/docs/blob/main/docs/standard/io/pipelines.md) library, and the **VNLib.Utils** library. + +##### SSL Support +The TcpServer manages ssl/tls using the SslStream class to make tls as transparent to the application as possible. The server manages authentication and negotiation based on the configured `SslServerAuthenticationOptions` + +## Usage + +```programming language C# + //Init config + TCPConfig config = new() + { + ... configure + } + + //Create the new server + TcpServer server = new(config); + + //Open the socket and begin listening for connections until the token is cancelled + server.Start(<cancellationToken>); + + //Listen for connections + while(true) + { + TransportEventContext ctx = await server.AcceptAsync(<cancellationToken>); + + try + { + ..Do stuff with context, such as read data from stream + byte[] buffer = new byte [1024]; + int count = await ctx.ConnectionStream,ReadAsync(buffer) + } + finally + { + await ctx.CloseConnectionAsync(); + } + } +``` + + +### Tuning information + +##### Internal buffers +Internal buffers are allocated for reading and writing to the internal socket. Receive buffers sizes are set to the `Socket.ReceiveBufferSize`, +so if you wish to reduce socket memory consumption, you may use the `TCPConfig.OnSocketCreated` callback method to configure your socket accordingly. + +##### Threading +This library uses the SocketAsyncEventArgs WinSock socket programming paradigm, so the `TPCConfig.AcceptThread` configuration property is the number of outstanding SocketAsyncEvents that will be pending. This value should be tuned to your use case, lower numbers relative to processor count may yield less accepts/second, higher numbers may see no increase or even reduced performance. + +##### Internal object cache +TcpServer maintains a complete object cache (VNLib.Utils.Memory.Caching.ObjectCache) which may grow quite large for your application depending on load, tuning the cache quota config property may be useful for your application. Lower numbers will increase GC load, higher values (or disabled) will likely yield a larger working set. Because of this the TcpServer class implements the ICacheHolder interface. **Note:** because TcpServer caches store disposable objects, the `CacheClear()` method does nothing. To programatically clear these caches, call the `CacheHardClear()` method. + +##### Memory pools +Since this library implements the System.IO.Pipelines, it uses the `MemoryPool<byte>` memory manager interface, you may consider using the VNLib.Utils `IUnmanagedHeap.ToPool<T>()` extension method to convert your `IUnmanagedHeap` to a `MemoryPool<byte>` + +## Lisence +The software in this repository is licensed under the GNU Affero General Public License (or any later version). +See the LICENSE files for more information.
\ No newline at end of file diff --git a/lib/Net.Transport.SimpleTCP/src/ITransportInterface.cs b/lib/Net.Transport.SimpleTCP/src/ITransportInterface.cs new file mode 100644 index 0000000..7d21995 --- /dev/null +++ b/lib/Net.Transport.SimpleTCP/src/ITransportInterface.cs @@ -0,0 +1,85 @@ +/* +* Copyright (c) 2022 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Net.Transport.SimpleTCP +* File: ITransportInterface.cs +* +* ITransportInterface.cs is part of VNLib.Net.Transport.SimpleTCP which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Net.Transport.SimpleTCP is free software: you can redistribute it and/or modify +* it under the terms of the GNU Affero General Public License as +* published by the Free Software Foundation, either version 2 of the +* License, or (at your option) any later version. +* +* VNLib.Net.Transport.SimpleTCP is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU Affero General Public License for more details. +* +* You should have received a copy of the GNU Affero General Public License +* along with this program. If not, see https://www.gnu.org/licenses/. +*/ + + +using System; +using System.Threading; +using System.Threading.Tasks; + +namespace VNLib.Net.Transport.Tcp +{ + /// <summary> + /// Abstraction layer for TCP transport operations with + /// sync and async support. + /// </summary> + interface ITransportInterface + { + /// <summary> + /// Gets or sets the read timeout in milliseconds + /// </summary> + int RecvTimeoutMs { get; set; } + + /// <summary> + /// Gets or set the time (in milliseconds) the transport should wait for a send operation + /// </summary> + int SendTimeoutMs { get; set; } + + /// <summary> + /// Performs an asynchronous send operation + /// </summary> + /// <param name="data">The buffer containing the data to send to the client</param> + /// <param name="cancellation">A token to cancel the operation</param> + /// <returns>A ValueTask that completes when the send operation is complete</returns> + ValueTask SendAsync(ReadOnlyMemory<byte> data, CancellationToken cancellation); + + /// <summary> + /// Performs an asynchronous send operation + /// </summary> + /// <param name="buffer">The data buffer to write received data to</param> + /// <param name="cancellation">A token to cancel the operation</param> + /// <returns>A ValueTask that returns the number of bytes read into the buffer</returns> + ValueTask<int> RecvAsync(Memory<byte> buffer, CancellationToken cancellation); + + /// <summary> + /// Performs a synchronous send operation + /// </summary> + /// <param name="data">The buffer to send to the client</param> + void Send(ReadOnlySpan<byte> data); + + /// <summary> + /// Performs a synchronous receive operation + /// </summary> + /// <param name="buffer">The buffer to copy output data to</param> + /// <returns>The number of bytes received</returns> + int Recv(Span<byte> buffer); + + /// <summary> + /// Raised when the interface is no longer required and resources + /// related to the connection should be released. + /// </summary> + /// <returns>A task that resolves when the operation is complete</returns> + Task CloseAsync(); + + } +}
\ No newline at end of file diff --git a/lib/Net.Transport.SimpleTCP/src/ReusableNetworkStream.cs b/lib/Net.Transport.SimpleTCP/src/ReusableNetworkStream.cs new file mode 100644 index 0000000..f4a5491 --- /dev/null +++ b/lib/Net.Transport.SimpleTCP/src/ReusableNetworkStream.cs @@ -0,0 +1,153 @@ +/* +* Copyright (c) 2022 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Net.Transport.SimpleTCP +* File: ReusableNetworkStream.cs +* +* ReusableNetworkStream.cs is part of VNLib.Net.Transport.SimpleTCP which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Net.Transport.SimpleTCP is free software: you can redistribute it and/or modify +* it under the terms of the GNU Affero General Public License as +* published by the Free Software Foundation, either version 2 of the +* License, or (at your option) any later version. +* +* VNLib.Net.Transport.SimpleTCP is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU Affero General Public License for more details. +* +* You should have received a copy of the GNU Affero General Public License +* along with this program. If not, see https://www.gnu.org/licenses/. +*/ + +/* + * A special stream that sits betnween the socket/pipeline listener + * that marshals data between the application and the socket pipeline. + * This stream uses a timer to cancel recv events. Because of this and + * pipeline aspects, it supports full duplex IO but it is not thread safe. + * + * IE one thread can read and write, but not more + */ + + +using System; +using System.IO; +using System.Threading; +using System.Threading.Tasks; + +using VNLib.Utils.Extensions; + +namespace VNLib.Net.Transport.Tcp +{ + + /// <summary> + /// A reusable stream that marshals data between the socket pipeline and the application + /// </summary> + internal sealed class ReusableNetworkStream : Stream + { + #region stream basics + public override bool CanRead => true; + public override bool CanSeek => false; + public override bool CanWrite => true; + public override bool CanTimeout => true; + public override long Length => throw new NotSupportedException(); + public override long Position { get => throw new NotSupportedException(); set => throw new NotImplementedException(); } + public override long Seek(long offset, SeekOrigin origin) => throw new NotSupportedException(); + public override void SetLength(long value) => throw new NotSupportedException(); + #endregion + + //Read timeout to use when receiving data + public override int ReadTimeout + { + get => Transport.RecvTimeoutMs; + //Allow -1 to set to infinite timeout + set => Transport.RecvTimeoutMs = value > -2 ? value : throw new ArgumentException("Write timeout must be a 32bit signed integer larger than 0"); + } + + // Write timeout is not currently used, becasue the writer managed socket timeouts + public override int WriteTimeout + { + get => Transport.SendTimeoutMs; + //Allow -1 to set to infinite timeout + set => Transport.SendTimeoutMs = value > -2 ? value : throw new ArgumentException("Write timeout must be a 32bit signed integer larger than -1"); + } + + //Timer used to cancel pipeline recv timeouts + private readonly ITransportInterface Transport; + + internal ReusableNetworkStream(ITransportInterface transport) + { + Transport = transport; + } + + ///<inheritdoc/> + public override void Close() + { } + ///<inheritdoc/> + public override Task FlushAsync(CancellationToken cancellationToken) => Task.CompletedTask; + ///<inheritdoc/> + public override void Flush() + { } + + ///<inheritdoc/> + public override int Read(byte[] buffer, int offset, int count) => Read(buffer.AsSpan(offset, count)); + ///<inheritdoc/> + public override int Read(Span<byte> buffer) => Transport.Recv(buffer); + + ///<inheritdoc/> + public override Task<int> ReadAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken) + { + //Since read returns a value, it isnt any cheaper not to alloc a task around the value-task + return ReadAsync(buffer.AsMemory(offset, count), cancellationToken).AsTask(); + } + ///<inheritdoc/> + public override ValueTask<int> ReadAsync(Memory<byte> buffer, CancellationToken cancellationToken = default) + { + return Transport.RecvAsync(buffer, cancellationToken); + } + + ///<inheritdoc/> + public override void Write(byte[] buffer, int offset, int count) => Write(buffer.AsSpan(offset, count)); + ///<inheritdoc/> + public override void Write(ReadOnlySpan<byte> buffer) => Transport.Send(buffer); + + public override Task WriteAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken) + { + //Allow synchronous complete to avoid alloc + return WriteAsync(buffer.AsMemory(offset, count), cancellationToken).AsTask(); + } + + ///<inheritdoc/> + ///<exception cref="IOException"></exception> + ///<exception cref="ObjectDisposedException"></exception> + public override ValueTask WriteAsync(ReadOnlyMemory<byte> buffer, CancellationToken cancellation = default) + { + return Transport.SendAsync(buffer, cancellation); + } + + /* + * Override dispose to intercept base cleanup until the internal release + */ + /// <summary> + /// Not supported + /// </summary> + public new void Dispose() + { + //Call sync + Task closing = Transport.CloseAsync(); + closing.Wait(); + } + + public override ValueTask DisposeAsync() + { + return new ValueTask(Transport.CloseAsync()); + } + + public override Task CopyToAsync(Stream destination, int bufferSize, CancellationToken cancellationToken) + { + throw new NotSupportedException("CopyToAsync is not supported"); + } + } +}
\ No newline at end of file diff --git a/lib/Net.Transport.SimpleTCP/src/SocketPipeLineWorker.cs b/lib/Net.Transport.SimpleTCP/src/SocketPipeLineWorker.cs new file mode 100644 index 0000000..89c46e1 --- /dev/null +++ b/lib/Net.Transport.SimpleTCP/src/SocketPipeLineWorker.cs @@ -0,0 +1,521 @@ +/* +* Copyright (c) 2022 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Net.Transport.SimpleTCP +* File: SocketPipeLineWorker.cs +* +* SocketPipeLineWorker.cs is part of VNLib.Net.Transport.SimpleTCP which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Net.Transport.SimpleTCP is free software: you can redistribute it and/or modify +* it under the terms of the GNU Affero General Public License as +* published by the Free Software Foundation, either version 2 of the +* License, or (at your option) any later version. +* +* VNLib.Net.Transport.SimpleTCP is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU Affero General Public License for more details. +* +* You should have received a copy of the GNU Affero General Public License +* along with this program. If not, see https://www.gnu.org/licenses/. +*/ + +using System; +using System.IO; +using System.Buffers; +using System.Threading; +using System.Net.Sockets; +using System.IO.Pipelines; +using System.Threading.Tasks; + +using VNLib.Utils.Memory; +using VNLib.Utils.Memory.Caching; +using VNLib.Utils.Extensions; + +namespace VNLib.Net.Transport.Tcp +{ + /// <summary> + /// A reuseable socket pipeline provider, that marshals data from a network stream + /// to a connected socket. + /// </summary> + internal sealed class SocketPipeLineWorker : ITransportInterface, IReusable + { + public void Prepare() + {} + + public bool Release() + { + /* + * If the pipeline has been started, then the pipes + * will be completed by the worker threads (or by the streams) + * and when release is called, there will no longer be + * an observer for the result, which means the pipes + * may be safely reset for reuse + */ + if (_recvTask != null) + { + //Since the + SendPipe.Reset(); + RecvPipe.Reset(); + } + /* + * If socket had an error and was not started, + * it means there may be data written to the + * recv pipe from the accept operation, that + * needs to be cleared + */ + else + { + //Complete the recvpipe then reset it to discard buffered data + RecvPipe.Reader.Complete(); + RecvPipe.Writer.Complete(); + //now reset it + RecvPipe.Reset(); + } + + //Cleanup tasks + _recvTask = null; + _sendTask = null; + + //Cleanup cts + _cts?.Dispose(); + _cts = null; + + return true; + } + + private Task? _recvTask; + private Task? _sendTask; + + private CancellationTokenSource? _cts; + + public readonly ReusableNetworkStream NetworkStream; + + private readonly Pipe SendPipe; + private readonly Pipe RecvPipe; + private readonly Timer RecvTimer; + private readonly Timer SendTimer; + private readonly Stream RecvStream; + + public int SendTimeoutMs { get; set; } + + public int RecvTimeoutMs { get; set; } + + + /// <summary> + /// Initalizes a new reusable socket pipeline worker + /// </summary> + /// <param name="pipeOptions"></param> + public SocketPipeLineWorker(PipeOptions pipeOptions) + { + //Init pipes + SendPipe = new(pipeOptions); + RecvPipe = new(pipeOptions); + + RecvStream = RecvPipe.Reader.AsStream(true); + + //Init timers to infinite + RecvTimer = new(OnRecvTimerElapsed, state: this, Timeout.Infinite, Timeout.Infinite); + SendTimer = new(OnSendTimerElapsed, state: this, Timeout.Infinite, Timeout.Infinite); + + //Init reusable network stream + NetworkStream = new(this); + + SendTimeoutMs = Timeout.Infinite; + RecvTimeoutMs = Timeout.Infinite; + } + + /// <summary> + /// Gets a buffer used during a socket accept operation + /// </summary> + /// <param name="bufferSize">The size hint of the buffer to get</param> + /// <returns>A memory structure of the specified size</returns> + public Memory<byte> GetMemory(int bufferSize) => RecvPipe.Writer.GetMemory(bufferSize); + + /// <summary> + /// Begins async work to receive and send data on a connected socket + /// </summary> + /// <param name="client">The socket to read/write from</param> + /// <param name="bytesTransferred">The number of bytes to be commited</param> + public void Start(Socket client, int bytesTransferred) + { + //Advance writer + RecvPipe.Writer.Advance(bytesTransferred); + //begin recv tasks, and pass inital data to be flushed flag + _recvTask = RecvDoWorkAsync(client, bytesTransferred > 0); + _sendTask = SendDoWorkAsync(client); + } + + + /* + * NOTES + * + * Timers used to maintain resource exhuastion independent + * of the actual socket pipeline, so to preserve the state + * of the pipelines until the writer is closed. + * + * This choice was made to allow the api consumer to decide how to + * process a timeout without affecting the state of the pipelines + * or socket until the close event. + */ + + private void OnRecvTimerElapsed(object? state) + { + //cancel pending read on recv pipe when timout expires + RecvPipe.Reader.CancelPendingRead(); + } + + private void OnSendTimerElapsed(object? state) + { + //Cancel pending flush + SendPipe.Writer.CancelPendingFlush(); + } + + /* + * Pipeline worker tasks. Listen for data on the socket, + * and listen for data on the pipe to marshal data between + * the pipes and the socket + */ + + private async Task SendDoWorkAsync(Socket sock) + { + Exception? cause = null; + try + { + //Enter work loop + while (true) + { + //wait for data from the write pipe and write it to the socket + ReadResult result = await SendPipe.Reader.ReadAsync(); + //Catch error/cancel conditions and break the loop + if (result.IsCanceled || !sock.Connected || result.Buffer.IsEmpty) + { + break; + } + //get sequence + ReadOnlySequence<byte> buffer = result.Buffer; + + //Get enumerator to write memory segments + ReadOnlySequence<byte>.Enumerator enumerator = buffer.GetEnumerator(); + + //Begin enumerator + while (enumerator.MoveNext()) + { + + /* + * Using a foward only reader allows the following loop + * to track the ammount of data written to the socket + * until the entire segment has been sent or if it has + * move to the next segment + */ + + ForwardOnlyMemoryReader<byte> reader = new(enumerator.Current); + + while(reader.WindowSize > 0) + { + //Write segment to socket, and upate written data + int written = await sock.SendAsync(reader.Window, SocketFlags.None); + + if(written >= reader.WindowSize) + { + //All data was written + break; + } + + //Advance unread window to end of the written data + reader.Advance(written); + } + //Advance to next window/segment + } + + //Advance pipe + SendPipe.Reader.AdvanceTo(buffer.End); + + //Pipe has been completed and all data was written + if (result.IsCompleted) + { + break; + } + } + } + catch (Exception ex) + { + cause = ex; + } + finally + { + //Complete the send pipe writer + await SendPipe.Reader.CompleteAsync(cause); + + //Cancel the recv task + _cts!.Cancel(); + } + } + + private async Task RecvDoWorkAsync(Socket sock, bool initialData) + { + //init new cts + _cts = new(); + + Exception? cause = null; + try + { + //Avoid syscall? + int bufferSize = sock.ReceiveBufferSize; + + //If initial data was buffered, it needs to be published to the reader + if (initialData) + { + //Flush initial data + FlushResult res = await RecvPipe.Writer.FlushAsync(CancellationToken.None); + + if (res.IsCompleted || res.IsCanceled) + { + //Exit + return; + } + } + + //Enter work loop + while (true) + { + //Get buffer from pipe writer + Memory<byte> buffer = RecvPipe.Writer.GetMemory(bufferSize); + + //Wait for data or error from socket + int count = await sock.ReceiveAsync(buffer, SocketFlags.None, _cts.Token); + + //socket returned emtpy data + if (count == 0 || !sock.Connected) + { + break; + } + + //Advance/notify the pipe + RecvPipe.Writer.Advance(count); + + //Flush data at top of loop, since data is available from initial accept + FlushResult res = await RecvPipe.Writer.FlushAsync(CancellationToken.None); + + //Writing has completed, time to exit + if (res.IsCompleted || res.IsCanceled) + { + break; + } + } + } + //Normal exit + catch (OperationCanceledException) + {} + catch (SocketException se) + { + cause = se; + //Cancel sending reader task because the socket has an error and cannot be used + SendPipe.Reader.CancelPendingRead(); + } + catch (Exception ex) + { + cause = ex; + } + finally + { + //Stop timer incase exception + RecvTimer.Stop(); + + //Cleanup and complete the writer + await RecvPipe.Writer.CompleteAsync(cause); + //The recv reader is completed by the network stream + } + } + + /// <summary> + /// The internal cleanup/dispose method to be called + /// when the pipeline is no longer needed + /// </summary> + public void DisposeInternal() + { + RecvTimer.Dispose(); + SendTimer.Dispose(); + + //Perform some managed cleanup + + //Cleanup tasks + _recvTask = null; + _sendTask = null; + + //Cleanup cts + _cts?.Dispose(); + _cts = null; + } + + + private static async Task AwaitFlushTask(ValueTask<FlushResult> valueTask, Timer? sendTimer) + { + try + { + FlushResult result = await valueTask.ConfigureAwait(false); + + if (result.IsCanceled) + { + throw new OperationCanceledException("The operation was canceled by the underlying PipeWriter"); + } + } + finally + { + sendTimer?.Stop(); + } + } + + private ValueTask SendWithTimerInternalAsync(ReadOnlyMemory<byte> data, CancellationToken cancellation) + { + //Start send timer + SendTimer.Restart(SendTimeoutMs); + try + { + //Send the segment + ValueTask<FlushResult> result = SendPipe.Writer.WriteAsync(data, cancellation); + + //Task completed successfully, so + if (result.IsCompletedSuccessfully) + { + //Stop timer + SendTimer.Stop(); + + //Safe to get the rseult + FlushResult fr = result.Result; + //Check for canceled and throw + return fr.IsCanceled + ? throw new OperationCanceledException("The write operation was canceled by the underlying PipeWriter") + : ValueTask.CompletedTask; + } + else + { + //Wrap the task in a ValueTask since it must be awaited, and will happen on background thread + return new(AwaitFlushTask(result, SendTimer)); + } + } + catch + { + //Stop timer on exception + SendTimer.Stop(); + throw; + } + } + + private ValueTask SendWithoutTimerInternalAsync(ReadOnlyMemory<byte> data, CancellationToken cancellation) + { + //Send the segment + ValueTask<FlushResult> result = SendPipe.Writer.WriteAsync(data, cancellation); + + //Task completed successfully, so + if (result.IsCompletedSuccessfully) + { + //Safe to get the rseult + FlushResult fr = result.Result; + //Check for canceled and throw + return fr.IsCanceled + ? throw new OperationCanceledException("The write operation was canceled by the underlying PipeWriter") + : ValueTask.CompletedTask; + } + else + { + //Wrap the task in a ValueTask since it must be awaited, and will happen on background thread + return new(AwaitFlushTask(result, null)); + } + } + + ValueTask ITransportInterface.SendAsync(ReadOnlyMemory<byte> data, CancellationToken cancellation) + { + //Use timer if timeout is set, dont otherwise + return SendTimeoutMs < 1 ? SendWithoutTimerInternalAsync(data, cancellation) : SendWithTimerInternalAsync(data, cancellation); + } + + + void ITransportInterface.Send(ReadOnlySpan<byte> data) + { + //Determine if the send timer should be used + Timer? _timer = SendTimeoutMs < 1 ? null : SendTimer; + + //Write data directly to the writer buffer + SendPipe.Writer.Write(data); + + //Start send timer + _timer?.Restart(SendTimeoutMs); + + try + { + //Send the segment + ValueTask<FlushResult> result = SendPipe.Writer.FlushAsync(CancellationToken.None); + + //Task completed successfully, so + if (result.IsCompletedSuccessfully) + { + //Safe to get the rseult + FlushResult fr = result.Result; + + //Check for canceled and throw + if (fr.IsCanceled) + { + throw new OperationCanceledException("The write operation was canceled by the underlying PipeWriter"); + } + } + else + { + //Await the result + FlushResult fr = result.ConfigureAwait(false).GetAwaiter().GetResult(); + + if (fr.IsCanceled) + { + throw new OperationCanceledException("The write operation was canceled by the underlying PipeWriter"); + } + } + } + finally + { + //Stop timer + _timer?.Stop(); + } + } + + async ValueTask<int> ITransportInterface.RecvAsync(Memory<byte> buffer, CancellationToken cancellation) + { + //Restart timer + RecvTimer.Restart(RecvTimeoutMs); + try + { + return await RecvStream.ReadAsync(buffer, cancellation); + } + finally + { + RecvTimer.Stop(); + } + } + + int ITransportInterface.Recv(Span<byte> buffer) + { + //Restart timer + RecvTimer.Restart(RecvTimeoutMs); + try + { + return RecvStream.Read(buffer); + } + finally + { + RecvTimer.Stop(); + } + } + + Task ITransportInterface.CloseAsync() + { + //Complete the send pipe writer since stream is closed + ValueTask vt = SendPipe.Writer.CompleteAsync(); + //Complete the recv pipe reader since its no longer used + ValueTask rv = RecvPipe.Reader.CompleteAsync(); + //Join worker tasks, no alloc if completed sync, otherwise alloc anyway + return Task.WhenAll(vt.AsTask(), rv.AsTask(), _recvTask!, _sendTask!); + } + + } +} diff --git a/lib/Net.Transport.SimpleTCP/src/TCPConfig.cs b/lib/Net.Transport.SimpleTCP/src/TCPConfig.cs new file mode 100644 index 0000000..6955e63 --- /dev/null +++ b/lib/Net.Transport.SimpleTCP/src/TCPConfig.cs @@ -0,0 +1,97 @@ +/* +* Copyright (c) 2022 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Net.Transport.SimpleTCP +* File: TCPConfig.cs +* +* TCPConfig.cs is part of VNLib.Net.Transport.SimpleTCP which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Net.Transport.SimpleTCP is free software: you can redistribute it and/or modify +* it under the terms of the GNU Affero General Public License as +* published by the Free Software Foundation, either version 2 of the +* License, or (at your option) any later version. +* +* VNLib.Net.Transport.SimpleTCP is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU Affero General Public License for more details. +* +* You should have received a copy of the GNU Affero General Public License +* along with this program. If not, see https://www.gnu.org/licenses/. +*/ + +using System; +using System.Net; +using System.Buffers; +using System.Net.Sockets; +using System.Net.Security; + +using VNLib.Utils.Logging; + +namespace VNLib.Net.Transport.Tcp +{ + /// <summary> + /// Represents the required configuration variables for the transport + /// </summary> + public readonly struct TCPConfig + { + /// <summary> + /// The <see cref="IPEndPoint"/> the listening socket will bind to + /// </summary> + public readonly IPEndPoint LocalEndPoint { get; init; } + /// <summary> + /// The log provider used to write logging information to + /// </summary> + public readonly ILogProvider Log { get; init; } + /// <summary> + /// If TCP keepalive is enabled, the amount of time the connection is considered alive before another probe message is sent + /// </summary> + public readonly int TcpKeepAliveTime { get; init; } + /// <summary> + /// If TCP keepalive is enabled, the amount of time the connection will wait for a keepalive message + /// </summary> + public readonly int KeepaliveInterval { get; init; } + /// <summary> + /// Enables TCP keepalive + /// </summary> + public readonly bool TcpKeepalive { get; init; } + /// <summary> + /// The authentication options to use for processing TLS connections. This value must be set when a certificate has been specified + /// </summary> + public readonly SslServerAuthenticationOptions? AuthenticationOptions { get; init; } + /// <summary> + /// The maximum number of waiting WSA asynchronous socket accept operations + /// </summary> + public readonly uint AcceptThreads { get; init; } + /// <summary> + /// The maximum size (in bytes) the transport will buffer in + /// the receiving pipeline. + /// </summary> + public readonly int MaxRecvBufferData { get; init; } + /// <summary> + /// The listener socket backlog count + /// </summary> + public readonly int BackLog { get; init; } + /// <summary> + /// The <see cref="MemoryPool{T}"/> to allocate transport buffers from + /// </summary> + public readonly MemoryPool<byte> BufferPool { get; init; } + /// <summary> + /// <para> + /// The maxium number of event objects that will be cached + /// during normal operation + /// </para> + /// <para> + /// WARNING: Setting this value too low will cause significant CPU overhead and GC load + /// </para> + /// </summary> + public readonly int CacheQuota { get; init; } + /// <summary> + /// An optional callback invoked after the socket has been created + /// for optional appliction specific socket configuration + /// </summary> + public Action<Socket>? OnSocketCreated { get; init; } + } +}
\ No newline at end of file diff --git a/lib/Net.Transport.SimpleTCP/src/TcpServer.cs b/lib/Net.Transport.SimpleTCP/src/TcpServer.cs new file mode 100644 index 0000000..fc0bcc5 --- /dev/null +++ b/lib/Net.Transport.SimpleTCP/src/TcpServer.cs @@ -0,0 +1,289 @@ +/* +* Copyright (c) 2022 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Net.Transport.SimpleTCP +* File: TcpServer.cs +* +* TcpServer.cs is part of VNLib.Net.Transport.SimpleTCP which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Net.Transport.SimpleTCP is free software: you can redistribute it and/or modify +* it under the terms of the GNU Affero General Public License as +* published by the Free Software Foundation, either version 2 of the +* License, or (at your option) any later version. +* +* VNLib.Net.Transport.SimpleTCP is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU Affero General Public License for more details. +* +* You should have received a copy of the GNU Affero General Public License +* along with this program. If not, see https://www.gnu.org/licenses/. +*/ + +using System; +using System.Security; +using System.Threading; +using System.Net.Sockets; +using System.Net.Security; +using System.IO.Pipelines; +using System.Threading.Tasks; +using System.Security.Authentication; +using System.Runtime.CompilerServices; + +using VNLib.Utils.Async; +using VNLib.Utils.Logging; +using VNLib.Utils.Memory.Caching; + +namespace VNLib.Net.Transport.Tcp +{ + /// <summary> + /// <para> + /// Provides a simple, high performance, single process, low/no allocation, + /// asynchronous, TCP socket server. + /// </para> + /// <para> + /// IO operations are full duplex so pipe-lining reused + /// connections is expected. This class cannot be inherited + /// </para> + /// </summary> + public sealed class TcpServer : ICacheHolder + { + /// <summary> + /// The current <see cref="TcpServer"/> configuration + /// </summary> + public TCPConfig Config { get; } + + private readonly ObjectRental<VnSocketAsyncArgs> SockAsyncArgPool; + private readonly PipeOptions PipeOptions; + private readonly bool _usingTls; + + /// <summary> + /// Initializes a new <see cref="TcpServer"/> with the specified <see cref="TCPConfig"/> + /// </summary> + /// <param name="config">Configuration to inalize with</param> + /// <param name="pipeOptions">Optional <see cref="PipeOptions"/> otherwise uses default</param> + /// <exception cref="ArgumentException"></exception> + /// <exception cref="ArgumentOutOfRangeException"></exception> + public TcpServer(TCPConfig config, PipeOptions? pipeOptions = null) + { + Config = config; + //Check config + _ = config.BufferPool ?? throw new ArgumentException("Buffer pool argument cannot be null"); + _ = config.Log ?? throw new ArgumentException("Log argument is required"); + + if (config.MaxRecvBufferData < 4096) + { + throw new ArgumentException("MaxRecvBufferData size must be at least 4096 bytes to avoid data pipeline pefromance issues"); + } + if(config.AcceptThreads < 1) + { + throw new ArgumentException("Accept thread count must be greater than 0"); + } + if(config.AcceptThreads > Environment.ProcessorCount) + { + config.Log.Debug("Suggestion: Setting accept threads to {pc}", Environment.ProcessorCount); + } + //Cache pipe options + PipeOptions = pipeOptions ?? new( + config.BufferPool, + readerScheduler:PipeScheduler.ThreadPool, + writerScheduler:PipeScheduler.ThreadPool, + pauseWriterThreshold: config.MaxRecvBufferData, + minimumSegmentSize: 8192, + useSynchronizationContext:false + ); + //store tls value + _usingTls = Config.AuthenticationOptions != null; + + SockAsyncArgPool = ObjectRental.CreateReusable(ArgsConstructor, Config.CacheQuota); + } + + ///<inheritdoc/> + public void CacheClear() => SockAsyncArgPool.CacheClear(); + ///<inheritdoc/> + public void CacheHardClear() => SockAsyncArgPool.CacheHardClear(); + + private AsyncQueue<VnSocketAsyncArgs>? WaitingSockets; + private Socket? ServerSock; + //private CancellationToken Token; + + private bool _canceledFlag; + + /// <summary> + /// Begins listening for incoming TCP connections on the configured socket + /// </summary> + /// <param name="token">A token that is used to abort listening operations and close the socket</param> + /// <exception cref="SocketException"></exception> + /// <exception cref="SecurityException"></exception> + /// <exception cref="ArgumentException"></exception> + /// <exception cref="InvalidOperationException"></exception> + public void Start(CancellationToken token) + { + //If the socket is still listening + if (ServerSock != null) + { + throw new InvalidOperationException("The server thread is currently listening and cannot be re-started"); + } + //make sure the token isnt already canceled + if (token.IsCancellationRequested) + { + throw new ArgumentException("Token is already canceled", nameof(token)); + } + + //Configure socket on the current thread so exceptions will be raised to the caller + ServerSock = new(Config.LocalEndPoint.AddressFamily, SocketType.Stream, ProtocolType.Tcp); + //Bind socket + ServerSock.Bind(Config.LocalEndPoint); + //Begin listening + ServerSock.Listen(Config.BackLog); + + //See if keepalive should be used + if (Config.TcpKeepalive) + { + //Setup socket keepalive from config + ServerSock.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.KeepAlive, true); + ServerSock.SetSocketOption(SocketOptionLevel.Tcp, SocketOptionName.TcpKeepAliveInterval, Config.KeepaliveInterval); + ServerSock.SetSocketOption(SocketOptionLevel.Tcp, SocketOptionName.TcpKeepAliveTime, Config.TcpKeepAliveTime); + } + + //Invoke socket created callback + Config.OnSocketCreated?.Invoke(ServerSock); + + //Init waiting socket queue + WaitingSockets = new(false, true); + + //Clear canceled flag + _canceledFlag = false; + + //Start listening for connections + for (int i = 0; i < Config.AcceptThreads; i++) + { + AcceptConnection(); + } + + //Cleanup callback + static void cleanup(object? state) + { + TcpServer server = (TcpServer)state!; + + //Set canceled flag + server._canceledFlag = true; + + //Clean up socket + server.ServerSock!.Dispose(); + server.ServerSock = null; + + server.SockAsyncArgPool.CacheHardClear(); + + //Dispose any queued sockets + while (server.WaitingSockets!.TryDequeue(out VnSocketAsyncArgs? args)) + { + args.Dispose(); + } + } + + //Register cleanup + _ = token.Register(cleanup, this, false); + } + + [MethodImpl(MethodImplOptions.AggressiveInlining)] + private VnSocketAsyncArgs ArgsConstructor() + { + void ReturnCb(VnSocketAsyncArgs args) + { + //If the server has exited, dispose the args and dont return to pool + if (_canceledFlag) + { + args.Dispose(); + } + else + { + SockAsyncArgPool.Return(args); + } + } + + //Socket args accept callback functions for this + VnSocketAsyncArgs args = new(AcceptCompleted, ReturnCb, PipeOptions); + return args; + } + + [MethodImpl(MethodImplOptions.AggressiveInlining)] + private void AcceptConnection() + { + //Make sure cancellation isnt pending + if (_canceledFlag) + { + return; + } + //Rent new args + VnSocketAsyncArgs acceptArgs = SockAsyncArgPool!.Rent(); + //Accept another socket + if (!acceptArgs.BeginAccept(ServerSock!)) + { + //Completed synchronously + AcceptCompleted(acceptArgs); + } + //Completed async + } + + [MethodImpl(MethodImplOptions.AggressiveInlining)] + private void AcceptCompleted(VnSocketAsyncArgs args) + { + //Examine last op for aborted error, if aborted, then the listening socket has exited + if (args.SocketError == SocketError.OperationAborted) + { + //Dispose args since server is exiting + args.Dispose(); + return; + } + //Check for error on accept, and if no error, enqueue the socket, otherwise disconnect the socket + if (!args.EndAccept() || !WaitingSockets!.TryEnque(args)) + { + //Disconnect the socket (will return the args to the pool) + args.Disconnect(); + } + //Accept a new connection + AcceptConnection(); + } + + + /// <summary> + /// Retreives a connected socket from the waiting queue + /// </summary> + /// <returns>The context of the connect</returns> + /// <exception cref="InvalidOperationException"></exception> + public async ValueTask<TransportEventContext> AcceptAsync(CancellationToken cancellation) + { + _ = WaitingSockets ?? throw new InvalidOperationException("Server is not listening"); + //Args is ready to use + VnSocketAsyncArgs args = await WaitingSockets.DequeueAsync(cancellation); + //See if tls is enabled, if so, start tls handshake + if (_usingTls) + { + //Begin authenication and make sure the socket stream is closed as its required to cleanup + SslStream stream = new(args.Stream, false); + try + { + //auth the new connection + await stream.AuthenticateAsServerAsync(Config.AuthenticationOptions!, cancellation); + return new(args, stream); + } + catch(Exception ex) + { + await stream.DisposeAsync(); + + //Disconnect socket + args.Disconnect(); + + throw new AuthenticationException("Failed client/server TLS authentication", ex); + } + } + else + { + return new(args, args.Stream); + } + } + } +}
\ No newline at end of file diff --git a/lib/Net.Transport.SimpleTCP/src/TransportEventContext.cs b/lib/Net.Transport.SimpleTCP/src/TransportEventContext.cs new file mode 100644 index 0000000..fc04d0c --- /dev/null +++ b/lib/Net.Transport.SimpleTCP/src/TransportEventContext.cs @@ -0,0 +1,123 @@ +/* +* Copyright (c) 2022 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Net.Transport.SimpleTCP +* File: TransportEventContext.cs +* +* TransportEventContext.cs is part of VNLib.Net.Transport.SimpleTCP which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Net.Transport.SimpleTCP is free software: you can redistribute it and/or modify +* it under the terms of the GNU Affero General Public License as +* published by the Free Software Foundation, either version 2 of the +* License, or (at your option) any later version. +* +* VNLib.Net.Transport.SimpleTCP is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU Affero General Public License for more details. +* +* You should have received a copy of the GNU Affero General Public License +* along with this program. If not, see https://www.gnu.org/licenses/. +*/ + +using System; +using System.IO; +using System.Net; +using System.Net.Sockets; +using System.Net.Security; +using System.Security.Authentication; +using System.Runtime.CompilerServices; +using System.Threading.Tasks; + + +namespace VNLib.Net.Transport.Tcp +{ + /// <summary> + /// Represents the context of a transport connection. It includes the active socket + /// and a stream representing the active transport. + /// </summary> + public readonly struct TransportEventContext + { + /// <summary> + /// The socket referrence to the incoming connection + /// </summary> + private readonly Socket Socket; + + internal readonly VnSocketAsyncArgs _socketArgs; + + /// <summary> + /// The transport security layer security protocol + /// </summary> + public readonly SslProtocols SslVersion { get; } = SslProtocols.None; + /// <summary> + /// A copy of the local endpoint of the listening socket + /// </summary> + public readonly IPEndPoint LocalEndPoint + { + [MethodImpl(MethodImplOptions.AggressiveInlining)] + get => (Socket.LocalEndPoint as IPEndPoint)!; + } + /// <summary> + /// The <see cref="IPEndPoint"/> representing the client's connection information + /// </summary> + public readonly IPEndPoint RemoteEndpoint + { + [MethodImpl(MethodImplOptions.AggressiveInlining)] + get => (Socket.RemoteEndPoint as IPEndPoint)!; + } + /// <summary> + /// The transport stream to be actively read + /// </summary> + public readonly Stream ConnectionStream; + + + internal TransportEventContext(VnSocketAsyncArgs args, Stream @stream) + { + _socketArgs = args; + Socket = args.Socket!; + ConnectionStream = stream; + } + internal TransportEventContext(VnSocketAsyncArgs args, SslStream @stream):this(args, (Stream)stream) + { + SslVersion = stream.SslProtocol; + } + + /// <summary> + /// Closes a connection and cleans up any resources + /// </summary> + /// <param name="ctx"></param> + /// <returns></returns> + public async ValueTask CloseConnectionAsync() + { + //Var to capture ssl shudown exception + Exception? closeExp = null; + + //Verify ssl is being used and the socket is still 'connected' + if (SslVersion > SslProtocols.None && _socketArgs.Socket!.Connected) + { + try + { + await (ConnectionStream as SslStream)!.ShutdownAsync(); + } + catch (Exception ex) + { + closeExp = ex; + } + } + + //dispose the stream and wait for buffered data to be sent + await ConnectionStream.DisposeAsync(); + + //Disconnect + _socketArgs.Disconnect(); + + //if excp occured, re-throw + if (closeExp != null) + { + throw closeExp; + } + } + } +}
\ No newline at end of file diff --git a/lib/Net.Transport.SimpleTCP/src/VNLib.Net.Transport.SimpleTCP.csproj b/lib/Net.Transport.SimpleTCP/src/VNLib.Net.Transport.SimpleTCP.csproj new file mode 100644 index 0000000..7a476da --- /dev/null +++ b/lib/Net.Transport.SimpleTCP/src/VNLib.Net.Transport.SimpleTCP.csproj @@ -0,0 +1,45 @@ +<Project Sdk="Microsoft.NET.Sdk"> + + <PropertyGroup> + <TargetFramework>net6.0</TargetFramework> + <RootNamespace>VNLib.Net.Transport</RootNamespace> + <Version>1.0.1.4</Version> + <Product>VNLib Simple Transport Library</Product> + <Description>Provides a library for single process asynchronous, event driven, TCP socket listening and supporting structures to implement +simple high performance TCP servers with or without TLS security.</Description> + <Authors>Vaughn Nugent</Authors> + <Copyright>Copyright © 2022 Vaughn Nugent</Copyright> + <PackageProjectUrl>https://www.vaughnnugent.com/resources</PackageProjectUrl> + <AssemblyName>VNLib.Net.Transport.SimpleTCP</AssemblyName> + <SignAssembly>True</SignAssembly> + <AssemblyOriginatorKeyFile>\\vaughnnugent.com\Internal\Folder Redirection\vman\Documents\Programming\Software\StrongNameingKey.snk</AssemblyOriginatorKeyFile> + </PropertyGroup> + + <!-- Resolve nuget dll files and store them in the output dir --> + <PropertyGroup> + <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies> + + <Nullable>enable</Nullable> + + <GenerateDocumentationFile>True</GenerateDocumentationFile> + + <AnalysisLevel>latest-all</AnalysisLevel> + </PropertyGroup> + + <ItemGroup> + <PackageReference Include="ErrorProne.NET.CoreAnalyzers" Version="0.1.2"> + <PrivateAssets>all</PrivateAssets> + <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets> + </PackageReference> + <PackageReference Include="ErrorProne.NET.Structs" Version="0.1.2"> + <PrivateAssets>all</PrivateAssets> + <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets> + </PackageReference> + <PackageReference Include="System.IO.Pipelines" Version="6.0.3" /> + </ItemGroup> + + <ItemGroup> + <ProjectReference Include="..\..\Utils\src\VNLib.Utils.csproj" /> + </ItemGroup> + +</Project> diff --git a/lib/Net.Transport.SimpleTCP/src/VnSocketAsyncArgs.cs b/lib/Net.Transport.SimpleTCP/src/VnSocketAsyncArgs.cs new file mode 100644 index 0000000..9f37762 --- /dev/null +++ b/lib/Net.Transport.SimpleTCP/src/VnSocketAsyncArgs.cs @@ -0,0 +1,181 @@ +/* +* Copyright (c) 2022 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Net.Transport.SimpleTCP +* File: VnSocketAsyncArgs.cs +* +* VnSocketAsyncArgs.cs is part of VNLib.Net.Transport.SimpleTCP which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Net.Transport.SimpleTCP is free software: you can redistribute it and/or modify +* it under the terms of the GNU Affero General Public License as +* published by the Free Software Foundation, either version 2 of the +* License, or (at your option) any later version. +* +* VNLib.Net.Transport.SimpleTCP is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU Affero General Public License for more details. +* +* You should have received a copy of the GNU Affero General Public License +* along with this program. If not, see https://www.gnu.org/licenses/. +*/ + +using System; +using System.IO; +using System.Net.Sockets; +using System.IO.Pipelines; + +using VNLib.Utils.Memory.Caching; + + +namespace VNLib.Net.Transport.Tcp +{ + internal delegate void SocketCallback(VnSocketAsyncArgs args); + + /// <summary> + /// Reusable <see cref="SocketAsyncEventArgs"/> that manages a pipeline for sending and recieving data. + /// on the connected socket + /// </summary> + internal sealed class VnSocketAsyncArgs : SocketAsyncEventArgs, IReusable + { + private readonly SocketCallback SocketAccepted; + private readonly SocketCallback SocketDisconnected; + + public readonly SocketPipeLineWorker SocketWorker; + + public Socket? Socket => AcceptSocket; + + public VnSocketAsyncArgs(SocketCallback accepted, SocketCallback disconnected, PipeOptions options) : base() + { + SocketWorker = new(options); + SocketAccepted = accepted; + //Only reuse socketes if windows + DisconnectReuseSocket = OperatingSystem.IsWindows(); + SocketDisconnected = disconnected; + } + + public Stream Stream => SocketWorker.NetworkStream; + + /// <summary> + /// Begins an asynchronous accept operation on the current (bound) socket + /// </summary> + /// <param name="sock">The server socket to accept the connection</param> + /// <returns>True if the IO operation is pending</returns> + public bool BeginAccept(Socket sock) + { + //Store the semaphore in the user token event args + SocketError = SocketError.Success; + SocketFlags = SocketFlags.None; + + //Recv during accept is not supported on linux, this flag is set to false on linux + if (DisconnectReuseSocket) + { + //get buffer from the pipe to write initial accept data to + Memory<byte> buffer = SocketWorker.GetMemory(sock.ReceiveBufferSize); + SetBuffer(buffer); + } + + //accept async + return sock.AcceptAsync(this); + } + + /// <summary> + /// Determines if an asynchronous accept operation has completed successsfully + /// and the socket is connected. + /// </summary> + /// <returns>True if the accept was successful, and the accepted socket is connected, false otherwise</returns> + public bool EndAccept() + { + if(SocketError == SocketError.Success) + { + //remove ref to buffer + SetBuffer(null); + //start the socket worker + SocketWorker.Start(Socket!, BytesTransferred); + return true; + } + return false; + } + + /// <summary> + /// Begins an async disconnect operation on a currentl connected socket + /// </summary> + /// <returns>True if the operation is pending</returns> + public void Disconnect() + { + //Clear flags + SocketError = SocketError.Success; + //accept async + if (!Socket!.DisconnectAsync(this)) + { + //Invoke disconnected callback since op completed sync + EndDisconnect(); + //Invoke disconnected callback since op completed sync + SocketDisconnected(this); + } + } + + private void EndDisconnect() + { + //If the disconnection operation failed, do not reuse the socket on next accept + if (SocketError != SocketError.Success) + { + //Dispose the socket before clearing the socket + Socket?.Dispose(); + AcceptSocket = null; + } + } + + protected override void OnCompleted(SocketAsyncEventArgs e) + { + switch (e.LastOperation) + { + case SocketAsyncOperation.Accept: + //Invoke the accepted callback + SocketAccepted(this); + break; + case SocketAsyncOperation.Disconnect: + EndDisconnect(); + //Invoke disconnected callback since op completed sync + SocketDisconnected(this); + break; + default: + throw new InvalidOperationException("Invalid socket operation"); + } + //Clear flags/errors on completion + SocketError = SocketError.Success; + SocketFlags = SocketFlags.None; + } + + void IReusable.Prepare() + { + SocketWorker.Prepare(); + } + + bool IReusable.Release() + { + UserToken = null; + SocketWorker.Release(); + //if the sockeet is connected (or not windows), dispose it and clear the accept socket + if (AcceptSocket?.Connected == true || !DisconnectReuseSocket) + { + AcceptSocket?.Dispose(); + AcceptSocket = null; + } + return true; + } + + public new void Dispose() + { + //Dispose the base class + base.Dispose(); + //Dispose the socket if its set + AcceptSocket?.Dispose(); + AcceptSocket = null; + //Dispose the overlapped stream + SocketWorker.DisposeInternal(); + } + } +} |