Skip to content

API-CHECKLIST.md

Latest commit

 

History

History
105 lines (82 loc) · 3.57 KB

API-CHECKLIST.md

File metadata and controls

105 lines (82 loc) · 3.57 KB
Raw

GameNetworkingSockets API checklist

Source: GameNetworkingSockets 1.6 headers in @node-3d/deps-gns.

Library lifecycle

  • GameNetworkingSockets_Init
  • GameNetworkingSockets_Kill
  • ISteamNetworkingSockets::RunCallbacks
  • SteamNetworkingSockets_SetCustomMemoryAllocator — excluded process-global hook
  • SteamNetworkingSockets_SetLockWaitWarningThreshold — excluded process-global hook
  • SteamNetworkingSockets_SetLockAcquiredCallback — excluded process-global hook
  • SteamNetworkingSockets_SetLockHeldCallback — excluded process-global hook
  • SteamNetworkingSockets_SetServiceThreadInitCallback — excluded process-global hook

Socket creation and connection management

  • CreateListenSocketIP
  • ConnectByIPAddress
  • CreateListenSocketP2P
  • ConnectP2P
  • AcceptConnection
  • CloseConnection
  • CloseListenSocket
  • SetConnectionUserData / GetConnectionUserData
  • SetConnectionName / GetConnectionName
  • GetConnectionInfo
  • GetConnectionRealTimeStatus
  • GetDetailedConnectionStatus
  • GetListenSocketAddress
  • CreateSocketPair
  • ConfigureConnectionLanes
  • GetIdentity

Connection messages and polling

  • SendMessageToConnection
  • SendMessages
  • FlushMessagesOnConnection
  • ReceiveMessagesOnConnection
  • CreatePollGroup / DestroyPollGroup
  • SetConnectionPollGroup
  • ReceiveMessagesOnPollGroup

Connectionless messages

  • ISteamNetworkingMessages::SendMessageToUser
  • ReceiveMessagesOnChannel
  • AcceptSessionWithUser
  • CloseSessionWithUser
  • CloseChannelWithUser
  • GetSessionConnectionInfo

Events

  • SteamNetConnectionStatusChangedCallback_t
  • SteamNetAuthenticationStatus_t
  • SteamRelayNetworkStatus_t
  • SteamNetworkingMessagesSessionRequest_t
  • SteamNetworkingMessagesSessionFailed_t
  • SteamNetworkingFakeIPResult_t — unavailable in standalone public headers
  • debug-output callback

Identity, address, and configuration utilities

  • IP address parse/stringify/FakeIP type
  • identity parse/stringify
  • SetConfigValue — pointer-capable generic setter excluded; typed safe setters are available
  • GetConfigValue
  • GetConfigValueInfo
  • IterateGenericEditableConfigValues
  • typed global and connection config setters
  • GetLocalTimestamp
  • AllocateMessage

Authentication, relay, and ping services

  • InitAuthentication / GetAuthenticationStatus
  • GetCertificateRequest / SetCertificate / ResetIdentity
  • InitRelayNetworkAccess / GetRelayNetworkStatus
  • ping location get/parse/stringify/estimate/check freshness
  • POP count/list/direct ping/relay ping
  • ReceivedRelayAuthTicket / FindRelayAuthTicketForServer — unavailable in standalone SDR build

Hosted dedicated servers

  • hosted dedicated-server API — unavailable in standalone SDR build

P2P custom signalling

  • ConnectP2PCustomSignaling
  • ReceivedP2PCustomSignal
  • ISteamNetworkingConnectionSignaling::SendSignal
  • ISteamNetworkingConnectionSignaling::Release
  • ISteamNetworkingSignalingRecvContext::OnConnectRequest
  • ISteamNetworkingSignalingRecvContext::SendRejectionSignal

FakeIP and FakeUDP

  • FakeIP and FakeUDP API — unavailable in standalone public headers/build

Not in the standalone public contract

  • Steamworks SteamNetworkingSockets_SteamAPI and SteamNetworkingMessages_SteamAPI accessors
  • Steamworks game-server accessors