Class ISteamHTTP

Namespace

MarymoorStudios.Core.Steamworks

Assembly

MarymoorStudios.Core.Steamworks.dll

public sealed class ISteamHTTP : SteamNativeObject

Inheritance

object

SteamNativeObject

ISteamHTTP

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Fields

INTERFACE_VERSION

public const string INTERFACE_VERSION = "STEAMHTTP_INTERFACE_VERSION003"

Field Value

string

Methods

CreateCookieContainer(bool)

public HTTPCookieContainerHandle CreateCookieContainer(bool allowResponsesToModify)

Parameters

allowResponsesToModify bool

Returns

HTTPCookieContainerHandle

CreateHTTPRequest(EHTTPMethod, string)

public HTTPRequestHandle CreateHTTPRequest(EHTTPMethod httpRequestMethod, string absoluteURL)

Parameters

httpRequestMethod EHTTPMethod

absoluteURL string

Returns

HTTPRequestHandle

DeferHTTPRequest(HTTPRequestHandle)

public bool DeferHTTPRequest(HTTPRequestHandle request)

Parameters

request HTTPRequestHandle

Returns

bool

GetHTTPDownloadProgressPct(HTTPRequestHandle, out float)

public bool GetHTTPDownloadProgressPct(HTTPRequestHandle request, out float percentOut)

Parameters

request HTTPRequestHandle

percentOut float

Returns

bool

GetHTTPRequestWasTimedOut(HTTPRequestHandle, out bool)

public bool GetHTTPRequestWasTimedOut(HTTPRequestHandle request, out bool wasTimedOut)

Parameters

request HTTPRequestHandle

wasTimedOut bool

Returns

bool

GetHTTPResponseBodyData(HTTPRequestHandle, Span<byte>)

public bool GetHTTPResponseBodyData(HTTPRequestHandle request, Span<byte> bodyDataBuffer)

Parameters

request HTTPRequestHandle

bodyDataBuffer Span<byte>

Returns

bool

GetHTTPResponseBodySize(HTTPRequestHandle, out uint)

public bool GetHTTPResponseBodySize(HTTPRequestHandle request, out uint bodySize)

Parameters

request HTTPRequestHandle

bodySize uint

Returns

bool

GetHTTPResponseHeaderSize(HTTPRequestHandle, string, out uint)

public bool GetHTTPResponseHeaderSize(HTTPRequestHandle request, string headerName, out uint responseHeaderSize)

Parameters

request HTTPRequestHandle

headerName string

responseHeaderSize uint

Returns

bool

GetHTTPResponseHeaderValue(HTTPRequestHandle, string, Span<byte>)

public bool GetHTTPResponseHeaderValue(HTTPRequestHandle request, string headerName, Span<byte> headerValueBuffer)

Parameters

request HTTPRequestHandle

headerName string

headerValueBuffer Span<byte>

Returns

bool

GetHTTPStreamingResponseBodyData(HTTPRequestHandle, uint, Span<byte>)

public bool GetHTTPStreamingResponseBodyData(HTTPRequestHandle request, uint offset, Span<byte> bodyDataBuffer)

Parameters

request HTTPRequestHandle

offset uint

bodyDataBuffer Span<byte>

Returns

bool

OnHTTPRequestCompleted(CallbackAction<HTTPRequestCompleted>)

public IDisposable OnHTTPRequestCompleted(CallbackAction<HTTPRequestCompleted> func)

Parameters

func CallbackAction<HTTPRequestCompleted>

Returns

IDisposable

OnHTTPRequestDataReceived(CallbackAction<HTTPRequestDataReceived>)

public IDisposable OnHTTPRequestDataReceived(CallbackAction<HTTPRequestDataReceived> func)

Parameters

func CallbackAction<HTTPRequestDataReceived>

Returns

IDisposable

OnHTTPRequestHeadersReceived(CallbackAction<HTTPRequestHeadersReceived>)

public IDisposable OnHTTPRequestHeadersReceived(CallbackAction<HTTPRequestHeadersReceived> func)

Parameters

func CallbackAction<HTTPRequestHeadersReceived>

Returns

IDisposable

PrioritizeHTTPRequest(HTTPRequestHandle)

public bool PrioritizeHTTPRequest(HTTPRequestHandle request)

Parameters

request HTTPRequestHandle

Returns

bool

ReleaseCookieContainer(HTTPCookieContainerHandle)

public bool ReleaseCookieContainer(HTTPCookieContainerHandle cookieContainer)

Parameters

cookieContainer HTTPCookieContainerHandle

Returns

bool

ReleaseHTTPRequest(HTTPRequestHandle)

public bool ReleaseHTTPRequest(HTTPRequestHandle request)

Parameters

request HTTPRequestHandle

Returns

bool

SendHTTPRequest(HTTPRequestHandle, out SteamAPICall)

public bool SendHTTPRequest(HTTPRequestHandle request, out SteamAPICall callHandle)

Parameters

request HTTPRequestHandle

callHandle SteamAPICall

Returns

bool

SendHTTPRequestAndStreamResponse(HTTPRequestHandle, out SteamAPICall)

public bool SendHTTPRequestAndStreamResponse(HTTPRequestHandle request, out SteamAPICall callHandle)

Parameters

request HTTPRequestHandle

callHandle SteamAPICall

Returns

bool

SetCookie(HTTPCookieContainerHandle, string, string, string)

public bool SetCookie(HTTPCookieContainerHandle cookieContainer, string host, string url, string cookie)

Parameters

cookieContainer HTTPCookieContainerHandle

host string

url string

cookie string

Returns

bool

SetHTTPRequestAbsoluteTimeoutMS(HTTPRequestHandle, uint)

public bool SetHTTPRequestAbsoluteTimeoutMS(HTTPRequestHandle request, uint milliseconds)

Parameters

request HTTPRequestHandle

milliseconds uint

Returns

bool

SetHTTPRequestContextValue(HTTPRequestHandle, ulong)

public bool SetHTTPRequestContextValue(HTTPRequestHandle request, ulong contextValue)

Parameters

request HTTPRequestHandle

contextValue ulong

Returns

bool

SetHTTPRequestCookieContainer(HTTPRequestHandle, HTTPCookieContainerHandle)

public bool SetHTTPRequestCookieContainer(HTTPRequestHandle request, HTTPCookieContainerHandle cookieContainer)

Parameters

request HTTPRequestHandle

cookieContainer HTTPCookieContainerHandle

Returns

bool

SetHTTPRequestGetOrPostParameter(HTTPRequestHandle, string, string)

public bool SetHTTPRequestGetOrPostParameter(HTTPRequestHandle request, string paramName, string paramValue)

Parameters

request HTTPRequestHandle

paramName string

paramValue string

Returns

bool

SetHTTPRequestHeaderValue(HTTPRequestHandle, string, string)

public bool SetHTTPRequestHeaderValue(HTTPRequestHandle request, string headerName, string headerValue)

Parameters

request HTTPRequestHandle

headerName string

headerValue string

Returns

bool

SetHTTPRequestNetworkActivityTimeout(HTTPRequestHandle, uint)

public bool SetHTTPRequestNetworkActivityTimeout(HTTPRequestHandle request, uint timeoutSeconds)

Parameters

request HTTPRequestHandle

timeoutSeconds uint

Returns

bool

SetHTTPRequestRawPostBody(HTTPRequestHandle, string, Span<byte>)

public bool SetHTTPRequestRawPostBody(HTTPRequestHandle request, string contentType, Span<byte> body)

Parameters

request HTTPRequestHandle

contentType string

body Span<byte>

Returns

bool

SetHTTPRequestRequiresVerifiedCertificate(HTTPRequestHandle, bool)

public bool SetHTTPRequestRequiresVerifiedCertificate(HTTPRequestHandle request, bool requireVerifiedCertificate)

Parameters

request HTTPRequestHandle

requireVerifiedCertificate bool

Returns

bool

SetHTTPRequestUserAgentInfo(HTTPRequestHandle, string)

public bool SetHTTPRequestUserAgentInfo(HTTPRequestHandle request, string userAgentInfo)

Parameters

request HTTPRequestHandle

userAgentInfo string

Returns

bool