Steamworks v1.1.0
Open on GitHub Open in Dash

SteamNetworkingUtils

Swift
public struct SteamNetworkingUtils: Sendable

Steamworks ISteamNetworkingUtils

Access via networkingUtils through a SteamAPI or SteamGameServerAPI instance.

Topics

Steamworks ISteamNetworkingUtils::AllocateMessage()

Declaration
Swift
public func allocateMessage(allocateBufferSize: Int) -> SteamNetworkingMessage

Steamworks ISteamNetworkingUtils::CheckPingDataUpToDate()

Declaration
Swift
public func checkPingDataUpToDate(maxAgeSeconds: Float) -> Bool

Steamworks ISteamNetworkingUtils::ConvertPingLocationToString()

Declaration
Swift
public func convertPingLocationToString(
    location: SteamNetworkPingLocation,
    bufSize: Int = SteamConstants.maxSteamNetworkingPingLocationStringSize
) -> String

Steamworks ISteamNetworkingUtils::EstimatePingTimeBetweenTwoLocations()

Declaration
Swift
public func estimatePingTimeBetweenTwoLocations(
    location1: SteamNetworkPingLocation, location2: SteamNetworkPingLocation
) -> Int

Steamworks ISteamNetworkingUtils::EstimatePingTimeFromLocalHost()

Declaration
Swift
public func estimatePingTimeFromLocalHost(location: SteamNetworkPingLocation)
    -> Int

Steamworks ISteamNetworkingUtils::GetConfigValue()

Declaration
Swift
public func getConfigValue(
    value: SteamNetworkingConfigValueSetting,
    scopeType: SteamNetworkingConfigScope, obj: Int,
    result: UnsafeMutableRawPointer?, resultSize: Int
) -> (
    rc: SteamNetworkingGetConfigValueResult,
    dataType: SteamNetworkingConfigDataType, resultSize: Int
)

Steamworks ISteamNetworkingUtils::GetConfigValueInfo()

Declaration
Swift
public func getConfigValueInfo(value: SteamNetworkingConfigValueSetting) -> (
    rc: String, dataType: SteamNetworkingConfigDataType,
    scope: SteamNetworkingConfigScope
)

Steamworks ISteamNetworkingUtils::GetDirectPingToPOP()

Declaration
Swift
public func getDirectPingToPOP(id: SteamNetworkingPOPID) -> Int

Steamworks ISteamNetworkingUtils::GetIPv4FakeIPType()

Declaration
Swift
public func getIPv4FakeIPType(ipv4: Int) -> SteamNetworkingFakeIPType

Steamworks ISteamNetworkingUtils::GetLocalPingLocation()

Declaration
Swift
public func getLocalPingLocation() -> (
    rc: Float, result: SteamNetworkPingLocation
)

Steamworks ISteamNetworkingUtils::GetLocalTimestamp()

Declaration
Swift
public func getLocalTimestamp() -> SteamNetworkingMicroseconds

Steamworks ISteamNetworkingUtils::GetPOPCount()

Declaration
Swift
public func getPOPCount() -> Int

Steamworks ISteamNetworkingUtils::GetPOPList()

Declaration
Swift
public func getPOPList(listSz: Int) -> (rc: Int, list: [SteamNetworkingPOPID])

Steamworks ISteamNetworkingUtils::GetPingToDataCenter()

Declaration
Swift
public func getPingToDataCenter(id: SteamNetworkingPOPID) -> (
    rc: Int, viaRelayPoP: SteamNetworkingPOPID
)

Steamworks ISteamNetworkingUtils::GetRealIdentityForFakeIP()

Declaration
Swift
public func getRealIdentityForFakeIP(ip: SteamNetworkingIPAddr) -> (
    rc: Result, realIdentity: SteamNetworkingIdentity
)

Steamworks ISteamNetworkingUtils::GetRelayNetworkStatus()

Declaration
Swift
public func getRelayNetworkStatus(returnDetails: Bool = true) -> (
    rc: SteamNetworkingAvailability, details: SteamRelayNetworkStatus
)

Steamworks ISteamNetworkingUtils::InitRelayNetworkAccess()

Declaration
Swift
public func initRelayNetworkAccess()

Steamworks ISteamNetworkingUtils::IsFakeIPv4()

Declaration
Swift
public func isFakeIPv4(ipv4: Int) -> Bool

Steamworks ISteamNetworkingUtils::IterateGenericEditableConfigValues()

Declaration
Swift
public func iterateGenericEditableConfigValues(
    current: SteamNetworkingConfigValueSetting, enumerateDevVars: Bool
) -> SteamNetworkingConfigValueSetting

Steamworks ISteamNetworkingUtils::ParsePingLocationString()

Declaration
Swift
public func parsePingLocationString(string: String) -> (
    rc: Bool, result: SteamNetworkPingLocation
)

Steamworks ISteamNetworkingUtils::SetConfigValue()

Declaration
Swift
@discardableResult
public func setConfigValue(
    value: SteamNetworkingConfigValueSetting,
    scopeType: SteamNetworkingConfigScope, obj: Int,
    dataType: SteamNetworkingConfigDataType, arg: UnsafeRawPointer
) -> Bool

Steamworks ISteamNetworkingUtils::SetConfigValueStruct()

Declaration
Swift
@discardableResult
public func setConfigValueStruct(
    opt: SteamNetworkingConfigValue, scopeType: SteamNetworkingConfigScope,
    obj: Int
) -> Bool

Steamworks ISteamNetworkingUtils::SetConnectionConfigValueFloat()

Declaration
Swift
@discardableResult
public func setConnectionConfigValueFloat(
    conn: HSteamNetConnection, value: SteamNetworkingConfigValueSetting,
    val: Float
) -> Bool

Steamworks ISteamNetworkingUtils::SetConnectionConfigValueInt32()

Declaration
Swift
@discardableResult
public func setConnectionConfigValueInt32(
    conn: HSteamNetConnection, value: SteamNetworkingConfigValueSetting,
    val: Int
) -> Bool

Steamworks ISteamNetworkingUtils::SetConnectionConfigValueString()

Declaration
Swift
@discardableResult
public func setConnectionConfigValueString(
    conn: HSteamNetConnection, value: SteamNetworkingConfigValueSetting,
    val: String
) -> Bool

Steamworks ISteamNetworkingUtils::SetGlobalConfigValueFloat()

Declaration
Swift
@discardableResult
public func setGlobalConfigValueFloat(
    value: SteamNetworkingConfigValueSetting, val: Float
) -> Bool

Steamworks ISteamNetworkingUtils::SetGlobalConfigValueInt32()

Declaration
Swift
@discardableResult
public func setGlobalConfigValueInt32(
    value: SteamNetworkingConfigValueSetting, val: Int
) -> Bool

Steamworks ISteamNetworkingUtils::SetGlobalConfigValuePtr()

Declaration
Swift
@discardableResult
public func setGlobalConfigValuePtr(
    value: SteamNetworkingConfigValueSetting, val: UnsafeMutableRawPointer
) -> Bool

Steamworks ISteamNetworkingUtils::SetGlobalConfigValueString()

Declaration
Swift
@discardableResult
public func setGlobalConfigValueString(
    value: SteamNetworkingConfigValueSetting, val: String
) -> Bool

Steamworks ISteamNetworkingUtils::SteamNetworkingIPAddr_GetFakeIPType()

Declaration
Swift
public func steamNetworkingIPAddrGetFakeIPType(addr: SteamNetworkingIPAddr)
    -> SteamNetworkingFakeIPType

Steamworks ISteamNetworkingUtils::SetListenSocketConfigValueFloat()

Declaration
Swift
@discardableResult
public func setListenSocketConfigValueFloat(
    sock: HSteamListenSocket, value: SteamNetworkingConfigValueSetting,
    val: Float
) -> Bool

Steamworks ISteamNetworkingUtils::SetListenSocketConfigValueInt32()

Declaration
Swift
@discardableResult
public func setListenSocketConfigValueInt32(
    sock: HSteamListenSocket, value: SteamNetworkingConfigValueSetting, val: Int
) -> Bool

Steamworks ISteamNetworkingUtils::SetListenSocketConfigValueString()

Declaration
Swift
@discardableResult
public func setListenSocketConfigValueString(
    sock: HSteamListenSocket, value: SteamNetworkingConfigValueSetting,
    val: String
) -> Bool

Steamworks ISteamNetworkingUtils::GetConfigValue() for FloatFloat

Declaration
Swift
public func getConfigValueFloat(
    _ value: SteamNetworkingConfigValueSetting,
    scopeType: SteamNetworkingConfigScope, obj: Int
) -> (rc: SteamNetworkingGetConfigValueResult, outValue: Float)

Steamworks ISteamNetworkingUtils::GetConfigValue() for IntInt

Declaration
Swift
public func getConfigValueInt(
    _ value: SteamNetworkingConfigValueSetting,
    scopeType: SteamNetworkingConfigScope, obj: Int
) -> (rc: SteamNetworkingGetConfigValueResult, outValue: Int)

Steamworks ISteamNetworkingUtils::GetConfigValue() for StringString

Declaration
Swift
public func getConfigValueString(
    _ value: SteamNetworkingConfigValueSetting,
    scopeType: SteamNetworkingConfigScope, obj: Int
) -> (rc: SteamNetworkingGetConfigValueResult, outValue: String)

Use ISteamNetworkingUtils::SetDebugOutputFunction() to send networking debug tracing through the SteamBaseAPI/logger logger.

Declaration
Swift
public func useLoggerForDebug(
    detailLevel: SteamNetworkingSocketsDebugOutputType)
Note

Provided by module SteamworksHelpers.

Steamworks ISteamNetworkingUtils::GetPOPList()

Declaration
Swift
public func getPOPList() -> (rc: Int, list: [SteamNetworkingPOPID])