VizKit  3.3.7
Static Public Member Functions | Private Member Functions
VizKit::VisualNetwork Class Reference

Providing networking functionality. More...

#include <VisualNetwork.h>

List of all members.

Static Public Member Functions

static void dispose (void)
 Disposes resources and allocations of VisualNetwork (VisualDownloadQueue).
static bool addToDownloadQueue (VisualString &aURL, VisualObject *visualObject, const VisualItemIdentifier &identifier)
 Adds an URL to the download queue.
static bool removeDownload (const VisualItemIdentifier &identifier)
 Removes an item from the download queue.
static bool removeDownloadForObject (const VisualItemIdentifier &visualObjectIdentifier)
 Removes an item from the download queue.
static bool startDownloadThreadIfNeeded (void)
 If download items are waiting to be fetched, the download process is started.
static VisualStringcreateNormalizedURLString (const VisualString &str)
 Ensures a normalized URL reference (by escaping special characters).

Private Member Functions

 VisualNetwork ()
 The constructor.
 ~VisualNetwork ()
 The destructor.

Detailed Description

Providing networking functionality.


Constructor & Destructor Documentation

The constructor.

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

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:
aURLThe URL from where to fetch the data.
visualObjectThe object requesting remote data.
identifierIdentifier of the download item.
Returns:
True on success, false on failure.

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

Parameters:
strA 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:
identifierIdentifier 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:
visualObjectIdentifierIdentifier of the object.
Returns:
True on success, false on failure.

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:

Generated on Sun May 3 2015 20:26:31 for VizKit by doxygen 1.8.0