Skip to content

Fix k_nSteamNetworkingSend_UnreliableNoDelay docs to match actual behavior #426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ResakaGit wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix k_nSteamNetworkingSend_UnreliableNoDelay docs to match actual behavior #426

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions include/steam/steamnetworkingtypes.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -996,17 +996,20 @@ const int k_nSteamNetworkingSend_UnreliableNoNagle = k_nSteamNetworkingSend_Unre
// messages. Using this flag on reliable messages is invalid.
const int k_nSteamNetworkingSend_NoDelay = 4;

// Send an unreliable message, but if it cannot be sent relatively quickly, just drop it instead of queuing it.
// This is useful for messages that are not useful if they are excessively delayed, such as voice data.
// Send an unreliable message, and drop it rather than queuing it if the connection is not ready
// to send it yet. This is useful for messages that are not useful if they are excessively
// delayed, such as voice data.
// NOTE: The Nagle algorithm is not used, and if the message is not dropped, any messages waiting on the
// Nagle timer are immediately flushed.
//
// A message will be dropped under the following circumstances:
// - the connection is not fully connected. (E.g. the "Connecting" or "FindingRoute" states)
// - there is a sufficiently large number of messages queued up already such that the current message
// will not be placed on the wire in the next ~200ms or so.
// Currently, a message will only be dropped if the connection is not fully connected. (E.g. the
// "Connecting" or "FindingRoute" states.) If a message is dropped for this reason, k_EResultIgnored
// will be returned.
//
// If a message is dropped for these reasons, k_EResultIgnored will be returned.
// Ideally, a message would also be dropped if so much data is already queued up that the current
// message will not be placed on the wire for a relatively long time (say, ~200ms or so), but this
// check is not currently implemented. Messages are queued as usual, subject to the ordinary send
// buffer limit. (See k_ESteamNetworkingConfig_SendBufferSize.)
const int k_nSteamNetworkingSend_UnreliableNoDelay = k_nSteamNetworkingSend_Unreliable|k_nSteamNetworkingSend_NoDelay|k_nSteamNetworkingSend_NoNagle;

// Reliable message send. Can send up to k_cbMaxSteamNetworkingSocketsMessageSizeSend bytes in a single message.
Expand Down