dpyPrinter Namespace Reference

Deepsy Printer namespace that includes the different enums, structs or method signatures that should be used.

Classes

struct  JobInformation
 
class  ListObserver
 List Observer class. More...
 
struct  NVImage
 
struct  PrinterInfo
 Printer Info. More...
 
struct  PrinterLimits
 Printer Limits. More...
 

Typedefs

typedef boost::function< void(const bool &available)> service_availability_handler
 Prototype of the handler function used to monitor service availability. More...
 
typedef boost::function< void(boost::system::error_code error_code)> result_handler_function
 Prototype of the handler function for obtaining a result. More...
 
typedef boost::function< void(boost::system::error_code, std::list< std::string > printers)> print_list_handler
 Prototype of the handler function for getting available printers. More...
 
typedef boost::function< void(boost::system::error_code, std::list< PrintConfig > printerconfigs)> printerconfig_handler_function
 Prototype of the handler function for getting printer configuration. More...
 
typedef boost::function< void(boost::system::error_code, PrinterInfo printerinfo)> printer_info_handler
 Prototype of the handler function for getting available printers. More...
 
typedef boost::function< void(boost::system::error_code, dpyPrinter::JobInformation jobinfo)> job_info_handler
 Prototype of the handler function for getting available printers. More...
 
typedef 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. More...
 
typedef 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. More...
 
typedef 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. More...
 
typedef 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. More...
 
typedef 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. More...
 
typedef 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. More...
 
typedef boost::function< void(boost::system::error_code, int jobid)> print_image_handler
 Prototype of the handler function for printing images. More...
 
typedef boost::function< void(boost::system::error_code, int jobid)> print_html_handler
 Prototype of the handler function for printing from html files. More...
 
typedef 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. More...
 
typedef 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. More...
 

Enumerations

enum  JobStatus {
  UNKNOWN_STATUS = 0, QUEUED = 1, PRINT_OK = 2, ERROR_BEFORE_PRINTING = 3,
  ERROR_WHILE_PRINTING = 4, ERROR_AFTER_PRINTING = 5, JOB_REMOVED = 6
}
 
enum  PrinterType { GENERIC = 0, APSECP2324 = 1, APSECP3324 = 2 }
 Printer types.
 
enum  PrinterStatus { PRINTER_IDLE = 0, PRINTING = 1, PRINTER_ERROR = 2, UPDATING = 4 }
 Possible Printer Status. More...
 
enum  PrinterEvent {
  PAPER_LIMIT = 0, CUTS_LIMIT = 1, END_OF_PAPER = 2, HEAD_TEMPERATURE = 3,
  POWER_SUPPLY = 4, COVER_OPEN = 5, PAPER_JAM = 6, AUTOCUTTER_ERROR = 7
}
 Printer events. More...
 
enum  PaperLevel {
  CRITICAL_PAPER = 1, LOW_PAPER = 2, MEDIUM_PAPER = 3, HIGH_PAPER = 4,
  FULL_PAPER = 5, ERROR_PAPER = 99
}
 Paper level. More...
 
enum  ListEvent { ADDED = 0, REMOVED = 1 }
 
enum  PrintSpeed { ULTRASLOW, SLOW, NORMAL, FAST }
 Print speed value (for SPEED parameter) More...
 
enum  PrintIntensity { LOW, MEDIUM, HIGH }
 Print intensity value (for INTENSITY parameter) More...
 
enum  CutProfile { NONE = 0, PARTIAL = 1, FULL = 2 }
 Cut profile value (for CUT_PROFILE parameter) More...
 
enum  Parameter {
  UNKNOWN = -1, PAPER_WIDTH = 0, TICKET_OFFSET = 1, UPPER_MARGIN = 2,
  LEFT_MARGIN = 3, RIGHT_MARGIN = 4, BOTTOM_MARGIN = 5, INTENSITY = 6,
  CUT_PROFILE = 7, PAPER_ADJ = 8, SPEED = 9
}
 Configuration parameter. More...
 
enum  PaperSensor { PAPER_SENSOR1 = 1, PAPER_SENSOR2 = 2, PAPER_SENSOR3 = 3, PAPER_SENSOR4 = 4 }
 Configuration parameter. More...
 

Typedef Documentation

typedef boost::function<void(boost::system::error_code, std::list<std::pair<int, dpyPrinter::JobInformation>> jobinfolist)> all_job_info_handler
Parameters
error_codeerror code (if any)
jobinfolistlist with every job info
typedef boost::function<void(boost::system::error_code, dpyPrinter::JobInformation jobinfo)> job_info_handler
Parameters
error_codeerror code (if any)
printerinfoinfo of the job
typedef boost::function<void(boost::system::error_code, int jobid, JobStatus status)> job_status_event_handler_function
Parameters
error_codeerror code (if any)
jobidjob id
statusnew job status
typedef boost::function<void(boost::system::error_code, std::string printerId, PaperLevel level)> paper_level_event_handler_function
Parameters
error_codeerror code (if any)
printerIdprinter id
levelpaper level
typedef boost::function<void(boost::system::error_code, int jobid)> print_html_handler
Parameters
error_codeerror code (if any)
jobidid of the job queued
typedef boost::function<void(boost::system::error_code, int jobid)> print_image_handler
Parameters
error_codeerror code (if any)
jobidid of the job queued
typedef boost::function<void(boost::system::error_code, std::list<std::string> printers)> print_list_handler
Parameters
error_codeerror code (if any)
printerslist of printer ids
typedef boost::function<void(boost::system::error_code, std::string printerid, PrinterEvent event, bool active)> printer_event_handler_function
Parameters
error_codeerror code (if any)
printeridprinter id
eventevent in the printer
typedef boost::function<void(boost::system::error_code, std::string printerid, ListEvent event, dpyPrinter::NVImage image)> printer_imagelist_event_handler_function
Parameters
error_codeerror code (if any)
printeridprinter id
eventevent in the printer
imagesimage
typedef boost::function<void(boost::system::error_code, PrinterInfo printerinfo)> printer_info_handler
Parameters
error_codeerror code (if any)
printerinfoinfo of the printer
typedef boost::function<void(boost::system::error_code, std::string printerid, ListEvent event)> printer_list_event_handler_function
Parameters
error_codeerror code (if any)
printeridprinter id
eventin the list (ADDED,REMOVED)
typedef boost::function<void(boost::system::error_code, std::string printerid, PrinterStatus status)> printer_status_event_handler_function
Parameters
error_codeerror code (if any)
printeridprinter id
statusnew printer status
typedef boost::function<void(boost::system::error_code, std::list<PrintConfig> printerconfigs)> printerconfig_handler_function
Parameters
error_codeerror code (if any)
printerconfigslist of printer configurations
typedef boost::function<void(boost::system::error_code, std::vector<dpyPrinter::NVImage> imageslist)> printerimagelist_handler_function
Parameters
error_codeerror code (if any)
imageslistlist of images saved in non-volatile memory
typedef boost::function<void(boost::system::error_code error_code)> result_handler_function
Parameters
error_codeerror code (if any)
typedef boost::function<void(const bool &available)> service_availability_handler
Parameters
availabletrue if the service is available, false otherwise

Enumeration Type Documentation

enum CutProfile
Enumerator
NONE 

No cut.

PARTIAL 

Partial cut.

FULL 

Full cut.

enum JobStatus
Enumerator
UNKNOWN_STATUS 

UNKNOWN.

QUEUED 

QUEUED.

PRINT_OK 

PRINT OK.

ERROR_BEFORE_PRINTING 

ERROR BEFORE PRINTING.

ERROR_WHILE_PRINTING 

ERROR WHILE PRINTING.

ERROR_AFTER_PRINTING 

ERROR AFTER PRINTING.

JOB_REMOVED 

REMOVED.

enum ListEvent
Enumerator
ADDED 

ADDED.

REMOVED 

REMOVED.

enum PaperLevel
Enumerator
CRITICAL_PAPER 

Critical paper level.

LOW_PAPER 

Low paper level.

MEDIUM_PAPER 

Medium paper level.

HIGH_PAPER 

High paper level.

FULL_PAPER 

High paper level.

ERROR_PAPER 

Paper error.

Enumerator
PAPER_SENSOR1 

Sensor 1.

PAPER_SENSOR2 

Sensor 2.

PAPER_SENSOR3 

Sensor 3.

PAPER_SENSOR4 

Sensor 4.

enum Parameter
Enumerator
UNKNOWN 

Unknown.

PAPER_WIDTH 

Paper width.

TICKET_OFFSET 

Ticket offset.

UPPER_MARGIN 

Upper margin.

LEFT_MARGIN 

Left margin.

RIGHT_MARGIN 

Right margin.

BOTTOM_MARGIN 

Bottom margin.

INTENSITY 

Intensity.

CUT_PROFILE 

Cut profile.

PAPER_ADJ 

Paper adjust.

SPEED 

Speed.

Enumerator
PAPER_LIMIT 

Paper limit reached.

CUTS_LIMIT 

Cuts limit reached.

END_OF_PAPER 

End of paper error.

HEAD_TEMPERATURE 

Head temperature error.

POWER_SUPPLY 

Power supply error.

COVER_OPEN 

Cover open error.

PAPER_JAM 

Paper jam error.

AUTOCUTTER_ERROR 

Autocutter error.

Enumerator
PRINTER_IDLE 

Printer OK.

PRINTING 

Printer in use.

PRINTER_ERROR 

Printer error.

UPDATING 

Printer firmware updating.

Enumerator
LOW 

Low intensity.

MEDIUM 

Medium intensity.

HIGH 

High intensity.

enum PrintSpeed
Enumerator
ULTRASLOW 

Ultra slow speed.

SLOW 

Slow speed.

NORMAL 

Normal speed.

FAST 

Fast speed.