Steamworks v1.1.0
Open on GitHub Open in Dash

SteamHTTP

Swift
public struct SteamHTTP: Sendable

Steamworks ISteamHTTP

Access via http through a SteamAPI or SteamGameServerAPI instance.

Topics

Steamworks ISteamHTTP::CreateCookieContainer()

Declaration
Swift
public func createCookieContainer(allowResponsesToModify: Bool)
    -> HTTPCookieContainerHandle

Steamworks ISteamHTTP::CreateHTTPRequest()

Declaration
Swift
public func createHTTPRequest(
    httpRequestMethod: HTTPMethod, absoluteURL: String
) -> HTTPRequestHandle

Steamworks ISteamHTTP::DeferHTTPRequest()

Declaration
Swift
@discardableResult
public func deferHTTPRequest(request: HTTPRequestHandle) -> Bool

Steamworks ISteamHTTP::GetHTTPDownloadProgressPct()

Declaration
Swift
public func getHTTPDownloadProgressPct(request: HTTPRequestHandle) -> (
    rc: Bool, percent: Float
)

Steamworks ISteamHTTP::GetHTTPRequestWasTimedOut()

Declaration
Swift
public func getHTTPRequestWasTimedOut(request: HTTPRequestHandle) -> (
    rc: Bool, wasTimedOut: Bool
)

Steamworks ISteamHTTP::GetHTTPResponseBodyData()

Declaration
Swift
public func getHTTPResponseBodyData(request: HTTPRequestHandle, bufferSize: Int)
    -> (rc: Bool, bodyDataBuffer: [UInt8])

Steamworks ISteamHTTP::GetHTTPResponseBodySize()

Declaration
Swift
public func getHTTPResponseBodySize(request: HTTPRequestHandle) -> (
    rc: Bool, bodySize: Int
)

Steamworks ISteamHTTP::GetHTTPResponseHeaderSize()

Declaration
Swift
public func getHTTPResponseHeaderSize(
    request: HTTPRequestHandle, headerName: String
) -> (rc: Bool, responseHeaderSize: Int)

Steamworks ISteamHTTP::GetHTTPResponseHeaderValue()

Declaration
Swift
public func getHTTPResponseHeaderValue(
    request: HTTPRequestHandle, headerName: String, bufferSize: Int
) -> (rc: Bool, headerValueBuffer: [UInt8])

Steamworks ISteamHTTP::GetHTTPStreamingResponseBodyData()

Declaration
Swift
public func getHTTPStreamingResponseBodyData(
    request: HTTPRequestHandle, offset: Int,
    bodyDataBuffer: UnsafeMutablePointer<UInt8>, bufferSize: Int
) -> Bool

Steamworks ISteamHTTP::PrioritizeHTTPRequest()

Declaration
Swift
@discardableResult
public func prioritizeHTTPRequest(request: HTTPRequestHandle) -> Bool

Steamworks ISteamHTTP::ReleaseCookieContainer()

Declaration
Swift
@discardableResult
public func releaseCookieContainer(cookieContainer: HTTPCookieContainerHandle)
    -> Bool

Steamworks ISteamHTTP::ReleaseHTTPRequest()

Declaration
Swift
@discardableResult
public func releaseHTTPRequest(request: HTTPRequestHandle) -> Bool

Steamworks ISteamHTTP::SetCookie()

Declaration
Swift
public func setCookie(
    cookieContainer: HTTPCookieContainerHandle, host: String, url: String,
    cookie: String
) -> Bool

Steamworks ISteamHTTP::SetHTTPRequestAbsoluteTimeoutMS()

Declaration
Swift
public func setHTTPRequestAbsoluteTimeoutMS(
    request: HTTPRequestHandle, milliseconds: Int
) -> Bool

Steamworks ISteamHTTP::SetHTTPRequestContextValue()

Declaration
Swift
public func setHTTPRequestContextValue(
    request: HTTPRequestHandle, contextValue: UInt64
) -> Bool

Steamworks ISteamHTTP::SetHTTPRequestCookieContainer()

Declaration
Swift
@discardableResult
public func setHTTPRequestCookieContainer(
    request: HTTPRequestHandle, cookieContainer: HTTPCookieContainerHandle
) -> Bool

Steamworks ISteamHTTP::SetHTTPRequestGetOrPostParameter()

Declaration
Swift
public func setHTTPRequestGetOrPostParameter(
    request: HTTPRequestHandle, paramName: String, paramValue: String
) -> Bool

Steamworks ISteamHTTP::SetHTTPRequestHeaderValue()

Declaration
Swift
public func setHTTPRequestHeaderValue(
    request: HTTPRequestHandle, headerName: String, headerValue: String
) -> Bool

Steamworks ISteamHTTP::SetHTTPRequestNetworkActivityTimeout()

Declaration
Swift
public func setHTTPRequestNetworkActivityTimeout(
    request: HTTPRequestHandle, timeoutSeconds: Int
) -> Bool

Steamworks ISteamHTTP::SetHTTPRequestRawPostBody()

Declaration
Swift
public func setHTTPRequestRawPostBody(
    request: HTTPRequestHandle, contentType: String, body: UnsafePointer<UInt8>,
    bodyLen: Int
) -> Bool

Steamworks ISteamHTTP::SetHTTPRequestRequiresVerifiedCertificate()

Declaration
Swift
public func setHTTPRequestRequiresVerifiedCertificate(
    request: HTTPRequestHandle, requireVerifiedCertificate: Bool
) -> Bool

Steamworks ISteamHTTP::SetHTTPRequestUserAgentInfo()

Declaration
Swift
@discardableResult
public func setHTTPRequestUserAgentInfo(
    request: HTTPRequestHandle, userAgentInfo: String
) -> Bool

Steamworks ISteamHTTP::SendHTTPRequest()

Declaration
Swift
public func sendHTTPRequest(
    request: HTTPRequestHandle,
    completion: sending @escaping (HTTPRequestCompleted?) -> Void)

Steamworks ISteamHTTP::SendHTTPRequestAndStreamResponse()

Declaration
Swift
public func sendHTTPRequestAndStreamResponse(
    request: HTTPRequestHandle,
    completion: sending @escaping (HTTPRequestCompleted?) -> Void)
Note

Provided by module SteamworksHelpers.

Steamworks ISteamHTTP::GetHTTPResponseBodyData()

Declaration
Swift
public func getHTTPResponseBodyData(request: HTTPRequestHandle) -> (
    rc: Bool, bodyDataBuffer: [UInt8]
)
Note

Provided by module SteamworksHelpers.

Steamworks ISteamHTTP::GetHTTPResponseHeaderValue()

Declaration
Swift
public func getHTTPResponseHeaderValue(
    request: HTTPRequestHandle, headerName: String
) -> (rc: Bool, headerValueBuffer: [UInt8])