LibHTTP4.HttpSock

Extends

Info

Modifiers

config dependson ( HttpUtil )

HttpSock
Base of [[LibHTTP]] this implements the main network methods for connecting to a webserver and retreiving data from it. Binary data is not supported.
Dcoumentation and Information: http://wiki.beyondunreal.com/wiki/LibHTTP

Authors: Michiel 'El Muerte' Hendriks <elmuerte@drunksnipers.com>

Copyright 2003-2005 Michiel "El Muerte" Hendriks
Released under the Lesser Open Unreal Mod License
http://wiki.beyondunreal.com/wiki/LesserOpenUnrealModLicense

Core.Object
|   
+-- Engine.Actor
   |   
   +-- Engine.Info
      |   
      +-- LibHTTP4.HttpSock

Direct Known Subclasses:

UTANUplink

Delegates Summary
		OnComplete (HttpSock Sender)
		OnConnectError (HttpSock Sender)
		OnConnectionTimeout (HttpSock Sender)
		OnError (HttpSock Sender, string ErrorMessage, optional string Param1, optional string Param2)
	bool	OnFollowRedirect (HttpSock Sender, HttpUtil.xURL NewLocation))
		OnPreConnect (HttpSock Sender)
		OnRequestBody (HttpSock Sender)
		OnRequireAuthorization (HttpSock Sender, EAuthMethod method, array<GameInfo.KeyValuePair> info)
		OnRequireProxyAuthorization (HttpSock Sender, EAuthMethod method, array<GameInfo.KeyValuePair> info)
	bool	OnResolved (HttpSock Sender, string hostname, InternetLink.IpAddr Addr))
		OnResolveFailed (HttpSock Sender, string hostname)
	bool	OnResponseBody (HttpSock Sender, string line))
		OnReturnCode (HttpSock Sender, int ReturnCode, string ReturnMessage, string HttpVer)
		OnSendRequestHeaders (HttpSock Sender)

Functions Summary
	bool	Abort ()))
	bool	AddHeader (string hname, coerce string value, optional bool bNoReplace))
	bool	CachedResolve (coerce string hostname, optional bool bDontConnect))
	bool	clearFormData ()))
		ClearRequestData (optional bool bDontClearAuth))
		Closed ()))
		CloseSocket ()))
	bool	CreateSocket ()))
	int	DataSize (array<string> data))
		Destroyed ()))
	string	genAuthorization (EAuthMethod method, string Username, string Password, array<GameInfo.KeyValuePair> Info))
	string	genBasicAuthorization (string Username, string Password))
	string	genDigestAuthorization (string Username, string Password, array<GameInfo.KeyValuePair> Info))
	bool	get (string location))
	string	getHTTPversion ()))
	string	GetRequestHeader (string hname, optional coerce string def))
	string	GetReturnHeader (string hname, optional coerce string def))
	int	getTZoffset ()))
	string	GetValue (string key, array<GameInfo.KeyValuePair> Info, optional coerce string def))
	bool	head (string location))
	bool	HttpRequest (string location, string Method))
	bool	httrace (string location))
		InternalResolved (InternetLink.IpAddr Addr, optional bool bDontCache))
	bool	IsAuthMethodSupported (EAuthMethod method))
	bool	IsSupportedMethod ()))
		Logf (coerce string message, optional int level, optional coerce string Param1, optional coerce string Param2))
	int	now ()))
	bool	OpenConnection ()))
		Opened ()))
	bool	post (string location, optional string PostData))
	bool	postex (string location, optional array<string> PostData))
		PreBeginPlay ()))
		ProccessWWWAuthenticate (string HeaderData, bool bProxyAuth))
		ProcHeaders ()))
		ProcInput (string inline))
	string	randString (optional int size, optional coerce string prefix))
		ReceivedText (string Line ))
	bool	RemoveHeader (string hname))
		ResolveFailed ()))
		SendData (string data, optional bool bFlush))
	bool	setFormData (string field, coerce string data, optional string contentType, optional string contentEncoding))
	bool	setFormDataEx (string field, array<string> data, optional string contentType, optional string contentEncoding))
	bool	setHTTPversion (optional string newver))
	bool	ShouldFollowRedirect (int retc, string method))
	EAuthMethod	StrToAuthMethod (coerce string method))
		Timer ()))
	string	UserAgent ()))

BUFFERSIZE Source code

the output buffer size

HTTP_CONNECT Source code

HTTP_DELETE Source code

HTTP_GET Source code

HTTP_HEAD Source code

HTTP_OPTIONS Source code

HTTP_POST Source code

HTTP_PUT Source code

HTTP_TRACE Source code

VERSION Source code

LibHTTP version number

authBasicLookup Source code

Base64 encoding lookup table

bAuthTrap Source code

true if an authentication retry should happen

bIsChunked Source code

true if the data is chunked (e.g. Transfer-Encoding: chunked )

BoundPort Source code

the port we are connected to

bTempProxyOverride Source code

will be set to true in case of a ...

bTimeout Source code

true in case of a connection timeout

bUseTempProxy Source code

if true use the TempProxy

chunkedCounter Source code

bytes left in the chunk

Cookies Source code

the cookie data instance

CRLF Source code

constant CR LF

CurRedir Source code

current number of redirections

curState Source code

The current state of the socket

EXTENTION Source code

If you make a custom build of this package, or subclass this class then please change the following constant to countain your "extention" name. This will be used in the UserAgent string. (Change it in the defaultproperties)

FollowingRedir Source code

true if a redirection should be followed

HttpCookieClass Source code

Cookie class to use (if it has not been set)

HttpLink Source code

handle to the HttpLink

HttpLinkClass Source code

the link class to use

HTTPVER Source code

The HTTP version to use. Either 1.0 or 1.1 are supported.

inBuffer Source code

i/o buffers

LastStatus Source code

The last returned HTTP status code

LocalLink Source code

local link address

MultiPartBoundary Source code

Multipart boundary string, used to split fields

outBuffer Source code

i/o buffers

procHeader Source code

true if headers are being processed

RequestData Source code

the request data

RequestDuration Source code

duration of the last request

RequestHeaders Source code

the request headers

RequestHistory Source code

history with requests for a single request, will contain more then one entry

RequestMethod Source code

the request method

ResolveCache Source code

cache object with hostname resolves

ResolveHostname Source code

the hostname being resolved, used to add to the resolve cache

ReturnData Source code

the return data

ReturnHeaders Source code

the return headers

StartRequestTime Source code

start of the request, will be set after the connection was opened and before the actual request will be send

TempProxy Source code

temporary proxy configuration

TZoffset Source code

Timezone Offset, dynamically calculated from the server's time

Utils Source code

utility class, used to speed up lookups (optimization)

Authentication

AuthInfo Source code

authentication information

AuthMethod Source code

Authentication method to use when sUsername is set. This will

bAutoAuthenticate Source code

If username and password have been set automatically retry the request to authenticate. Note: this can only be done in a second try because the

Options

bFollowRedirect Source code

when set to false it won't follow redirects

bProcCookies Source code

Process incoming cookies, defaults to true

bRfcCompliantRedirect Source code

responding to HTTP redirect headers is RFC compliant, otherwise it will behave much like some other HTTP clients behave. This means that in case of a 301/302 it will set the request method from POST to GET. This is not the way it should happen according to the standard.

bSendCookies Source code

Send cookie data when available, defaults to true

fConnectTimout Source code

connection timeout, if the connection couldn't be established within this time limit it will abort the connection and call OnTimeout()

iMaxRedir Source code

Maximum redirections to follow

iVerbose Source code

log verbosity, you probably want to leave this 0. check the [[HttpUtil]] class for various log levels.

Proxy

bUseProxy Source code

Use a proxy server, this is (and the other proxy settins) a client setting. It's meant for clients to be set when they need to use a proxy.

iProxyPort Source code

The proxy port

ProxyAuthInfo Source code

authentication information

ProxyAuthMethod Source code

Authentication method to use when sUsername is set. This will

sProxyHost Source code

The hostname of the proxy

sProxyPass Source code

proxy authentication information

sProxyUser Source code

proxy authentication information

URL

CurrentURL Source code

the URL struct for the current request

DefaultAccept Source code

the default value for the Accept header, we only support "text / *"

iLocalPort Source code

the local port, leave zero to use a random port (adviced)

XferMode

iMaxBytesPerTick Source code

maximum number of bytes to download in a single tick

iMaxIterationsPerTick Source code

Maximum iterations per tick in fast transfer mode. This defines the number of download retries (when nothing was received) the code may perform within a single tick. Because the data pending variable is only updated each tick it will remain true until the transfer function returns even tho there is no data pending.

TransferMode Source code

Transfer mode to use during downloads

EAuthMethod Source code

Possible authentication methods, Basic used Base64 encoding to encode the username and password. Digest is more secure.

ETransferMode Source code

Method used to download the data.
TM_Fast will try to read as much as possible in a single tick, this will have an impact on the game performance during the download. Only use this mode when it's time critical. Use the variables iMaxBytesPerTick and iMaxIterationsPerTick to tweak this transfer mode.

HTTPState Source code

RequestHistoryEntry Source code

Hostname:

server hostname

HTTPresponse:

the HTTP response code received

Location:

location, can include GET data

Method:

method used in the request

URL:

the request URL

OnComplete Source code

Will be called when the operation was completed successfully.
It won't be called when an time out occured.

OnConnectError Source code

Called when Open() fails

OnConnectionTimeout Source code

called when the connection has timed out (e.g. open() failed after a set time)

OnError Source code

Will be called in case of an internal error.

OnFollowRedirect Source code

Called before the redirection is followed, return false to prevernt following the redirection

OnPreConnect Source code

Called before the connection is established.

OnRequestBody Source code

Will be called when the request body has to be send. Do note that you are required to set the Content-Length header to the total size of the content being send. If you use this delegate to send the request body manually you will have to set the Content-Length header yourself.

OnRequireAuthorization Source code

Will be called when authorization is required for the current location.
This will be called directly after receiving the WWW-Authenticate header. So it's best not to stall this call. It's just a notification.

OnRequireProxyAuthorization Source code

Will be called when authorization is required for the current proxy.
This will be called directly after receiving the Proxy-Authenticate header. So it's best not to stall this call. It's just a notification.

OnResolved Source code

Will be called when the host name is resolved.
Return true to continue, or false to abort.

OnResolveFailed Source code

Called when the resolved failed, hostname is the hostname that could not be resolved

OnResponseBody Source code

Will be called for every response line received (only the body). Return false to stop the default behavior of storing the response body. Use this delegate if you need to have live updates of the content and can not wait until the request is complete.

OnReturnCode Source code

Will be called when the return code has been received; This is the first function called after the request has been send.

OnSendRequestHeaders Source code

This delegate will be send right before the headers are send to the webserver. If you want to change the headers you should do it here.
Warning: becarefull not to change or unset automatically generated headers that are important for this request (like authentication or request body headers)

Abort Source code

Abort the current request, if possible

AddHeader Source code

Add a header, case insensitive. Set bNoReplace to false to not overwrite the old header. Returns true when the header has been set.

CachedResolve Source code

lookup a chached resolve and connect if found

clearFormData Source code

This will clear the POST data. Use this before calling setFormData

ClearRequestData Source code

This function will clear the previous request data. You may want to use this when you do a new request with the same socket. Previous set headers won't be unset automatically.

Closed Source code

connection closed, check for a required redirection

CloseSocket Source code

destroy the current socket, should only be called in case of a timeout

CreateSocket Source code

create the socket, if required

DataSize Source code

Return the actual data size of a string array, it appends sizeof(CRLF) for each line. This is used for sending the RequestData.

Destroyed Source code

clean up as much as possible

genAuthorization Source code

generate the authentication data, depending on the method it will be either a Basic or Digest response

genBasicAuthorization Source code

Generated a basic authentication response

genDigestAuthorization Source code

generate the Digest authorization data string

get Source code

This will perform a simple HTTP GET request. This will be the most commonly used function to retrieve a document from a webserver. The location is just like the location you would use in your webbrowser.

getHTTPversion Source code

return thr current HTTP version setting

GetRequestHeader Source code

Returns the value of the requested header, or default if not found

GetReturnHeader Source code

Returns the value of the returned header, or default if not found

getTZoffset Source code

Return the timezone offset

GetValue Source code

Returns the value of a KeyValuePair

head Source code

perform a HTTP HEAD request. This will only return the headers. Use this this if you only want to check the file info on the server and not the whole body.

HttpRequest Source code

Start the HTTP request. Location can be a fully qualified url, or just the location on the configured server.
This is an internal function called by the get(), head() and post() functions. If you want to support additional HTTP requests you should subclass this class.

httrace Source code

perform a HTTP TRACE request. This will simply cause the webserver to return the request it received. It's only usefull for debugging.

InternalResolved Source code

hostname has been resolved

IsAuthMethodSupported Source code

return if the authentication method is supported

IsSupportedMethod Source code

Returns true when the request method is supported

Logf Source code

manage logging

now Source code

Returns the current timestamp. Warning this is not a valid UNIX timestamp because the timezone is unknown (e.g. timestamps are always GMT)

OpenConnection Source code

start the download

Opened Source code

will be called from HttpLink

post Source code

This will perform a simple HTTP POST request. If the PostData is not empty it will overwrite the current post data and set the content type to application/x-www-form-urlencoded.

postex Source code

Perform a HTTP POST request using an array containing the postdata. if the array length > 0 it will overwrite the current post data. It will send the post data AS IS and doesn't set the content-type.
You might want to use the post(); function together with setFormData();, that method is easier to use.

PreBeginPlay Source code

initialize some variables

ProccessWWWAuthenticate Source code

Process the header data of a WWW-Authenticate or Proxy-Authorization header

ProcHeaders Source code

Will be called by ProcInput after all headers have been received

ProcInput Source code

Process the input

randString Source code

Generates a random string. The size defaults to 16. Prefix isn't included with the size;

ReceivedText Source code

called from HttpLink

RemoveHeader Source code

Remove a header, case insensitive. Returns true when the header is deleted

ResolveFailed Source code

will be called from HttpLink when the resolve failed

SendData Source code

Send data buffered
if bFlush it will flush all remaining data (should be used for the last call)

setFormData Source code

Simple form of setFormDataEx when the data is only one line

setFormDataEx Source code

Add form data (used for multipart/form-data instead of application/x-www-form-urlencoded). This method makes it easier to add form-data. It doesn't clear the previous data, it will just append it. Form Data gives you more control over the actual data send. Also you don't have to escape the data.
It will also force the content type to multipart/form-data.

setHTTPversion Source code

Set the HTTP version, if empty the default will be used.

ShouldFollowRedirect Source code

returns true when a redirect should be followed, also updates headers for the next request.

StrToAuthMethod Source code

string to EAuthMethod

Timer Source code

timer is used for the conenection timeout.

UserAgent Source code

Returns the useragent string we use

defaultproperties
{
    EXTENTION=""
    iVerbose=-1
    iLocalPort=0
    bFollowRedirect=true
    bRfcCompliantRedirect=true
    curState=HTTPState_Closed
    iMaxRedir=5
    HTTPVER="1.1"
    DefaultAccept="text/*"
    bSendCookies=true
    bProcCookies=true
    bUseProxy=false
    fConnectTimout=60
    HttpLinkClass=class'HttpLink'
    HttpCookieClass=class'HttpCookies'
    TransferMode=TM_Normal
    iMaxIterationsPerTick=32
    iMaxBytesPerTick=4096
    AuthMethod=AM_None
    bAutoAuthenticate=true
}