Versions in this module Expand all Collapse all v1 v1.6.2 Nov 18, 2022 v1.6.1 Nov 17, 2022 Changes in this version + const AttributeCharset + const AttributeCopies + const AttributeDeviceURI + const AttributeDocumentFormat + const AttributeDocumentName + const AttributeDocumentNumber + const AttributeDocumentState + const AttributeFinishings + const AttributeFirstJobID + const AttributeHoldJobUntil + const AttributeJobHoldUntil + const AttributeJobID + const AttributeJobKilobyteOctets + const AttributeJobMediaProgress + const AttributeJobName + const AttributeJobOriginatingUserName + const AttributeJobPrinterURI + const AttributeJobPriority + const AttributeJobSheets + const AttributeJobState + const AttributeJobStateReason + const AttributeJobURI + const AttributeLastDocument + const AttributeLimit + const AttributeMedia + const AttributeMediaCol + const AttributeMemberNames + const AttributeMemberURIs + const AttributeMyJobs + const AttributeNaturalLanguage + const AttributeNumberOfDocuments + const AttributeNumberUp + const AttributeOrientationRequested + const AttributeOutputOrder + const AttributePPDMakeAndModel + const AttributePPDName + const AttributePrintQuality + const AttributePrinterErrorPolicy + const AttributePrinterInfo + const AttributePrinterIsAcceptingJobs + const AttributePrinterIsShared + const AttributePrinterLocation + const AttributePrinterMakeAndModel + const AttributePrinterName + const AttributePrinterResolution + const AttributePrinterState + const AttributePrinterStateMessage + const AttributePrinterStateReasons + const AttributePrinterType + const AttributePrinterURI + const AttributePrinterUriSupported + const AttributePurgeJobs + const AttributeRequestedAttributes + const AttributeRequestingUserName + const AttributeStatusMessage + const AttributeWhichJobs + const Charset + const CharsetLanguage + const ContentTypeIPP + const DefaultJobPriority + const DefaultRequestRetryLimit + const DocumentStateAborted + const DocumentStateCanceled + const DocumentStateCompleted + const DocumentStatePending + const DocumentStateProcessing + const ErrorPolicyAbortJob + const ErrorPolicyRetryCurrentJob + const ErrorPolicyRetryJob + const ErrorPolicyStopPrinter + const JobStateAborted + const JobStateCanceled + const JobStateCompleted + const JobStateFilterAll + const JobStateFilterCompleted + const JobStateFilterNotCompleted + const JobStateHeld + const JobStatePending + const JobStateProcessing + const JobStateStopped + const MimeTypeOctetStream + const MimeTypePostscript + const OperationAcknowledgeDocument + const OperationAcknowledgeIdentifyPrinter + const OperationAcknowledgeJob + const OperationActivatePrinter + const OperationAddDocumentImages + const OperationAllocatePrinterResources + const OperationCancelCurrentJob + const OperationCancelDocument + const OperationCancelJob + const OperationCancelJobs + const OperationCancelMyJobs + const OperationCancelResource + const OperationCancelSubscription + const OperationCloseJob + const OperationCreateJob + const OperationCreateJobSubscriptions + const OperationCreatePrinter + const OperationCreatePrinterSubscriptions + const OperationCreateResource + const OperationCreateResourceSubscriptions + const OperationCreateSystemSubscriptions + const OperationCupsAcceptJobs + const OperationCupsAddModifyClass + const OperationCupsAddModifyPrinter + const OperationCupsAuthenticateJob + const OperationCupsCreateLocalPrinter + const OperationCupsDeleteClass + const OperationCupsDeletePrinter + const OperationCupsGetClasses + const OperationCupsGetDefault + const OperationCupsGetDevices + const OperationCupsGetDocument + const OperationCupsGetPPDs + const OperationCupsGetPpd + const OperationCupsGetPrinters + const OperationCupsInvalid + const OperationCupsMoveJob + const OperationCupsNone + const OperationCupsRejectJobs + const OperationCupsSetDefault + const OperationDeactivatePrinter + const OperationDeallocatePrinterResources + const OperationDeleteDocument + const OperationDeletePrinter + const OperationDeregisterOutputDevice + const OperationDisableAllPrinters + const OperationDisablePrinter + const OperationEnableAllPrinters + const OperationEnablePrinter + const OperationFetchDocument + const OperationFetchJob + const OperationGetDocumentAttributes + const OperationGetDocuments + const OperationGetJobAttributes + const OperationGetJobs + const OperationGetNextDocumentData + const OperationGetNotifications + const OperationGetOutputDeviceAttributes + const OperationGetPrintSupportFiles + const OperationGetPrinterAttributes + const OperationGetPrinterSupportedValues + const OperationGetPrinters + const OperationGetResourceAttributes + const OperationGetResourceData + const OperationGetResources + const OperationGetSubscriptionAttributes + const OperationGetSubscriptions + const OperationGetSystemAttributes + const OperationGetSystemSupportedValues + const OperationHoldJob + const OperationHoldNewJobs + const OperationIdentifyPrinter + const OperationInstallResource + const OperationOperationPromoteJob + const OperationPauseAllPrinters + const OperationPauseAllPrintersAfterCurrentJob + const OperationPausePrinter + const OperationPausePrinterAfterCurrentJob + const OperationPrintJob + const OperationPrintUri + const OperationPrivate + const OperationPurgeJobs + const OperationRegisterOutputDevice + const OperationReleaseHeldNewJobs + const OperationReleaseJob + const OperationRenewSubscription + const OperationReprocessJob + const OperationRestartJob + const OperationRestartPrinter + const OperationRestartSystem + const OperationResubmitJob + const OperationResumeAllPrinters + const OperationResumeJob + const OperationResumePrinter + const OperationScheduleJobAfter + const OperationSendDocument + const OperationSendNotifications + const OperationSendResourceData + const OperationSendUri + const OperationSetDocumentAttributes + const OperationSetJobAttributes + const OperationSetPrinterAttributes + const OperationSetResourceAttributes + const OperationSetSystemAttributes + const OperationShutdownAllPrinter + const OperationShutdownOnePrinter + const OperationShutdownPrinter + const OperationStartupAllPrinters + const OperationStartupOnePrinter + const OperationStartupPrinter + const OperationSuspendCurrentJob + const OperationUpdateActiveJobs + const OperationUpdateDocumentStatus + const OperationUpdateJobStatus + const OperationUpdateOutputDeviceAttributes + const OperationValidateDocument + const OperationValidateJob + const PrinterStateIdle + const PrinterStateProcessing + const PrinterStateStopped + const ProtocolVersionMajor + const ProtocolVersionMinor + const StatusCupsInvalid + const StatusCupsSeeOther + const StatusErrorAccountAuthorizationFailed + const StatusErrorAccountClosed + const StatusErrorAccountInfoNeeded + const StatusErrorAccountLimitReached + const StatusErrorAttributesNotSettable + const StatusErrorAttributesOrValues + const StatusErrorBadRequest + const StatusErrorBusy + const StatusErrorCharset + const StatusErrorCompressionError + const StatusErrorConflicting + const StatusErrorCupsAccountAuthorizationFailed + const StatusErrorCupsAccountClosed + const StatusErrorCupsAccountInfoNeeded + const StatusErrorCupsAccountLimitReached + const StatusErrorCupsAuthenticationCanceled + const StatusErrorCupsPki + const StatusErrorCupsUpgradeRequired + const StatusErrorDevice + const StatusErrorDocumentAccess + const StatusErrorDocumentFormatError + const StatusErrorDocumentFormatNotSupported + const StatusErrorDocumentPassword + const StatusErrorDocumentPermission + const StatusErrorDocumentSecurity + const StatusErrorDocumentUnprintable + const StatusErrorForbidden + const StatusErrorGone + const StatusErrorIgnoredAllNotifications + const StatusErrorIgnoredAllSubscriptions + const StatusErrorInternal + const StatusErrorJobCanceled + const StatusErrorMultipleJobsNotSupported + const StatusErrorNotAcceptingJobs + const StatusErrorNotAuthenticated + const StatusErrorNotAuthorized + const StatusErrorNotFetchable + const StatusErrorNotFound + const StatusErrorNotPossible + const StatusErrorOperationNotSupported + const StatusErrorPrintSupportFileNotFound + const StatusErrorPrinterIsDeactivated + const StatusErrorRequestEntity + const StatusErrorRequestValue + const StatusErrorServiceUnavailable + const StatusErrorTemporary + const StatusErrorTimeout + const StatusErrorTooManyDocuments + const StatusErrorTooManyJobs + const StatusErrorTooManySubscriptions + const StatusErrorUriScheme + const StatusErrorVersionNotSupported + const StatusOk + const StatusOkButCancelSubscription + const StatusOkConflicting + const StatusOkEventsComplete + const StatusOkIgnoredNotifications + const StatusOkIgnoredOrSubstituted + const StatusOkIgnoredSubscriptions + const StatusOkTooManyEvents + const StatusRedirectionOtherSite + const TagAdminDefine + const TagBeginCollection + const TagBoolean + const TagCharset + const TagCupsInvalid + const TagDate + const TagDefault + const TagDeleteAttr + const TagDocument + const TagEnd + const TagEndCollection + const TagEnum + const TagEventNotification + const TagExtension + const TagInteger + const TagJob + const TagKeyword + const TagLanguage + const TagMemberName + const TagMimeType + const TagName + const TagNameLang + const TagNoValue + const TagNotSettable + const TagOperation + const TagPrinter + const TagRange + const TagReservedString + const TagResolution + const TagResource + const TagString + const TagSubscription + const TagSystem + const TagText + const TagTextLang + const TagUnknown + const TagUnsupportedGroup + const TagUnsupportedValue + const TagUri + const TagUriScheme + const TagZero + var AttributeTagMapping = map[string]int8 + var CertNotFoundError = errors.New("unable to locate CUPS certificate") + var DefaultCertSearchPaths = []string + var DefaultClassAttributes = []string + var DefaultJobAttributes = []string + var DefaultPrinterAttributes = []string + var DefaultSocketSearchPaths = []string + var SocketNotFoundError = errors.New("unable to locate CUPS socket") + func IsNotExistsError(err error) bool + type Adapter interface + GetHttpUri func(namespace string, object interface{}) string + SendRequest func(url string, req *Request, additionalResponseData io.Writer) (*Response, error) + TestConnection func() error + type Attribute struct + Name string + Tag int8 + Value interface{} + type AttributeDecoder struct + func NewAttributeDecoder(r io.Reader) *AttributeDecoder + func (d *AttributeDecoder) Decode(tag int8) (*Attribute, error) + type AttributeEncoder struct + func NewAttributeEncoder(w io.Writer) *AttributeEncoder + func (e *AttributeEncoder) Encode(attribute string, value interface{}) error + type Attributes map[string][]Attribute + type CUPSClient struct + func NewCUPSClient(host string, port int, username, password string, useTLS bool) *CUPSClient + func NewCUPSClientWithAdapter(username string, adapter Adapter) *CUPSClient + func (c *CUPSClient) AcceptJobs(printer string) error + func (c *CUPSClient) AddPrinterToClass(class, printer string) error + func (c *CUPSClient) CreatePrinter(name, deviceURI, ppd string, shared bool, errorPolicy string, ...) error + func (c *CUPSClient) DeleteClass(class string) error + func (c *CUPSClient) DeletePrinter(printer string) error + func (c *CUPSClient) DeletePrinterFromClass(class, printer string) error + func (c *CUPSClient) GetClasses(attributes []string) (map[string]Attributes, error) + func (c *CUPSClient) GetDevices() (map[string]Attributes, error) + func (c *CUPSClient) GetPPDs() (map[string]Attributes, error) + func (c *CUPSClient) GetPrinters(attributes []string) (map[string]Attributes, error) + func (c *CUPSClient) MoveAllJob(srcPrinter, destPrinter string) error + func (c *CUPSClient) MoveJob(jobID int, destPrinter string) error + func (c *CUPSClient) PrintTestPage(printer string) (int, error) + func (c *CUPSClient) RejectJobs(printer string) error + func (c *CUPSClient) SetPrinterDeviceURI(printer, deviceURI string) error + func (c *CUPSClient) SetPrinterErrorPolicy(printer string, errorPolicy string) error + func (c *CUPSClient) SetPrinterInformation(printer, information string) error + func (c *CUPSClient) SetPrinterIsShared(printer string, shared bool) error + func (c *CUPSClient) SetPrinterLocation(printer, location string) error + func (c *CUPSClient) SetPrinterPPD(printer, ppd string) error + type Document struct + Document io.Reader + MimeType string + Name string + Size int + type HTTPError struct + Code int + func (e HTTPError) Error() string + type HttpAdapter struct + func NewHttpAdapter(host string, port int, username, password string, useTLS bool) *HttpAdapter + func (h *HttpAdapter) GetHttpUri(namespace string, object interface{}) string + func (h *HttpAdapter) SendRequest(url string, req *Request, additionalResponseData io.Writer) (*Response, error) + func (h *HttpAdapter) TestConnection() error + type IPPClient struct + func NewIPPClient(host string, port int, username, password string, useTLS bool) *IPPClient + func NewIPPClientWithAdapter(username string, adapter Adapter) *IPPClient + func (c *IPPClient) CancelAllJob(printer string, purge bool) error + func (c *IPPClient) CancelJob(jobID int, purge bool) error + func (c *IPPClient) GetJobAttributes(jobID int, attributes []string) (Attributes, error) + func (c *IPPClient) GetJobs(printer, class string, whichJobs string, myJobs bool, firstJobId, limit int, ...) (map[int]Attributes, error) + func (c *IPPClient) GetPrinterAttributes(printer string, attributes []string) (Attributes, error) + func (c *IPPClient) HoldJobUntil(jobID int, holdUntil string) error + func (c *IPPClient) PausePrinter(printer string) error + func (c *IPPClient) PrintDocuments(docs []Document, printer string, jobAttributes map[string]interface{}) (int, error) + func (c *IPPClient) PrintFile(filePath, printer string, jobAttributes map[string]interface{}) (int, error) + func (c *IPPClient) PrintJob(doc Document, printer string, jobAttributes map[string]interface{}) (int, error) + func (c *IPPClient) RestartJob(jobID int) error + func (c *IPPClient) ResumePrinter(printer string) error + func (c *IPPClient) SendRequest(url string, req *Request, additionalResponseData io.Writer) (*Response, error) + func (c *IPPClient) TestConnection() error + type IPPError struct + Message string + Status int16 + func (e IPPError) Error() string + type Request struct + File io.Reader + FileSize int + JobAttributes map[string]interface{} + Operation int16 + OperationAttributes map[string]interface{} + PrinterAttributes map[string]interface{} + ProtocolVersionMajor int8 + ProtocolVersionMinor int8 + RequestId int32 + func NewRequest(op int16, reqID int32) *Request + func (r *Request) Encode() ([]byte, error) + type RequestDecoder struct + func NewRequestDecoder(r io.Reader) *RequestDecoder + func (d *RequestDecoder) Decode(data io.Writer) (*Request, error) + type Resolution struct + Depth int8 + Height int32 + Width int32 + type Response struct + JobAttributes []Attributes + OperationAttributes Attributes + PrinterAttributes []Attributes + ProtocolVersionMajor int8 + ProtocolVersionMinor int8 + RequestId int32 + StatusCode int16 + func NewResponse(statusCode int16, reqID int32) *Response + func ParseControlFile(jobID int, spoolDirectory string) (*Response, error) + func (r *Response) CheckForErrors() error + func (r *Response) Encode() ([]byte, error) + type ResponseDecoder struct + func NewResponseDecoder(r io.Reader) *ResponseDecoder + func (d *ResponseDecoder) Decode(data io.Writer) (*Response, error) + type SocketAdapter struct + CertSearchPaths []string + RequestRetryLimit int + SocketSearchPaths []string + func NewSocketAdapter(host string, useTLS bool) *SocketAdapter + func (h *SocketAdapter) GetCert() (string, error) + func (h *SocketAdapter) GetHttpUri(namespace string, object interface{}) string + func (h *SocketAdapter) GetSocket() (string, error) + func (h *SocketAdapter) SendRequest(url string, r *Request, additionalData io.Writer) (*Response, error) + func (h *SocketAdapter) TestConnection() error