LSFutureTask Class Reference

A task object representing an asynchronous operation. More...

#include <lsfuturetask.h>

Inheritance diagram for LSFutureTask:

Public Member Functions
void	abort ()
	Aborts the associated operation. More...
bool	isFinished () const
	Returns whether the associated operation has been finished. More...
int	getProgress () const
	Returns the progress state of the associated operation. More...
LSResult::Result	getResult () const
	Gets the result code of the associated operation. More...

Additional Inherited Members
Protected Member Functions inherited from LSRefType
void	ref () const
	Increments the internal reference counter. More...
void	unref () const
	Decrements the internal reference counter. More...

Detailed Description

A task object representing an asynchronous operation.

Version

SCENE API Version 2.0.0.

Member Function Documentation

abort()

void abort

(

)

Aborts the associated operation.

Version

SCENE API Version 2.0.0.

isFinished()

bool isFinished

(

)

const

Returns whether the associated operation has been finished.

Returns

true if the operation has been finished, false otherwise.

Version

SCENE API Version 2.0.0.

getProgress()

int getProgress

(

)

const

Returns the progress state of the associated operation.

Returns

The progress state of the associated operation in percent.

Version

SCENE API Version 2.0.0.

getResult()

LSResult::Result getResult

(

)

const

Gets the result code of the associated operation.

Blocks until the result is available.

Returns

The result code of the associated operation.

Version

SCENE API Version 2.0.0.