DiCE API nvidia_logo_transpbg.gif Up
mi::bridge::IClient_job_progress Class Referenceabstract

Provides detailed information about the progress of a Bridge job. More...

#include <ibridge_client.h>

Inheritance diagram for mi::bridge::IClient_job_progress:

Public Member Functions

virtual Client_job_state get_state () const =0
 Returns the state of the job. More...
 
virtual Size get_updated_element_count () const =0
 Returns the number of elements that need to be updated before executing this job. More...
 
virtual Size get_pending_hash_calculation_count () const =0
 Returns the number of elements for which hashes needs to be calculated. More...
 
virtual Size get_pending_cache_status_count () const =0
 Returns the number of cache status requests that the server has not yet replied to. More...
 
virtual Size get_cache_miss_count () const =0
 Returns the total number of cache misses for which data needs to be uploaded. More...
 
virtual Size get_cache_miss_bytes () const =0
 Returns the total amount of bytes to upload for all cache misses. More...
 
virtual Size get_uploaded_cache_miss_count () const =0
 Returns the number of cache misses for which data has been uploaded so far. More...
 
virtual Size get_uploaded_cache_miss_bytes () const =0
 Returns the number of bytes that has been uploaded for the cache misses so far. More...
 
virtual Size get_pending_data_serialization_count () const =0
 Returns the number of elements that have been queued up for serialization. More...
 
virtual const char * get_currently_uploaded_element_name () const =0
 Returns the name of the currently uploaded element or NULL if no element is currently being uploaded. More...
 
virtual Size get_currently_uploaded_element_size () const =0
 Returns the size in bytes of the currently uploaded element or 0 if no element is currently being uploaded. More...
 
virtual Size get_currently_uploaded_element_uploaded_bytes () const =0
 Returns the number of bytes uploaded for the currently uploaded element or 0 if no element is currently being uploaded. More...
 
- Public Member Functions inherited from mi::base::IInterface
virtual Uint32 retain () const =0
 Increments the reference count. More...
 
virtual Uint32 release () const =0
 Decrements the reference count. More...
 
virtual const IInterfaceget_interface (const Uuid &interface_id) const =0
 Acquires a const interface from another. More...
 
template<class T>
const T * get_interface () const
 Acquires a const interface from another. More...
 
virtual IInterfaceget_interface (const Uuid &interface_id)=0
 Acquires a mutable interface from another. More...
 
template<class T>
T * get_interface ()
 Acquires a mutable interface from another. More...
 
virtual Uuid get_iid () const =0
 Returns the interface ID of the most derived interface. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x7f51a745, ... >
typedef Interface_declare< id1, ... > Self
 Own type. More...
 
typedef Uuid_t< id1, ... > IID
 Declares the interface ID (IID) of this interface. More...
 
- Public Types inherited from mi::base::IInterface
typedef Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0> IID
 Declares the interface ID (IID) of this interface. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0x7f51a745, ... >
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 
- Static Public Member Functions inherited from mi::base::IInterface
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface. More...
 

Detailed Description

Provides detailed information about the progress of a Bridge job.

Member Function Documentation

 get_cache_miss_bytes()

virtual Size mi::bridge::IClient_job_progress::get_cache_miss_bytes ( ) const
pure virtual

Returns the total amount of bytes to upload for all cache misses.

The final value is known in the state CLIENT_JOB_UPLOADING and later.

 get_cache_miss_count()

virtual Size mi::bridge::IClient_job_progress::get_cache_miss_count ( ) const
pure virtual

Returns the total number of cache misses for which data needs to be uploaded.

The final value is known in the state CLIENT_JOB_UPLOADING and later.

 get_currently_uploaded_element_name()

virtual const char * mi::bridge::IClient_job_progress::get_currently_uploaded_element_name ( ) const
pure virtual

Returns the name of the currently uploaded element or NULL if no element is currently being uploaded.

 get_currently_uploaded_element_size()

virtual Size mi::bridge::IClient_job_progress::get_currently_uploaded_element_size ( ) const
pure virtual

Returns the size in bytes of the currently uploaded element or 0 if no element is currently being uploaded.

 get_currently_uploaded_element_uploaded_bytes()

virtual Size mi::bridge::IClient_job_progress::get_currently_uploaded_element_uploaded_bytes ( ) const
pure virtual

Returns the number of bytes uploaded for the currently uploaded element or 0 if no element is currently being uploaded.

 get_pending_cache_status_count()

virtual Size mi::bridge::IClient_job_progress::get_pending_cache_status_count ( ) const
pure virtual

Returns the number of cache status requests that the server has not yet replied to.

Can be larger than 0 in states up to and including CLIENT_JOB_QUERYING_CACHE_STATUS and is 0 in all the other states.

 get_pending_data_serialization_count()

virtual Size mi::bridge::IClient_job_progress::get_pending_data_serialization_count ( ) const
pure virtual

Returns the number of elements that have been queued up for serialization.

The data needs to be serialized before it can be sent.

Can be larger than 0 in states up to and including CLIENT_JOB_UPLOADING and is 0 in all later states.

 get_pending_hash_calculation_count()

virtual Size mi::bridge::IClient_job_progress::get_pending_hash_calculation_count ( ) const
pure virtual

Returns the number of elements for which hashes needs to be calculated.

Can be larger than 0 in states up to and including CLIENT_JOB_PREPARING and is 0 in all the other states.

 get_state()

virtual Client_job_state mi::bridge::IClient_job_progress::get_state ( ) const
pure virtual

Returns the state of the job.

See Client_job_state.

 get_updated_element_count()

virtual Size mi::bridge::IClient_job_progress::get_updated_element_count ( ) const
pure virtual

Returns the number of elements that need to be updated before executing this job.

In state CLIENT_JOB_DETECTING_CHANGES this is the number of elements for which changes have been detected so far. In all other states it is the final number of elements that needs to be updated.

 get_uploaded_cache_miss_bytes()

virtual Size mi::bridge::IClient_job_progress::get_uploaded_cache_miss_bytes ( ) const
pure virtual

Returns the number of bytes that has been uploaded for the cache misses so far.

Will be equal to get_cache_miss_bytes() in states CLIENT_JOB_PENDING and later.

 get_uploaded_cache_miss_count()

virtual Size mi::bridge::IClient_job_progress::get_uploaded_cache_miss_count ( ) const
pure virtual

Returns the number of cache misses for which data has been uploaded so far.

Will be equal to get_cache_miss_count() in states CLIENT_JOB_PENDING and later.