VizKit::VisualNetwork Class Reference

#include <VisualNetwork.h>

List of all members.

Static Public Member Functions
static void	dispose (void)
static bool	addToDownloadQueue (VisualString &aURL, VisualObject *visualObject, const VisualItemIdentifier &identifier)
static bool	removeDownload (const VisualItemIdentifier &identifier)
static bool	removeDownloadForObject (const VisualItemIdentifier &visualObjectIdentifier)
static bool	startDownloadThreadIfNeeded (void)
static VisualString *	createNormalizedURLString (const VisualString &str)
Private Member Functions
	VisualNetwork ()
	~VisualNetwork ()

---

Detailed Description

Providing networking functionality.

---

Constructor & Destructor Documentation

VizKit::VisualNetwork::VisualNetwork

(

)

[private]

The constructor. VisualNetwork is a collection of static methods. Class does not need any instances. Constructor is private and not implemented.

VizKit::VisualNetwork::~VisualNetwork

(

)

[private]

The destructor. VisualNetwork is a collection of static methods. Class does not need any instances. Destructor is private and not implemented.

---

Member Function Documentation

bool VisualNetwork::addToDownloadQueue	(	VisualString &	aURL,
		VisualObject *	visualObject,
		const VisualItemIdentifier &	identifier
	)		[static]

Adds an URL to the download queue.

Parameters:

aURL	The URL from where to fetch the data.
visualObject	The object requesting remote data.
identifier	Identifier of the download item.

Returns:

True on success, false on failure.

VisualString * VisualNetwork::createNormalizedURLString

(

const VisualString &

str

)

[static]

Ensures a normalized URL reference (by escaping special characters).

Parameters:

str	A possibly non-escaped URL string.

Returns:

A normalized URL string.

Remarks:

The caller has to delete the created string.

void VisualNetwork::dispose

(

void

)

[static]

Disposes resources and allocations of VisualNetwork (VisualDownloadQueue).

bool VisualNetwork::removeDownload

(

const VisualItemIdentifier &

identifier

)

[static]

Removes an item from the download queue.

Parameters:

identifier

Identifier of the download item.

Returns:

True on success, false on failure.

bool VisualNetwork::removeDownloadForObject

(

const VisualItemIdentifier &

visualObjectIdentifier

)

[static]

Removes an item from the download queue.

Parameters:

visualObjectIdentifier

Identifier of the object.

Returns:

True on success, false on failure.

bool VisualNetwork::startDownloadThreadIfNeeded

(

void

)

[static]

If download items are waiting to be fetched, the download process is started.

Returns:

True if download process started, false if not.

Remarks:

Download data is fetched in a separate thread.

---

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

• source/Tools/VisualNetwork.h
• source/Tools/VisualNetwork.cpp