fCraft.Updater Class Reference

Checks for updates, and keeps track of current version/revision. More...

Collaboration diagram for fCraft.Updater:

Static Public Member Functions
static UpdaterResult	CheckForUpdates ()
	Checks fCraft.net for updated versions of fCraft.

Public Attributes
const string	LatestStable = "0.638_r1886"
	The latest stable branch/version of fCraft.

Static Public Attributes
static readonly ReleaseInfo	CurrentRelease
	The current release information of this version/revision.

Properties
static string	UserAgent [get, set]
	User-agent value used for HTTP requests (heartbeat, updater, external IP check, etc). Defaults to "fCraft" + VersionString of the current release.
static string	UpdateUri [get, set]
	Url to update fCraft from. Use "{0}" as a placeholder for CurrentRelease.Version.Revision
static TimeSpan	UpdateCheckTimeout [get, set]
	Amount of time in milliseconds before the updater will consider the connection dead. Default: 4000ms
static bool	RunAtShutdown [get, set]
	Whether or not the update installer (UpdateInstaller.exe) should run at shutdown.

Events
static EventHandler < CheckingForUpdatesEventArgs >	CheckingForUpdates
	Occurs when fCraft is about to check for updates (cancelable). The update Url may be overridden.
static EventHandler < CheckedForUpdatesEventArgs >	CheckedForUpdates
	Occurs when fCraft has just checked for updates.

Detailed Description

Checks for updates, and keeps track of current version/revision.

Member Function Documentation

static UpdaterResult fCraft.Updater.CheckForUpdates ( )

static

Checks fCraft.net for updated versions of fCraft.

Member Data Documentation

readonly ReleaseInfo fCraft.Updater.CurrentRelease

static

Initial value:

= new ReleaseInfo(
            638,
            1886,
            new DateTime( 2012, 11, 30, 1, 50, 0, DateTimeKind.Utc ),
            "", "",
            ReleaseFlags.Feature | ReleaseFlags.Bugfix



            )

The current release information of this version/revision.

const string fCraft.Updater.LatestStable = "0.638_r1886"

The latest stable branch/version of fCraft.

Property Documentation

bool fCraft.Updater.RunAtShutdown

staticgetset

Whether or not the update installer (UpdateInstaller.exe) should run at shutdown.

TimeSpan fCraft.Updater.UpdateCheckTimeout

staticgetset

Amount of time in milliseconds before the updater will consider the connection dead. Default: 4000ms

string fCraft.Updater.UpdateUri

staticgetset

Url to update fCraft from. Use "{0}" as a placeholder for CurrentRelease.Version.Revision

string fCraft.Updater.UserAgent

staticgetset

User-agent value used for HTTP requests (heartbeat, updater, external IP check, etc). Defaults to "fCraft" + VersionString of the current release.

Event Documentation

EventHandler<CheckedForUpdatesEventArgs> fCraft.Updater.CheckedForUpdates

static

Occurs when fCraft has just checked for updates.

EventHandler<CheckingForUpdatesEventArgs> fCraft.Updater.CheckingForUpdates

static

Occurs when fCraft is about to check for updates (cancelable). The update Url may be overridden.

---

The documentation for this class was generated from the following file:

• fCraft/Utils/Updater.cs