InfdProgressRequest

InfdProgressRequest — Watch progress of node exploration

Stability Level

Unstable, unless otherwise indicated

Synopsis

#include <libinfinity/server/infd-progress-request.h>

                    InfdProgressRequest;
struct              InfdProgressRequestClass;
void                infd_progress_request_initiated     (InfdProgressRequest *request,
                                                         guint total);
void                infd_progress_request_progress      (InfdProgressRequest *request);

Object Hierarchy

  GObject
   +----InfdRequest
         +----InfdProgressRequest

Implemented Interfaces

InfdProgressRequest implements InfRequest.

Properties

  "current"                  guint                 : Read
  "total"                    guint                 : Read

Description

This class represents a request which consists of multiple steps and for which progress on the overall operation is reported.

Details

InfdProgressRequest

typedef struct _InfdProgressRequest InfdProgressRequest;

InfdProgressRequest is an opaque data type. You should only access it via the public API functions.


struct InfdProgressRequestClass

struct InfdProgressRequestClass {
};

This structure does not contain any public fields.


infd_progress_request_initiated ()

void                infd_progress_request_initiated     (InfdProgressRequest *request,
                                                         guint total);

Initiates the request. A progress request is considered initiated as soon as the total number of operations is known.

request :

A InfdProgressRequest.

total :

The total number of operations.

infd_progress_request_progress ()

void                infd_progress_request_progress      (InfdProgressRequest *request);

Indicates that one more operation has been finished and changes the "current" property accordingly.

request :

A InfdProgressRequest.

Property Details

The "current" property

  "current"                  guint                 : Read

The current number of finished operations.

Default value: 0


The "total" property

  "total"                    guint                 : Read

The total number of operations.

Default value: 0

See Also

InfRequest, InfdRequest, InfdDirectory