port.go

package winprint

import (
	"fmt"
	"sync"
	"syscall"

	"github.com/gentlemanautomaton/winprint/accessoptions"
	"github.com/gentlemanautomaton/winprint/accessrights"
	"github.com/gentlemanautomaton/winprint/objname"
	"github.com/gentlemanautomaton/winprint/spoolerapi"
)

// Port is an open connection to a printer port.
type Port struct {
	mutex  sync.RWMutex
	handle syscall.Handle
}

// OpenPort opens a connection to a printer with the given name.
//
// It is the caller's responsibility to close the printer object when finished
// with it.
func OpenPort(name string, desiredAccess accessrights.Mask, options ...accessoptions.Option) (*Port, error) {
	// Check to make sure we were provided a simple printer name
	if t := objname.DetectType(name); t != objname.Unspecified {
		return nil, fmt.Errorf("winprint.OpenPort was unexpectedly provided a %s name", t)
	}

	handle, err := spoolerapi.Open(name, desiredAccess, options...)
	if err != nil {
		return nil, err
	}
	return &Port{handle: handle}, nil
}

// Close releases all resources and system handles associated with p.
func (p *Port) Close() error {
	p.mutex.Lock()
	defer p.mutex.Unlock()
	return spoolerapi.Close(p.handle)
}

// Delete requests that the port p be deleted. The deletion will not take
// place until all existing print jobs have finished and p is closed.
func (p *Port) Delete() error {
	p.mutex.Lock()
	defer p.mutex.Unlock()
	// FIXME: Ask the port monitor to delete the port?
	return spoolerapi.DeletePrinter(p.handle)
}