GitHub/GameNetworkingSockets
1
0
Fork 0
mirror of https://github.com/ValveSoftware/GameNetworkingSockets.git synced 2026-05-29 16:20:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Placeholder README and updated license.

Browse Source
This commit is contained in:
Fletcher Dunn
2018-03-22 20:24:48 -07:00
parent 8e9ec6f4a0
commit ad0037a60b
2 changed files with 42 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files
LICENSE
+21 -23
View File
@@ -1,29 +1,27 @@
BSD 3-Clause License Copyright (c) 2018, Valve Corporation
Copyright (c) 2018, Valve Software
All rights reserved. All rights reserved.
Redistribution and use in source and binary forms, with or without Redistribution and use in source and binary forms, with or without modification,
modification, are permitted provided that the following conditions are met: are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this 1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer. list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, 2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation this list of conditions and the following disclaimer in the documentation and/or
and/or other materials provided with the distribution. other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its 3. Neither the name of the copyright holder nor the names of its contributors
contributors may be used to endorse or promote products derived from may be used to endorse or promote products derived from this software without
this software without specific prior written permission. specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
README.md
+21 -2
View File
@@ -1,2 +1,21 @@
# GameNetworkingSockets GameNetworkingSockets
Reliable & unreliable messages over UDP. Message fragmentation & reassembly, bandwidth estimation, encryption. ---
GameNetworkingSockets is a basic transport layer for games. The features are:
* Connection-oriented protocol (like TCP)
* ... but message-oriented instead of stream-oriented.
* Mix of reliable and unreliable messages
* Messages can be larger than underlying MTU, the protocol performs fragmentation and reassembly, and retransmission for reliable
* Bandwidth estimation based on TFP-friendly rate control (RFC 5348)
* Encryption.
* Tools for simulating loss and detailed stats measurement
The main interface class is named SteamNetworkingSockets, and many files have "steam" in their name.
But *Steam is not needed*. The reason for the name is that this provides a subset of the functionality of the API with the same name in the SteamworksSDK. The intention is that on PC you can use the Steamworks version, and on other platforms, you can use this version. In this way, you can avoid having the Steam version be "weird" or not take full advantage of the features above that it provides.
But even if you don't make games or aren't on Steam, feel free to use this code for whatever purpose you want.
### Coming soon
Sorry, we're still in the process of taking the code from the SteamNetworkingSockets library and making it ready to be open-sourced. Watch this space.