olreader

Documentation

Index

• Constants
• type OverlappedCallback
• type OverlappedReader
  • func NewOverlappedReader(cbfn OverlappedCallback, bufsz, count int) (*OverlappedReader, error)
  • func (olr *OverlappedReader) Ioctl(ioControlCode uint32, inBuffer *byte, inBufferSize uint32, outBuffer *byte, ...) (err error)
  • func (olr *OverlappedReader) Open(name string) error
  • func (olr *OverlappedReader) Read() error
  • func (olr *OverlappedReader) Stop()

Constants

const (
	// ERROR_INVALID_PARAMETER this error isn't in the windows package for some reason
	ERROR_INVALID_PARAMETER windows.Errno = 87 //nolint:revive // use windows error naming convention
)

Types

type OverlappedCallback

type OverlappedCallback interface {
	OnData([]uint8)
	OnError(err error)
}

OverlappedCallbackFunc is called every time a read completes. if err is not nil, it will be set to

type OverlappedReader

type OverlappedReader struct {
	// contains filtered or unexported fields
}

OverlappedReader is the manager object for doing overlapped reads for a particular handle

func NewOverlappedReader

func NewOverlappedReader(cbfn OverlappedCallback, bufsz, count int) (*OverlappedReader, error)

func (*OverlappedReader) Ioctl

func (olr *OverlappedReader) Ioctl(ioControlCode uint32, inBuffer *byte, inBufferSize uint32, outBuffer *byte, outBufferSize uint32, bytesReturned *uint32, overlapped *windows.Overlapped) (err error)

Ioctl passes an ioctl() through to the underlying handle

func (*OverlappedReader) Open

func (olr *OverlappedReader) Open(name string) error

func (*OverlappedReader) Read

func (olr *OverlappedReader) Read() error

func (*OverlappedReader) Stop

func (olr *OverlappedReader) Stop()