src/vg/vg_steam_networking.h

   1 #ifndef VG_STEAM_NETWORKING_H
   2 #define VG_STEAM_NETWORKING_H
   3
   4 #include "vg_steam.h"
   5
   6 #ifdef VALVE_CALLBACK_PACK_SMALL
   7  #pragma pack(push,4)
   8 #else
   9  #pragma pack(push,8)
  10 #endif
  11
  12 typedef enum ESteamNetworkingConfigScope ESteamNetworkingConfigScope;
  13 enum ESteamNetworkingConfigScope
  14 {
  15         k_ESteamNetworkingConfig_Global = 1,
  16         k_ESteamNetworkingConfig_SocketsInterface = 2,
  17         k_ESteamNetworkingConfig_ListenSocket = 3,
  18         k_ESteamNetworkingConfig_Connection = 4,
  19         k_ESteamNetworkingConfigScope__Force32Bit = 0x7fffffff
  20 };
  21
  22 typedef enum ESteamNetworkingConfigDataType ESteamNetworkingConfigDataType;
  23 enum ESteamNetworkingConfigDataType
  24 {
  25         k_ESteamNetworkingConfig_Int32 = 1,
  26         k_ESteamNetworkingConfig_Int64 = 2,
  27         k_ESteamNetworkingConfig_Float = 3,
  28         k_ESteamNetworkingConfig_String = 4,
  29         k_ESteamNetworkingConfig_Ptr = 5,
  30
  31         k_ESteamNetworkingConfigDataType__Force32Bit = 0x7fffffff
  32 };
  33
  34 typedef enum ESteamNetworkingConfigValue ESteamNetworkingConfigValue;
  35 enum ESteamNetworkingConfigValue
  36 {
  37         k_ESteamNetworkingConfig_Invalid = 0,
  38         k_ESteamNetworkingConfig_TimeoutInitial = 24,
  39         k_ESteamNetworkingConfig_TimeoutConnected = 25,
  40         k_ESteamNetworkingConfig_SendBufferSize = 9,
  41         k_ESteamNetworkingConfig_ConnectionUserData = 40,
  42         k_ESteamNetworkingConfig_SendRateMin = 10,
  43         k_ESteamNetworkingConfig_SendRateMax = 11,
  44         k_ESteamNetworkingConfig_NagleTime = 12,
  45         k_ESteamNetworkingConfig_IP_AllowWithoutAuth = 23,
  46         k_ESteamNetworkingConfig_MTU_PacketSize = 32,
  47         k_ESteamNetworkingConfig_MTU_DataSize = 33,
  48         k_ESteamNetworkingConfig_Unencrypted = 34,
  49         k_ESteamNetworkingConfig_SymmetricConnect = 37,
  50         k_ESteamNetworkingConfig_LocalVirtualPort = 38,
  51         k_ESteamNetworkingConfig_DualWifi_Enable = 39,
  52         k_ESteamNetworkingConfig_EnableDiagnosticsUI = 46,
  53         k_ESteamNetworkingConfig_FakePacketLoss_Send = 2,
  54         k_ESteamNetworkingConfig_FakePacketLoss_Recv = 3,
  55         k_ESteamNetworkingConfig_FakePacketLag_Send = 4,
  56         k_ESteamNetworkingConfig_FakePacketLag_Recv = 5,
  57         k_ESteamNetworkingConfig_FakePacketReorder_Send = 6,
  58         k_ESteamNetworkingConfig_FakePacketReorder_Recv = 7,
  59         k_ESteamNetworkingConfig_FakePacketReorder_Time = 8,
  60         k_ESteamNetworkingConfig_FakePacketDup_Send = 26,
  61         k_ESteamNetworkingConfig_FakePacketDup_Recv = 27,
  62         k_ESteamNetworkingConfig_FakePacketDup_TimeMax = 28,
  63         k_ESteamNetworkingConfig_PacketTraceMaxBytes = 41,
  64         k_ESteamNetworkingConfig_FakeRateLimit_Send_Rate = 42,
  65         k_ESteamNetworkingConfig_FakeRateLimit_Send_Burst = 43,
  66         k_ESteamNetworkingConfig_FakeRateLimit_Recv_Rate = 44,
  67         k_ESteamNetworkingConfig_FakeRateLimit_Recv_Burst = 45,
  68         k_ESteamNetworkingConfig_Callback_ConnectionStatusChanged = 201,
  69         k_ESteamNetworkingConfig_Callback_AuthStatusChanged = 202,
  70         k_ESteamNetworkingConfig_Callback_RelayNetworkStatusChanged = 203,
  71         k_ESteamNetworkingConfig_Callback_MessagesSessionRequest = 204,
  72         k_ESteamNetworkingConfig_Callback_MessagesSessionFailed = 205,
  73         k_ESteamNetworkingConfig_Callback_CreateConnectionSignaling = 206,
  74         k_ESteamNetworkingConfig_Callback_FakeIPResult = 207,
  75         k_ESteamNetworkingConfig_P2P_STUN_ServerList = 103,
  76         k_ESteamNetworkingConfig_P2P_Transport_ICE_Enable = 104,
  77         k_ESteamNetworkingConfig_P2P_Transport_ICE_Penalty = 105,
  78         k_ESteamNetworkingConfig_P2P_Transport_SDR_Penalty = 106,
  79         k_ESteamNetworkingConfig_SDRClient_ConsecutitivePingTimeoutsFailInitial = 19,
  80         k_ESteamNetworkingConfig_SDRClient_ConsecutitivePingTimeoutsFail = 20,
  81         k_ESteamNetworkingConfig_SDRClient_MinPingsBeforePingAccurate = 21,
  82         k_ESteamNetworkingConfig_SDRClient_SingleSocket = 22,
  83         k_ESteamNetworkingConfig_SDRClient_ForceRelayCluster = 29,
  84         k_ESteamNetworkingConfig_SDRClient_DebugTicketAddress = 30,
  85         k_ESteamNetworkingConfig_SDRClient_ForceProxyAddr = 31,
  86         k_ESteamNetworkingConfig_SDRClient_FakeClusterPing = 36,
  87         k_ESteamNetworkingConfig_LogLevel_AckRTT = 13,
  88         k_ESteamNetworkingConfig_LogLevel_PacketDecode = 14,
  89         k_ESteamNetworkingConfig_LogLevel_Message = 15,
  90         k_ESteamNetworkingConfig_LogLevel_PacketGaps = 16,
  91         k_ESteamNetworkingConfig_LogLevel_P2PRendezvous = 17,
  92         k_ESteamNetworkingConfig_LogLevel_SDRRelayPings = 18,
  93         k_ESteamNetworkingConfig_DELETED_EnumerateDevVars = 35,
  94         k_ESteamNetworkingConfigValue__Force32Bit = 0x7fffffff
  95 };
  96
  97
  98 typedef enum ESteamNetworkingConnectionState ESteamNetworkingConnectionState;
  99 enum ESteamNetworkingConnectionState
 100 {
 101         k_ESteamNetworkingConnectionState_None = 0,
 102         k_ESteamNetworkingConnectionState_Connecting = 1,
 103         k_ESteamNetworkingConnectionState_FindingRoute = 2,
 104         k_ESteamNetworkingConnectionState_Connected = 3,
 105         k_ESteamNetworkingConnectionState_ClosedByPeer = 4,
 106         k_ESteamNetworkingConnectionState_ProblemDetectedLocally = 5,
 107         k_ESteamNetworkingConnectionState_FinWait = -1,
 108         k_ESteamNetworkingConnectionState_Linger = -2,
 109         k_ESteamNetworkingConnectionState_Dead = -3,
 110         k_ESteamNetworkingConnectionState__Force32Bit = 0x7fffffff
 111 };
 112
 113 typedef enum ESteamNetConnectionEnd ESteamNetConnectionEnd;
 114 enum ESteamNetConnectionEnd
 115 {
 116         k_ESteamNetConnectionEnd_Invalid = 0,
 117         k_ESteamNetConnectionEnd_App_Min = 1000,
 118    k_ESteamNetConnectionEnd_App_Generic = k_ESteamNetConnectionEnd_App_Min,
 119         k_ESteamNetConnectionEnd_App_Max = 1999,
 120         k_ESteamNetConnectionEnd_AppException_Min = 2000,
 121    k_ESteamNetConnectionEnd_AppException_Generic =
 122       k_ESteamNetConnectionEnd_AppException_Min,
 123         k_ESteamNetConnectionEnd_AppException_Max = 2999,
 124         k_ESteamNetConnectionEnd_Local_Min = 3000,
 125                 k_ESteamNetConnectionEnd_Local_OfflineMode = 3001,
 126                 k_ESteamNetConnectionEnd_Local_ManyRelayConnectivity = 3002,
 127                 k_ESteamNetConnectionEnd_Local_HostedServerPrimaryRelay = 3003,
 128                 k_ESteamNetConnectionEnd_Local_NetworkConfig = 3004,
 129                 k_ESteamNetConnectionEnd_Local_Rights = 3005,
 130                 k_ESteamNetConnectionEnd_Local_P2P_ICE_NoPublicAddresses = 3006,
 131
 132         k_ESteamNetConnectionEnd_Local_Max = 3999,
 133         k_ESteamNetConnectionEnd_Remote_Min = 4000,
 134                 k_ESteamNetConnectionEnd_Remote_Timeout = 4001,
 135                 k_ESteamNetConnectionEnd_Remote_BadCrypt = 4002,
 136                 k_ESteamNetConnectionEnd_Remote_BadCert = 4003,
 137                 k_ESteamNetConnectionEnd_Remote_BadProtocolVersion = 4006,
 138                 k_ESteamNetConnectionEnd_Remote_P2P_ICE_NoPublicAddresses = 4007,
 139
 140         k_ESteamNetConnectionEnd_Remote_Max = 4999,
 141
 142         k_ESteamNetConnectionEnd_Misc_Min = 5000,
 143                 k_ESteamNetConnectionEnd_Misc_Generic = 5001,
 144                 k_ESteamNetConnectionEnd_Misc_InternalError = 5002,
 145                 k_ESteamNetConnectionEnd_Misc_Timeout = 5003,
 146                 k_ESteamNetConnectionEnd_Misc_SteamConnectivity = 5005,
 147                 k_ESteamNetConnectionEnd_Misc_NoRelaySessionsToClient = 5006,
 148                 k_ESteamNetConnectionEnd_Misc_P2P_Rendezvous = 5008,
 149                 k_ESteamNetConnectionEnd_Misc_P2P_NAT_Firewall = 5009,
 150                 k_ESteamNetConnectionEnd_Misc_PeerSentNoConnection = 5010,
 151
 152         k_ESteamNetConnectionEnd_Misc_Max = 5999,
 153         k_ESteamNetConnectionEnd__Force32Bit = 0x7fffffff
 154 };
 155
 156 typedef enum ESteamNetworkingIdentityType ESteamNetworkingIdentityType;
 157 enum ESteamNetworkingIdentityType
 158 {
 159         k_ESteamNetworkingIdentityType_Invalid = 0,
 160         k_ESteamNetworkingIdentityType_SteamID = 16,
 161         k_ESteamNetworkingIdentityType_IPAddress = 1,
 162         k_ESteamNetworkingIdentityType_GenericString = 2,
 163         k_ESteamNetworkingIdentityType_GenericBytes = 3,
 164         k_ESteamNetworkingIdentityType_UnknownType = 4,
 165         k_ESteamNetworkingIdentityType__Force32bit = 0x7fffffff,
 166 };
 167
 168 typedef enum ESteamNetworkingAvailability ESteamNetworkingAvailability;
 169 enum ESteamNetworkingAvailability
 170 {
 171         k_ESteamNetworkingAvailability_CannotTry = -102,
 172         k_ESteamNetworkingAvailability_Failed = -101,
 173         k_ESteamNetworkingAvailability_Previously = -100,
 174         k_ESteamNetworkingAvailability_Retrying = -10,
 175         k_ESteamNetworkingAvailability_NeverTried = 1,
 176         k_ESteamNetworkingAvailability_Waiting = 2,
 177         k_ESteamNetworkingAvailability_Attempting = 3,
 178         k_ESteamNetworkingAvailability_Current = 100,
 179         k_ESteamNetworkingAvailability_Unknown = 0,
 180         k_ESteamNetworkingAvailability__Force32bit = 0x7fffffff,
 181 };
 182
 183 /* Handle used to identify a connection to a remote host. */
 184 typedef u32 HSteamNetConnection;
 185 HSteamNetConnection const k_HSteamNetConnection_Invalid = 0;
 186
 187 /*
 188  * Handle used to identify a "listen socket".  Unlike traditional
 189  * Berkeley sockets, a listen socket and a connection are two
 190  * different abstractions.
 191  */
 192 typedef u32 HSteamListenSocket;
 193 HSteamListenSocket const k_HSteamListenSocket_Invalid = 0;
 194
 195 typedef u32 SteamNetworkingPOPID;
 196 typedef i64 SteamNetworkingMicroseconds;
 197
 198 #pragma pack(push,1)
 199 /* Store an IP and port. IPv6 is always used; IPv4 is represented using
 200  * "IPv4-mapped" addresses: IPv4 aa.bb.cc.dd => IPv6 ::ffff:aabb:ccdd
 201  * (RFC 4291 section 2.5.5.2.)
 202  */
 203 typedef struct SteamNetworkingIPAddr SteamNetworkingIPAddr;
 204 struct SteamNetworkingIPAddr
 205 {
 206         union
 207         {
 208                 u8 m_ipv6[ 16 ];
 209
 210       /* RFC4038, section 4.2 */
 211       struct IPv4MappedAddress
 212       {
 213          u64 m_8zeros;
 214          u16 m_0000;
 215          u16 m_ffff;
 216          u8  m_ip[ 4 ]; /* NOTE: As bytes, i.e. network byte order */
 217       }
 218       m_ipv4;
 219         };
 220
 221         u16 m_port; // Host byte order
 222 };
 223
 224 typedef struct SteamNetworkingIdentity SteamNetworkingIdentity;
 225 struct SteamNetworkingIdentity
 226 {
 227         ESteamNetworkingIdentityType m_eType;
 228
 229         int m_cbSize;
 230         union
 231    {
 232                 u64 m_steamID64;
 233                 char m_szGenericString[ 32 ];
 234                 u8 m_genericBytes[ 32 ];
 235                 char m_szUnknownRawString[ 128 ];
 236                 SteamNetworkingIPAddr m_ip;
 237                 u32 m_reserved[ 32 ];
 238         };
 239 };
 240
 241 #pragma pack(pop)
 242
 243 /*
 244  * "Fake IPs" are assigned to hosts, to make it easier to interface with
 245  * older code that assumed all hosts will have an IPv4 address
 246  */
 247 typedef enum ESteamNetworkingFakeIPType ESteamNetworkingFakeIPType;
 248 enum ESteamNetworkingFakeIPType
 249 {
 250         k_ESteamNetworkingFakeIPType_Invalid,
 251         k_ESteamNetworkingFakeIPType_NotFake,
 252         k_ESteamNetworkingFakeIPType_GlobalIPv4,
 253         k_ESteamNetworkingFakeIPType_LocalIPv4,
 254         k_ESteamNetworkingFakeIPType__Force32Bit = 0x7fffffff
 255 };
 256
 257 /* Set everything to zero. E.g. [::]:0 */
 258 void SteamAPI_SteamNetworkingIPAddr_Clear( SteamNetworkingIPAddr* self );
 259
 260 /* Returns true if the IP is ::0. (Doesn't check port.) */
 261 int  SteamAPI_SteamNetworkingIPAddr_IsIPv6AllZeros(
 262       SteamNetworkingIPAddr* self );
 263
 264 /*
 265  * Set IPv6 address.  IP is interpreted as bytes, so there are no endian issues.
 266  * (Same as inaddr_in6.)  The IP can be a mapped IPv4 address
 267  */
 268 void SteamAPI_SteamNetworkingIPAddr_SetIPv6( SteamNetworkingIPAddr* self,
 269       u8 *ipv6, u16 nPort );
 270
 271 /* Sets to IPv4 mapped address.  IP and port are in host byte order. */
 272 void SteamAPI_SteamNetworkingIPAddr_SetIPv4( SteamNetworkingIPAddr* self,
 273       u32 nIP, u16 nPort );
 274
 275 /* Return true if IP is mapped IPv4 */
 276 int SteamAPI_SteamNetworkingIPAddr_IsIPv4( SteamNetworkingIPAddr* self );
 277
 278 /*
 279  * Returns IP in host byte order (e.g. aa.bb.cc.dd as 0xaabbccdd).
 280  * Returns 0 if IP is not mapped IPv4.
 281  */
 282 u32 SteamAPI_SteamNetworkingIPAddr_GetIPv4( SteamNetworkingIPAddr* self );
 283
 284 /* Set to the IPv6 localhost address ::1, and the specified port. */
 285 void SteamAPI_SteamNetworkingIPAddr_SetIPv6LocalHost(
 286                                     SteamNetworkingIPAddr* self, u16 nPort );
 287
 288 /*
 289  * Return true if this identity is localhost.
 290  * (Either IPv6 ::1, or IPv4 127.0.0.1)
 291  */
 292 int SteamAPI_SteamNetworkingIPAddr_IsLocalHost( SteamNetworkingIPAddr* self );
 293
 294 /*
 295  * Print to a string, with or without the port. Mapped IPv4 addresses are
 296  * printed as dotted decimal (12.34.56.78), otherwise this will print the
 297  * canonical form according to RFC5952. If you include the port, IPv6 will be
 298  * surrounded by brackets, e.g. [::1:2]:80. Your buffer should be at least
 299  * k_cchMaxString bytes to avoid truncation
 300  *
 301  * See also SteamNetworkingIdentityRender
 302  */
 303 void SteamAPI_SteamNetworkingIPAddr_ToString( SteamNetworkingIPAddr* self,
 304       char *buf, u32 cbBuf, int bWithPort );
 305
 306 /*
 307  * Parse an IP address and optional port. If a port is not present, it is set
 308  * to 0.
 309  * (This means that you cannot tell if a zero port was explicitly specified.)
 310  */
 311 int SteamAPI_SteamNetworkingIPAddr_ParseString( SteamNetworkingIPAddr* self,
 312       const char *pszStr );
 313
 314 /* See if two addresses are identical */
 315 int SteamAPI_SteamNetworkingIPAddr_IsEqualTo( SteamNetworkingIPAddr* self,
 316       SteamNetworkingIPAddr *x );
 317
 318 /*
 319  * Classify address as FakeIP.  This function never returns
 320  * k_ESteamNetworkingFakeIPType_Invalid.
 321  */
 322 ESteamNetworkingFakeIPType SteamAPI_SteamNetworkingIPAddr_GetFakeIPType(
 323       SteamNetworkingIPAddr* self );
 324
 325 /* Return true if we are a FakeIP */
 326 int SteamAPI_SteamNetworkingIPAddr_IsFakeIP( SteamNetworkingIPAddr* self );
 327
 328 /*
 329  * In a few places we need to set configuration options on listen sockets and
 330  * connections, and have them take effect *before* the listen socket or
 331  * connection really starts doing anything. Creating the object and then setting
 332  * the options "immediately" after creation doesn't work completely, because
 333  * network packets could be received between the time the object is created and
 334  * when the options are applied. To set options at creation time in a reliable
 335  * way, they must be passed to the creation function. This structure is used to
 336  * pass those options.
 337  *
 338  * For the meaning of these fields, see ISteamNetworkingUtils::SetConfigValue.
 339  * Basically when the object is created, we just iterate over the list of
 340  * options and call ISteamNetworkingUtils::SetConfigValueStruct, where the scope
 341  * arguments are supplied by the object being created.
 342  */
 343 typedef struct SteamNetworkingConfigValue_t SteamNetworkingConfigValue_t;
 344 struct SteamNetworkingConfigValue_t
 345 {
 346         /* Which option is being set */
 347         ESteamNetworkingConfigValue m_eValue;
 348
 349         /// Which field below did you fill in?
 350         ESteamNetworkingConfigDataType m_eDataType;
 351
 352         /// Option value
 353         union
 354         {
 355                 i32 m_int32;
 356                 i64 m_int64;
 357                 float m_float;
 358                 const char *m_string; // Points to your '\0'-terminated buffer
 359                 void *m_ptr;
 360         } m_val;
 361 };
 362
 363 void SteamAPI_SteamNetworkingConfigValue_t_SetInt32(
 364       SteamNetworkingConfigValue_t* self,
 365       ESteamNetworkingConfigValue eVal, i32 data );
 366
 367 void SteamAPI_SteamNetworkingConfigValue_t_SetInt64(
 368       SteamNetworkingConfigValue_t* self,
 369       ESteamNetworkingConfigValue eVal, i64 data );
 370
 371 void SteamAPI_SteamNetworkingConfigValue_t_SetFloat(
 372       SteamNetworkingConfigValue_t* self,
 373       ESteamNetworkingConfigValue eVal, float data );
 374
 375 void SteamAPI_SteamNetworkingConfigValue_t_SetPtr(
 376       SteamNetworkingConfigValue_t* self,
 377       ESteamNetworkingConfigValue eVal, void *data );
 378
 379 void SteamAPI_SteamNetworkingConfigValue_t_SetString(
 380       SteamNetworkingConfigValue_t* self, ESteamNetworkingConfigValue eVal,
 381       const char * data );
 382
 383 typedef void ISteamNetworkingSockets;
 384 typedef struct SteamNetworkingMessage_t SteamNetworkingMessage_t;
 385 typedef struct SteamNetConnectionInfo_t SteamNetConnectionInfo_t;
 386
 387
 388 /*
 389  * Handle used to identify a poll group, used to query many
 390  * connections at once efficiently.
 391  */
 392 typedef u32 HSteamNetPollGroup;
 393 HSteamNetPollGroup const k_HSteamNetPollGroup_Invalid = 0;
 394
 395 ISteamNetworkingSockets
 396 *SteamAPI_SteamGameServerNetworkingSockets_SteamAPI_v012(void);
 397
 398 ISteamNetworkingSockets
 399 *SteamAPI_SteamGameServerNetworkingSockets_SteamAPI(void)
 400 {
 401    return SteamAPI_SteamGameServerNetworkingSockets_SteamAPI_v012();
 402 }
 403
 404
 405 ISteamNetworkingSockets *SteamAPI_SteamNetworkingSockets_SteamAPI_v012();
 406 ISteamNetworkingSockets *SteamAPI_SteamNetworkingSockets_SteamAPI()
 407 {
 408    return SteamAPI_SteamNetworkingSockets_SteamAPI_v012();
 409 }
 410
 411
 412 /*
 413  * Send the message unreliably. Can be lost.  Messages *can* be larger than a
 414  * single MTU (UDP packet), but there is no retransmission, so if any piece
 415  * of the message is lost, the entire message will be dropped.
 416
 417  * The sending API does have some knowledge of the underlying connection, so
 418  * if there is no NAT-traversal accomplished or there is a recognized adjustment
 419  * happening on the connection, the packet will be batched until the connection
 420  * is open again.
 421
 422  * Migration note: This is not exactly the same as k_EP2PSendUnreliable!  You
 423  * probably want k_ESteamNetworkingSendType_UnreliableNoNagle
 424  */
 425 const int k_nSteamNetworkingSend_Unreliable = 0;
 426
 427 /*
 428  * Disable Nagle's algorithm.
 429  * By default, Nagle's algorithm is applied to all outbound messages. This means
 430  * that the message will NOT be sent immediately, in case further messages are
 431  * sent soon after you send this, which can be grouped together.  Any time there
 432  * is enough buffered data to fill a packet, the packets will be pushed out
 433  * immediately, but partially-full packets not be sent until the Nagle timer
 434  * expires. See ISteamNetworkingSockets::FlushMessagesOnConnection,
 435  * ISteamNetworkingMessages::FlushMessagesToUser
 436  *
 437  * NOTE: Don't just send every message without Nagle because you want packets to
 438  * get there quicker.  Make sure you understand the problem that Nagle is
 439  * solving before disabling it. If you are sending small messages, often many at
 440  * the same time, then it is very likely that it will be more efficient to leave
 441  * Nagle enabled.  A typical proper use of this flag is when you are sending
 442  * what you know will be the last message sent for a while (e.g. the last in the
 443  * server simulation tick to a particular client), and you use this flag to
 444  * flush all messages.
 445  */
 446 const int k_nSteamNetworkingSend_NoNagle = 1;
 447
 448 /*
 449  * Send a message unreliably, bypassing Nagle's algorithm for this message and
 450  * any messages currently pending on the Nagle timer. This is equivalent to
 451  * using k_ESteamNetworkingSend_Unreliable and then immediately flushing the
 452  * messages using ISteamNetworkingSockets::FlushMessagesOnConnection or
 453  * ISteamNetworkingMessages::FlushMessagesToUser. (But using this flag is more
 454  * efficient since you only make one API call.)
 455  */
 456 const int k_nSteamNetworkingSend_UnreliableNoNagle =
 457             k_nSteamNetworkingSend_Unreliable |
 458             k_nSteamNetworkingSend_NoNagle;
 459 /*
 460  * If the message cannot be sent very soon (because the connection is still
 461  * doing some initial handshaking, route negotiations, etc), then just drop it.
 462  * This is only applicable for unreliable messages. Using this flag on reliable
 463  * messages is invalid.
 464  */
 465 const int k_nSteamNetworkingSend_NoDelay = 4;
 466
 467 /*
 468  * Send an unreliable message, but if it cannot be sent relatively quickly, just
 469  * drop it instead of queuing it. This is useful for messages that are not
 470  * useful if they are excessively delayed, such as voice data.
 471  * NOTE: The Nagle algorithm is not used, and if the message is not dropped, any
 472  * messages waiting on the Nagle timer are immediately flushed.
 473  *
 474  * A message will be dropped under the following circumstances:
 475  * - the connection is not fully connected.  (E.g. the "Connecting" or
 476  *                                                     "FindingRoute" states)
 477  * - there is a sufficiently large number of messages queued up already such
 478  *   that the current message will not be placed on the wire in the next
 479  *   ~200ms or so.
 480  *
 481  * If a message is dropped for these reasons, k_EResultIgnored will be returned.
 482  */
 483 const int k_nSteamNetworkingSend_UnreliableNoDelay =
 484             k_nSteamNetworkingSend_Unreliable |
 485             k_nSteamNetworkingSend_NoDelay |
 486             k_nSteamNetworkingSend_NoNagle;
 487
 488 /*
 489  * Reliable message send. Can send up to
 490  * k_cbMaxSteamNetworkingSocketsMessageSizeSend bytes in a single message.
 491  * Does fragmentation/re-assembly of messages under the hood, as well as a
 492  * sliding window for efficient sends of large chunks of data.
 493  * The Nagle algorithm is used. See notes on
 494  * k_ESteamNetworkingSendType_Unreliable for more details.
 495  * See k_ESteamNetworkingSendType_ReliableNoNagle,
 496  *     ISteamNetworkingSockets::FlushMessagesOnConnection,
 497  *     ISteamNetworkingMessages::FlushMessagesToUser
 498  *
 499  * Migration note: This is NOT the same as k_EP2PSendReliable, it's more like
 500  * k_EP2PSendReliableWithBuffering
 501  */
 502 const int k_nSteamNetworkingSend_Reliable = 8;
 503
 504 /*
 505  * Send a message reliably, but bypass Nagle's algorithm.
 506  *
 507  * Migration note: This is equivalent to k_EP2PSendReliable
 508  */
 509 const int k_nSteamNetworkingSend_ReliableNoNagle =
 510             k_nSteamNetworkingSend_Reliable |
 511             k_nSteamNetworkingSend_NoNagle;
 512
 513
 514 HSteamListenSocket SteamAPI_ISteamNetworkingSockets_CreateListenSocketIP(
 515       ISteamNetworkingSockets *self,
 516       SteamNetworkingIPAddr *localAddress, int nOptions,
 517       SteamNetworkingConfigValue_t *pOptions );
 518
 519 HSteamNetConnection SteamAPI_ISteamNetworkingSockets_ConnectByIPAddress(
 520       ISteamNetworkingSockets *self,
 521       SteamNetworkingIPAddr *address, int nOptions,
 522       SteamNetworkingConfigValue_t *pOptions );
 523
 524
 525 EResult SteamAPI_ISteamNetworkingSockets_AcceptConnection(
 526       ISteamNetworkingSockets *self,
 527       HSteamNetConnection hConn );
 528
 529 int SteamAPI_ISteamNetworkingSockets_CloseConnection(
 530       ISteamNetworkingSockets *self,
 531       HSteamNetConnection hPeer, int nReason, const char *pszDebug,
 532       int bEnableLinger );
 533
 534 int SteamAPI_ISteamNetworkingSockets_GetListenSocketAddress(
 535       ISteamNetworkingSockets *self, HSteamListenSocket hSocket,
 536       SteamNetworkingIPAddr *address );
 537
 538 int SteamAPI_ISteamNetworkingSockets_CloseConnection(
 539       ISteamNetworkingSockets *self,
 540       HSteamNetConnection hPeer, int nReason, const char *pszDebug,
 541       int bEnableLinger );
 542
 543 int SteamAPI_ISteamNetworkingSockets_CloseListenSocket(
 544       ISteamNetworkingSockets *self, HSteamListenSocket hSocket );
 545
 546 EResult SteamAPI_ISteamNetworkingSockets_SendMessageToConnection(
 547       ISteamNetworkingSockets* self,
 548       HSteamNetConnection hConn, const void *pData, u32 cbData, int nSendFlags,
 549       i64 * pOutMessageNumber );
 550
 551 void SteamAPI_ISteamNetworkingSockets_SendMessages(
 552       ISteamNetworkingSockets* self,
 553       int nMessages, SteamNetworkingMessage_t *const *pMessages,
 554       i64 *pOutMessageNumberOrResult );
 555
 556 EResult SteamAPI_ISteamNetworkingSockets_FlushMessagesOnConnection(
 557       ISteamNetworkingSockets* self,
 558       HSteamNetConnection hConn );
 559
 560 int SteamAPI_ISteamNetworkingSockets_ReceiveMessagesOnConnection(
 561       ISteamNetworkingSockets* self,
 562       HSteamNetConnection hConn,
 563       SteamNetworkingMessage_t **ppOutMessages,
 564       int nMaxMessages );
 565
 566 /*
 567  * Poll Groups
 568  */
 569
 570 HSteamNetPollGroup SteamAPI_ISteamNetworkingSockets_CreatePollGroup(
 571       ISteamNetworkingSockets *self );
 572
 573 int SteamAPI_ISteamNetworkingSockets_DestroyPollGroup(
 574       ISteamNetworkingSockets *self,
 575       HSteamNetPollGroup hPollGroup );
 576
 577 int SteamAPI_ISteamNetworkingSockets_SetConnectionPollGroup(
 578       ISteamNetworkingSockets *self,
 579       HSteamNetConnection hConn, HSteamNetPollGroup hPollGroup );
 580
 581 int SteamAPI_ISteamNetworkingSockets_ReceiveMessagesOnPollGroup(
 582       ISteamNetworkingSockets *self,
 583       HSteamNetPollGroup hPollGroup, SteamNetworkingMessage_t **ppOutMessages,
 584       int nMaxMessages );
 585 /*
 586  * Returns basic information about the high-level state of the connection.
 587  * Returns false if the connection handle is invalid.
 588  */
 589 int SteamAPI_ISteamNetworkingSockets_GetConnectionInfo(
 590       ISteamNetworkingSockets* self,
 591       HSteamNetConnection hConn, SteamNetConnectionInfo_t * pInfo );
 592
 593 int SteamAPI_ISteamNetworkingSockets_GetDetailedConnectionStatus(
 594       ISteamNetworkingSockets* self,
 595       HSteamNetConnection hConn, char *pszBuf, int cbBuf );
 596
 597 int SteamAPI_ISteamNetworkingSockets_GetListenSocketAddress(
 598       ISteamNetworkingSockets* self,
 599       HSteamListenSocket hSocket, SteamNetworkingIPAddr *address );
 600
 601 enum{ k_cchSteamNetworkingMaxConnectionCloseReason = 128 };
 602 enum{ k_cchSteamNetworkingMaxConnectionDescription = 128 };
 603 enum{ k_cchSteamNetworkingMaxConnectionAppName = 32 };
 604 enum{ k_nSteamNetworkConnectionInfoFlags_Unauthenticated = 1 };
 605 enum{ k_nSteamNetworkConnectionInfoFlags_Unencrypted = 2 };
 606 enum{ k_nSteamNetworkConnectionInfoFlags_LoopbackBuffers = 4 };
 607 enum{ k_nSteamNetworkConnectionInfoFlags_Fast = 8 };
 608 enum{ k_nSteamNetworkConnectionInfoFlags_Relayed = 16 };
 609 enum{ k_nSteamNetworkConnectionInfoFlags_DualWifi = 32 };
 610
 611 /* Describe the state of a connection. */
 612 typedef struct SteamNetConnectionInfo_t SteamNetConnectionInfo_t;
 613 struct SteamNetConnectionInfo_t
 614 {
 615         /*
 616     * Who is on the other end? Depending on the connection type and phase of the
 617     * connection, we might not know
 618     */
 619         SteamNetworkingIdentity m_identityRemote;
 620
 621         /* Arbitrary user data set by the local application code */
 622         i64 m_nUserData;
 623
 624         /*
 625     * Handle to listen socket this was connected on, or
 626     * k_HSteamListenSocket_Invalid if we initiated the connection
 627     */
 628         HSteamListenSocket m_hListenSocket;
 629
 630         /*
 631     * Remote address.  Might be all 0's if we don't know it, or if this is N/A.
 632          * (E.g. Basically everything except direct UDP connection.)
 633     */
 634         SteamNetworkingIPAddr m_addrRemote;
 635         u16 m__pad1;
 636
 637         /* What data center is the remote host in?  (0 if we don't know.) */
 638         SteamNetworkingPOPID m_idPOPRemote;
 639
 640         /*
 641     * What relay are we using to communicate with the remote host?
 642     * (0 if not applicable.)
 643     */
 644         SteamNetworkingPOPID m_idPOPRelay;
 645
 646         /* High level state of the connection */
 647         ESteamNetworkingConnectionState m_eState;
 648
 649         /*
 650     * Basic cause of the connection termination or problem.
 651          * See ESteamNetConnectionEnd for the values used
 652     */
 653         int m_eEndReason;
 654
 655         /*
 656     * Human-readable, but non-localized explanation for connection
 657          * termination or problem.  This is intended for debugging /
 658          * diagnostic purposes only, not to display to users.  It might
 659          * have some details specific to the issue.
 660     */
 661         char m_szEndDebug[ k_cchSteamNetworkingMaxConnectionCloseReason ];
 662
 663         /*
 664     * Debug description.  This includes the internal connection ID,
 665          * connection type (and peer information), and any name
 666          * given to the connection by the app.  This string is used in various
 667          * internal logging messages.
 668          *
 669          * Note that the connection ID *usually* matches the HSteamNetConnection
 670          * handle, but in certain cases with symmetric connections it might not.
 671     */
 672         char m_szConnectionDescription
 673       [ k_cchSteamNetworkingMaxConnectionDescription ];
 674
 675         /* Misc flags.  Bitmask of k_nSteamNetworkConnectionInfoFlags_Xxxx */
 676         int m_nFlags;
 677
 678         /* Internal stuff, room to change API easily */
 679         u32 reserved[63];
 680 };
 681
 682 /*
 683  * Quick connection state, pared down to something you could call
 684  * more frequently without it being too big of a perf hit.
 685  */
 686 struct SteamNetConnectionRealTimeStatus_t
 687 {
 688         /* High level state of the connection */
 689         ESteamNetworkingConnectionState m_eState;
 690
 691         /* Current ping (ms) */
 692         int m_nPing;
 693
 694         /*
 695     * Connection quality measured locally, 0...1.
 696     * (Percentage of packets delivered end-to-end in order).
 697     */
 698         float m_flConnectionQualityLocal;
 699
 700         /* Packet delivery success rate as observed from remote host */
 701         float m_flConnectionQualityRemote;
 702
 703         /* Current data rates from recent history. */
 704         float m_flOutPacketsPerSec;
 705         float m_flOutBytesPerSec;
 706         float m_flInPacketsPerSec;
 707         float m_flInBytesPerSec;
 708
 709         /*
 710     * Estimate rate that we believe that we can send data to our peer.
 711          * Note that this could be significantly higher than m_flOutBytesPerSec,
 712          * meaning the capacity of the channel is higher than you are sending data.
 713          * (That's OK!)
 714     */
 715         int m_nSendRateBytesPerSecond;
 716
 717         /*
 718     * Number of bytes pending to be sent.  This is data that you have recently
 719          * requested to be sent but has not yet actually been put on the wire.  The
 720          * reliable number ALSO includes data that was previously placed on the wire,
 721          * but has now been scheduled for re-transmission.  Thus, it's possible to
 722          * observe m_cbPendingReliable increasing between two checks, even if no
 723          * calls were made to send reliable data between the checks.  Data that is
 724          * awaiting the Nagle delay will appear in these numbers.
 725     */
 726         int m_cbPendingUnreliable;
 727         int m_cbPendingReliable;
 728
 729         /*
 730     * Number of bytes of reliable data that has been placed the wire, but
 731          * for which we have not yet received an acknowledgment, and thus we may
 732          * have to re-transmit.
 733     */
 734         int m_cbSentUnackedReliable;
 735
 736         /*
 737     * If you queued a message right now, approximately how long would that
 738     * message wait in the queue before we actually started putting its data on
 739     * the wire in a packet?
 740          *
 741          * In general, data that is sent by the application is limited by the
 742     * bandwidth of the channel.  If you send data faster than this, it must be
 743     * queued and put on the wire at a metered rate.  Even sending a small amount
 744     * of data (e.g. a few MTU, say ~3k) will require some of the data to be
 745     * delayed a bit.
 746          *
 747          * Ignoring multiple lanes,the estimated delay will be approximately equal to
 748          *
 749          *              ( m_cbPendingUnreliable+m_cbPendingReliable ) /
 750     *              m_nSendRateBytesPerSecond
 751          *
 752          * plus or minus one MTU.  It depends on how much time has elapsed since the
 753     * last packet was put on the wire.  For example, the queue might have *just*
 754     * been emptied, and the last packet placed on the wire, and we are exactly
 755     * up against the send rate limit.  In that case we might need to wait for
 756     * one packet's worth of time to elapse before we can send again. On the
 757     * other extreme, the queue might have data in it waiting for Nagle. (This
 758     * will always be less than one packet, because as soon as we have a complete
 759     * packet we would send it.)  In that case, we might be ready to send data
 760     * now, and this value will be 0.
 761          *
 762          * This value is only valid if multiple lanes are not used. If multiple lanes
 763     * are in use, then the queue time will be different for each lane, and you
 764     * must use the value in SteamNetConnectionRealTimeLaneStatus_t.
 765          *
 766          * Nagle delay is ignored for the purposes of this calculation.
 767     */
 768         SteamNetworkingMicroseconds m_usecQueueTime;
 769
 770         // Internal stuff, room to change API easily
 771         u32 reserved[16];
 772 };
 773
 774 /*
 775  * Callbacks
 776  */
 777
 778 enum { k_iSteamNetConnectionStatusChangedCallBack =
 779          k_iSteamNetworkingSocketsCallbacks + 1 };
 780
 781 typedef struct SteamNetConnectionStatusChangedCallback_t
 782                SteamNetConnectionStatusChangedCallback_t;
 783 struct SteamNetConnectionStatusChangedCallback_t
 784 {
 785         /// Connection handle
 786         HSteamNetConnection m_hConn;
 787
 788         /// Full connection info
 789         SteamNetConnectionInfo_t m_info;
 790
 791         /// Previous state.  (Current state is in m_info.m_eState)
 792         ESteamNetworkingConnectionState m_eOldState;
 793 };
 794
 795 enum { k_iSteamNetAuthenticationStatus =
 796          k_iSteamNetworkingSocketsCallbacks + 2 };
 797
 798 typedef struct SteamNetAuthenticationStatus_t SteamNetAuthenticationStatus_t;
 799 struct SteamNetAuthenticationStatus_t
 800 {
 801         /// Status
 802         ESteamNetworkingAvailability m_eAvail;
 803
 804         /// Non-localized English language status.  For diagnostic/debugging
 805         /// purposes only.
 806         char m_debugMsg[ 256 ];
 807 };
 808
 809 #pragma pack(pop)
 810
 811 /* This does not have packing specified in the steamnetworkingtypes.h, it seems
 812  * to use default */
 813 struct SteamNetworkingMessage_t
 814 {
 815         /*
 816     * Message payload
 817     */
 818         void *m_pData;
 819
 820         /*
 821     * Size of the payload.
 822     */
 823         int m_cbSize;
 824
 825         HSteamNetConnection m_conn;
 826
 827         /*
 828     * For inbound messages: Who sent this to us?
 829          * For outbound messages on connections: not used.
 830          * For outbound messages on the ad-hoc ISteamNetworkingMessages interface:
 831     *    who should we send this to?
 832     */
 833         SteamNetworkingIdentity m_identityPeer;
 834
 835         /*
 836     * For messages received on connections, this is the user data
 837          * associated with the connection.
 838          *
 839          * This is *usually* the same as calling GetConnection() and then
 840          * fetching the user data associated with that connection, but for
 841          * the following subtle differences:
 842          *
 843          * - This user data will match the connection's user data at the time
 844          *   is captured at the time the message is returned by the API.
 845          *   If you subsequently change the userdata on the connection,
 846          *   this won't be updated.
 847          * - This is an inline call, so it's *much* faster.
 848          * - You might have closed the connection, so fetching the user data
 849          *   would not be possible.
 850          *
 851          * Not used when sending messages.
 852     */
 853         i64 m_nConnUserData;
 854
 855         /*
 856     * Local timestamp when the message was received
 857          * Not used for outbound messages.
 858     */
 859         SteamNetworkingMicroseconds m_usecTimeReceived;
 860
 861         /*
 862     * Message number assigned by the sender.  This is not used for outbound
 863          * messages.  Note that if multiple lanes are used, each lane has its own
 864          * message numbers, which are assigned sequentially, so messages from
 865          * different lanes will share the same numbers.
 866     */
 867         i64 m_nMessageNumber;
 868
 869         /*
 870     * Function used to free up m_pData.  This mechanism exists so that
 871          * apps can create messages with buffers allocated from their own
 872          * heap, and pass them into the library.  This function will
 873          * usually be something like:
 874     *
 875          * free( pMsg->m_pData );
 876     */
 877         void (*m_pfnFreeData)( SteamNetworkingMessage_t *pMsg );
 878
 879         /*
 880     * Function to used to decrement the internal reference count and, if
 881          * it's zero, release the message.  You should not set this function pointer,
 882          * or need to access this directly!  Use the Release() function instead!
 883     */
 884         void (*m_pfnRelease)( SteamNetworkingMessage_t *pMsg );
 885
 886         /*
 887     * When using ISteamNetworkingMessages, the channel number the message was
 888     * received on (Not used for messages sent or received on "connections")
 889     */
 890         int m_nChannel;
 891
 892         /*
 893     * Bitmask of k_nSteamNetworkingSend_xxx flags.
 894          * For received messages, only the k_nSteamNetworkingSend_Reliable bit is
 895     *    valid.
 896          * For outbound messages, all bits are relevant
 897     */
 898         int m_nFlags;
 899
 900         /*
 901     * Arbitrary user data that you can use when sending messages using
 902          * ISteamNetworkingUtils::AllocateMessage and
 903     *    ISteamNetworkingSockets::SendMessage.
 904          * (The callback you set in m_pfnFreeData might use this field.)
 905          *
 906          * Not used for received messages.
 907     */
 908         i64 m_nUserData;
 909
 910         /*
 911     * For outbound messages, which lane to use? See
 912     *    ISteamNetworkingSockets::ConfigureConnectionLanes.
 913          * For inbound messages, what lane was the message received on?
 914     */
 915         u16 m_idxLane;
 916         u16 _pad1__;
 917 };
 918
 919 void SteamAPI_SteamNetworkingMessage_t_Release(SteamNetworkingMessage_t* self);
 920
 921
 922
 923
 924 /*
 925  * Utility
 926  */
 927
 928 static const char *string_ESteamNetworkingConnectionState(
 929       ESteamNetworkingConnectionState s )
 930 {
 931    switch(s)
 932    {
 933       case k_ESteamNetworkingConnectionState_None:       return "None"; break;
 934       case k_ESteamNetworkingConnectionState_Connecting:
 935          return "Connecting";
 936       break;
 937       case k_ESteamNetworkingConnectionState_FindingRoute:
 938          return "Finding route";
 939       break;
 940       case k_ESteamNetworkingConnectionState_Connected:
 941          return "Connected";
 942       break;
 943       case k_ESteamNetworkingConnectionState_ClosedByPeer:
 944          return "Closed By Peer";
 945       break;
 946       case k_ESteamNetworkingConnectionState_ProblemDetectedLocally:
 947          return "Problem detected locally";
 948       break;
 949       case k_ESteamNetworkingConnectionState_FinWait:
 950          return "Finwait";
 951       break;
 952       case k_ESteamNetworkingConnectionState_Linger:
 953          return "Linger";
 954       break;
 955       case k_ESteamNetworkingConnectionState_Dead:
 956          return "Dead";
 957       break;
 958       case k_ESteamNetworkingConnectionState__Force32Bit:
 959          return "Force 32 Bit";
 960       break;
 961    }
 962
 963    return "Error";
 964 }
 965
 966 static const char *string_ESteamNetworkingAvailability(
 967       ESteamNetworkingAvailability s )
 968 {
 969    switch(s)
 970    {
 971       case k_ESteamNetworkingAvailability_CannotTry:
 972          return "Cannot Try";
 973       break;
 974       case k_ESteamNetworkingAvailability_Failed:
 975          return "Failed";
 976       break;
 977       case k_ESteamNetworkingAvailability_Previously:
 978          return "Previously";
 979       break;
 980       case k_ESteamNetworkingAvailability_Retrying:
 981          return "Retrying";
 982       break;
 983       case k_ESteamNetworkingAvailability_NeverTried:
 984          return "Never tried";
 985       break;
 986       case k_ESteamNetworkingAvailability_Waiting:
 987          return "Waiting";
 988       break;
 989       case k_ESteamNetworkingAvailability_Attempting:
 990          return "Attempting";
 991       break;
 992       case k_ESteamNetworkingAvailability_Current:
 993          return "Current";
 994       break;
 995       case k_ESteamNetworkingAvailability_Unknown:
 996          return "Unknown";
 997       break;
 998       default:
 999          return "Error";
1000       break;
1001    }
1002 }
1003
1004 #endif /* VG_STEAM_NETWORKING_H */