caps_cl_notifier Struct Reference

Define notifier callbacks for Printing Coordinator clients. More...

Data Fields
int(*	provider_change )(void *data, caps_identifier pr_id, struct caps_cl_printer_state *pstate)
int(*	job_change )(void *data, caps_identifier pr_id, caps_identifier job_id, struct caps_cl_job_state *jstate, struct caps_job_progression *jprogression)

Detailed Description

The parameters when called:

• the data parameter was defined when registering the notifiers with caps_cl_instance_register()
• the pr_id and job_id refer printers and print jobs
• the pstate points to new printer state information (caps_cl_printer_state)
• the jstate points to new job state information (caps_cl_job_state)
• the jprogressionpoints to new job progression information (caps_job_progression)

For both call back functions:

• return CAPS_NOTIFIER_HANDLED if you have handled this notifier (should be the default)
• return CAPS_NOTIFIER_NOT_YET_HANDLED if you haven't handled this notifier

Since

caps-printing-coordinator-1.1.0

Field Documentation

provider_change

int(* provider_change) (void *data, caps_identifier pr_id, struct caps_cl_printer_state *pstate)

Called if the printer reports a new state about itself. The data parameter here is your own data provided when registering the notifier via caps_cl_instance_register().

The pstate points to the reported current state of this printer.

Attention

The data pstate points to is volatile. You need to copy it.

job_change

int(* job_change) (void *data, caps_identifier pr_id, caps_identifier job_id, struct caps_cl_job_state *jstate, struct caps_job_progression *jprogression)

Called if new state and/or progression info about a job is available. The data parameter here is your own data provided when registering the notifier via caps_cl_instance_register().

If jstate isn't NULL, it points to the new state of this job.

Attention

The data jstate points to is volatile. You need to copy it.

If jprogression isn't NULL, it points to the new progression information of this job.

Attention

The data jprogression points to is volatile. You need to copy it.

---

The documentation for this struct was generated from the following file:

• caps-printing-coordinator/src/libcapsclient/libcapsclient.h