printerApi.h
Go to the documentation of this file.
42 typedef boost::function<void(boost::system::error_code, std::list<std::string> printers)> print_list_handler;
49 typedef boost::function<void(boost::system::error_code, std::list<PrintConfig> printerconfigs)> printerconfig_handler_function;
56 typedef boost::function<void(boost::system::error_code, PrinterInfo printerinfo)> printer_info_handler;
63 typedef boost::function<void(boost::system::error_code, dpyPrinter::JobInformation jobinfo)> job_info_handler;
70 typedef boost::function<void(boost::system::error_code, std::list<std::pair<int, dpyPrinter::JobInformation>> jobinfolist)> all_job_info_handler;
78 typedef boost::function<void(boost::system::error_code, std::string printerid, ListEvent event)> printer_list_event_handler_function;
86 typedef boost::function<void(boost::system::error_code, int jobid, JobStatus status)> job_status_event_handler_function;
94 typedef boost::function<void(boost::system::error_code, std::string printerId, PaperLevel level)> paper_level_event_handler_function;
102 typedef boost::function<void(boost::system::error_code, std::string printerid, PrinterEvent event, bool active)> printer_event_handler_function;
110 typedef boost::function<void(boost::system::error_code, std::string printerid, PrinterStatus status)> printer_status_event_handler_function;
131 typedef boost::function<void(boost::system::error_code, std::vector<dpyPrinter::NVImage> imageslist)> printerimagelist_handler_function;
140 typedef boost::function<void(boost::system::error_code, std::string printerid, ListEvent event, dpyPrinter::NVImage image)> printer_imagelist_event_handler_function;
185 void asyncGetPrinterInfo(dpyPrinter::printer_info_handler handler, const std::string& printerid);
194 void asyncPrintImage(dpyPrinter::print_image_handler handler, const std::string& printerid, std::string image_path, std::list<PrintConfig> configs);
203 void asyncPrintHtml(dpyPrinter::print_html_handler handler, const std::string& printerid, std::string html_path, std::list<PrintConfig> configs);
231 void asyncForcePrinterUpgrade(dpyPrinter::result_handler_function handler, const std::string& printerid);
239 void asyncSetDefaultConfiguration(dpyPrinter::result_handler_function handler, const std::string& printerid, PrintConfig printConfig);
246 void asyncGetDefaultConfiguration(dpyPrinter::printerconfig_handler_function handler, const std::string& printerid);
253 void asyncPrintTestTicket(dpyPrinter::result_handler_function handler, const std::string& printerid);
262 void asyncStoreNVImage(dpyPrinter::result_handler_function handler, const std::string& printerid, const std::string &image_path, int slotid);
270 void asyncDeleteNVImage(dpyPrinter::result_handler_function handler, const std::string& printerid, int slotid);
277 void asyncGetNVImageList(dpyPrinter::printerimagelist_handler_function handler, const std::string& printerid);
286 void asyncPrintNVImage(dpyPrinter::print_image_handler handler, const std::string& printerid, int slotid, std::list<PrintConfig> configs);
Definition: iPrinter.h:76
void asyncSetDefaultConfiguration(dpyPrinter::result_handler_function handler, const std::string &printerid, PrintConfig printConfig)
Modifies a printer config.
void asyncPrintHtml(dpyPrinter::print_html_handler handler, const std::string &printerid, std::string html_path, std::list< PrintConfig > configs)
Method which requests to print from a html with a given configuration. If sucessful,...
void asyncPrintImage(dpyPrinter::print_image_handler handler, const std::string &printerid, std::string image_path, std::list< PrintConfig > configs)
Method which requests to print an image with a given configuration. If sucessful, this will add a job...
void asyncGetJobInfo(dpyPrinter::job_info_handler handler, int jobid)
Gets job information.
void asyncGetDefaultConfiguration(dpyPrinter::printerconfig_handler_function handler, const std::string &printerid)
Gets printer config.
void asyncGetAllJobInfo(dpyPrinter::all_job_info_handler handler, const std::string &printerid)
Gets every job information.
boost::function< void(boost::system::error_code, std::string printerid, ListEvent event)> printer_list_event_handler_function
Prototype of the handler function for subscribing to list events.
Definition: printerApi.h:78
boost::function< void(boost::system::error_code, std::string printerid, ListEvent event, dpyPrinter::NVImage image)> printer_imagelist_event_handler_function
Prototype of the handler function for subscribing to non-volatile memory images events.
Definition: printerApi.h:140
void paperLevelEvent_S(dpyPrinter::paper_level_event_handler_function handler)
Subscribes to paper events.
boost::function< void(boost::system::error_code error_code)> result_handler_function
Prototype of the handler function for obtaining a result.
Definition: printerApi.h:35
void NVImageListEvent_S(dpyPrinter::printer_imagelist_event_handler_function handler)
Subscribes to non-volatile memory images list events.
void asyncPrintNVImage(dpyPrinter::print_image_handler handler, const std::string &printerid, int slotid, std::list< PrintConfig > configs)
Prints the image stored in the non-volatile memory area of the printer.
Deepsy Printer namespace that includes the different enums, structs or method signatures that should ...
Definition: printerApi.h:13
boost::function< void(boost::system::error_code, std::string printerId, PaperLevel level)> paper_level_event_handler_function
Prototype of the handler function for subscribing to paper level events.
Definition: printerApi.h:94
void asyncGetPrinters(dpyPrinter::print_list_handler handler)
Method which requests available printers.
void printerJobStatusEvent_S(dpyPrinter::job_status_event_handler_function handler)
Subscribes to job status events.
boost::function< void(boost::system::error_code, std::string printerid, PrinterEvent event, bool active)> printer_event_handler_function
Prototype of the handler function for subscribing to printer events.
Definition: printerApi.h:102
void asyncGetPrinterInfo(dpyPrinter::printer_info_handler handler, const std::string &printerid)
Gets printer info.
void asyncPrintTestTicket(dpyPrinter::result_handler_function handler, const std::string &printerid)
Prints a test ticket.
void asyncDeleteJob(dpyPrinter::result_handler_function handler, int jobid)
Deletes a job from the list.
boost::function< void(boost::system::error_code, int jobid)> print_image_handler
Prototype of the handler function for printing images.
Definition: printerApi.h:117
void printerEvent_S(dpyPrinter::printer_event_handler_function handler)
Subscribes to printer events.
void asyncDeleteNVImage(dpyPrinter::result_handler_function handler, const std::string &printerid, int slotid)
Deletes image stored in non-volatile memory.
boost::function< void(boost::system::error_code, std::vector< dpyPrinter::NVImage > imageslist)> printerimagelist_handler_function
Prototype of the handler function for getting list of images saved in non-volatile memory.
Definition: printerApi.h:131
boost::function< void(boost::system::error_code, std::string printerid, PrinterStatus status)> printer_status_event_handler_function
Prototype of the handler function for subscribing to printer status events.
Definition: printerApi.h:110
boost::function< void(boost::system::error_code, std::list< std::pair< int, dpyPrinter::JobInformation >> jobinfolist)> all_job_info_handler
Prototype of the handler function for getting available printers.
Definition: printerApi.h:70
void asyncGetNVImageList(dpyPrinter::printerimagelist_handler_function handler, const std::string &printerid)
Gets list of images stored in non-volatile memory.
boost::function< void(const bool &available)> service_availability_handler
Prototype of the handler function used to monitor service availability.
Definition: printerApi.h:29
void asyncStoreNVImage(dpyPrinter::result_handler_function handler, const std::string &printerid, const std::string &image_path, int slotid)
Stores image in non-volatile memory.
void printerListEvent_S(dpyPrinter::printer_list_event_handler_function handler)
Subscribes to printer list events.
void asyncForcePrinterUpgrade(dpyPrinter::result_handler_function handler, const std::string &printerid)
Forces upgrade of printer firmware.
boost::function< void(boost::system::error_code, std::list< std::string > printers)> print_list_handler
Prototype of the handler function for getting available printers.
Definition: printerApi.h:42
boost::function< void(boost::system::error_code, int jobid, JobStatus status)> job_status_event_handler_function
Prototype of the handler function for subscribing to job status events.
Definition: printerApi.h:86
void printerStatusEvent_S(dpyPrinter::printer_status_event_handler_function handler)
Subscribes to printer status events.
boost::function< void(boost::system::error_code, PrinterInfo printerinfo)> printer_info_handler
Prototype of the handler function for getting available printers.
Definition: printerApi.h:56
boost::function< void(boost::system::error_code, std::list< PrintConfig > printerconfigs)> printerconfig_handler_function
Prototype of the handler function for getting printer configuration.
Definition: printerApi.h:49
Definition: iJob.h:27
boost::function< void(boost::system::error_code, dpyPrinter::JobInformation jobinfo)> job_info_handler
Prototype of the handler function for getting available printers.
Definition: printerApi.h:63
boost::function< void(boost::system::error_code, int jobid)> print_html_handler
Prototype of the handler function for printing from html files.
Definition: printerApi.h:124