LibHTTP4.HttpCache

Extends

Info

Modifiers

config ( HttpCache ) ParseConfig dependsOn ( HttpUtil )

HttpCache
Disk\Memory cache for LibHTTP, it will handle caching of data. To use it simply create a HttpCache object and use it's get() request to get updated documents. Don't use a HttpSock instance for this.
When using this class it will perform a specially constructed get request when it's needed, it will try to satisfy the caching headers returned by the server. Ihis class is only usefull if you know the remote server returns correct cachable data. By default most dynamic pages (ASP, PHP, Perl, CGI) will return non-cachable pages.

Dcoumentation and Information: http://wiki.beyondunreal.com/wiki/LibHTTP

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

Copyright 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.HttpCache

Delegates Summary
		OnComplete (HttpCache Sender, HttpCacheObject Data, EDataOrigin origin)
		OnCreateSock (HttpCache Sender, HttpSock Socket)
		OnError (HttpCache Sender, string ErrorMessage, optional string Param1, optional string Param2)
		OnFail (HttpCache Sender, int idx, ECacheFailError reason)

Functions Summary
		CacheCleanup ()))
	int	createHash (string URL))
		DownloadComplete (HttpSock Sender))
		DownloadError (HttpSock Sender, string ErrorMessage, optional string Param1, optional string Param2))
		DownloadTimeout (HttpSock Sender))
	int	findCacheRecord (int hash))
	int	get (string location))
	HttpCacheObject	getCacheObject (int idx))
	bool	getURLbyId (int id, out string URL))
	bool	isCached (string location))
		PreBeginPlay ()))
		ResolveFailed (HttpSock Sender, string hostname))

CacheList Source code

cache list, each entry is an URL

CacheObjectList Source code

the spawned cache objects

HttpCacheObjectClass Source code

HttpSockClass Source code

Requests Source code

running requests

Options

iCacheLimit Source code

maximum cache size (entries?)

ECacheFailError Source code

Reasons for a failure

EDataOrigin Source code

Hints where the data came from

CacheInfoRecord Source code

records of the cached entries
colidx:

index in the CacheObjectList, volatile

DataSize:

last datazie

Hash:

hash used for record info

LastUpdate:

last update

URL:

the request URL

CacheRequest Source code

OnComplete Source code

Will be called when the operation was completed successfully.

OnCreateSock Source code

Will be called after the HttpSock instance has been created. Use it to set certain variables and delegates for the HttpSock.
Note: You shouldn't set any delegates in the sccket, most will be overwritten anyway.

OnError Source code

Will be called in case of an internal error.

OnFail Source code

failed to complete the request, will be called when everything fails

CacheCleanup Source code

Clean up the cache

createHash Source code

return the hash of the URL

DownloadComplete Source code

DownloadError Source code

DownloadTimeout Source code

findCacheRecord Source code

find an idx using a hash

get Source code

Performs a get request. Returns the ID of the request. This Id can be used in to retrieve the URL in the future

getCacheObject Source code

get\create a CacheObject

getURLbyId Source code

Returns the URL for a certain ID. Result will be false when the ID is no longer valid.

isCached Source code

Returns true when the location is cached

PreBeginPlay Source code

ResolveFailed Source code

defaultproperties
{
    HttpSockClass=class'HttpSock'
    HttpCacheObjectClass=class'HttpCacheObject'
    
    iCacheLimit=524288
}