utils

Documentation

Overview

Package inotify implements a wrapper for the Linux inotify system.

Example:

watcher, err := inotify.NewWatcher()
if err != nil {
    log.Fatal(err)
}
err = watcher.Watch("/tmp")
if err != nil {
    log.Fatal(err)
}
for {
    select {
    case ev := <-watcher.Event:
        log.Println("event:", ev)
    case err := <-watcher.Error:
        log.Println("error:", err)
    }
}

Index

• Constants
• func AtomReadBuffer(reader io.Reader, size int) ([]byte, error)
• func AtomReadInt16(reader io.Reader) (int, error)
• func AtomReadInt24(reader io.Reader) (int, error)
• func AtomReadInt32(reader io.Reader) (int, error)
• func AtomReadInt64(reader io.Reader) (int64, error)
• func AtomReadInt8(reader io.Reader) (int, error)
• func AtomReadTag(reader io.Reader) (string, error)
• func BuildAtom(tag string, content []byte) ([]byte, error)
• func BuildEmptyAtom(tag string, size int) ([]byte, error)
• func CurrentOffset(reader io.ReadSeeker) (int, error)
• func DisplayMemStats()
• func FileExist(filename string) bool
• func IsDirectory(path string) bool
• func ParseURL(pattern string, path string, params *map[string]string) bool
• func ReadAtomHeader(reader io.ReadSeeker, res *int) (string, error)
• func RemoveExtension(filename string) string
• type Event
  • func (e *Event) String() string
• type Queue
  • func (s *Queue) Clear()
  • func (s *Queue) Empty() bool
  • func (s *Queue) Pop() interface{}
  • func (s *Queue) Push(elms ...interface{})
  • func (s *Queue) Size() int
• type Watcher
  • func NewWatcher() (*Watcher, error)
  • func (w *Watcher) AddWatch(path string, flags uint32) error
  • func (w *Watcher) Close() error
  • func (w *Watcher) RemoveWatch(path string) error
  • func (w *Watcher) Watch(path string) error

Constants

const (

	// Options for AddWatch
	IN_DONT_FOLLOW uint32 = syscall.IN_DONT_FOLLOW
	IN_ONESHOT     uint32 = syscall.IN_ONESHOT
	IN_ONLYDIR     uint32 = syscall.IN_ONLYDIR

	// Events
	IN_ACCESS        uint32 = syscall.IN_ACCESS
	IN_ALL_EVENTS    uint32 = syscall.IN_ALL_EVENTS
	IN_ATTRIB        uint32 = syscall.IN_ATTRIB
	IN_CLOSE         uint32 = syscall.IN_CLOSE
	IN_CLOSE_NOWRITE uint32 = syscall.IN_CLOSE_NOWRITE
	IN_CLOSE_WRITE   uint32 = syscall.IN_CLOSE_WRITE
	IN_CREATE        uint32 = syscall.IN_CREATE
	IN_DELETE        uint32 = syscall.IN_DELETE
	IN_DELETE_SELF   uint32 = syscall.IN_DELETE_SELF
	IN_MODIFY        uint32 = syscall.IN_MODIFY
	IN_MOVE          uint32 = syscall.IN_MOVE
	IN_MOVED_FROM    uint32 = syscall.IN_MOVED_FROM
	IN_MOVED_TO      uint32 = syscall.IN_MOVED_TO
	IN_MOVE_SELF     uint32 = syscall.IN_MOVE_SELF
	IN_OPEN          uint32 = syscall.IN_OPEN

	// Special events
	IN_ISDIR      uint32 = syscall.IN_ISDIR
	IN_IGNORED    uint32 = syscall.IN_IGNORED
	IN_Q_OVERFLOW uint32 = syscall.IN_Q_OVERFLOW
	IN_UNMOUNT    uint32 = syscall.IN_UNMOUNT
)

Functions

func AtomReadBuffer

func AtomReadBuffer(reader io.Reader, size int) ([]byte, error)

Return a buffer of arbitrary size

func AtomReadInt16

func AtomReadInt16(reader io.Reader) (int, error)

Return an int read from 2 bytes

func AtomReadInt24

func AtomReadInt24(reader io.Reader) (int, error)

Return an int read from 3 bytes

func AtomReadInt32

func AtomReadInt32(reader io.Reader) (int, error)

Return an int read from 4 bytes

func AtomReadInt64

func AtomReadInt64(reader io.Reader) (int64, error)

Return an int read from 8 bytes

func AtomReadInt8

func AtomReadInt8(reader io.Reader) (int, error)

Return an int read from one byte

func AtomReadTag

func AtomReadTag(reader io.Reader) (string, error)

Return a string read from a 4 byte int

func BuildAtom

func BuildAtom(tag string, content []byte) ([]byte, error)

Build atom from a tag and its content

func BuildEmptyAtom

func BuildEmptyAtom(tag string, size int) ([]byte, error)

Build atom of a specific size filled with 0

func CurrentOffset

func CurrentOffset(reader io.ReadSeeker) (int, error)

Return current offset of a io.ReadSeeker

func DisplayMemStats

func DisplayMemStats()

func FileExist

func FileExist(filename string) bool

Test if a file or directory exist

func IsDirectory

func IsDirectory(path string) bool

Test if a path exist and is a directory

func ParseURL

func ParseURL(pattern string, path string, params *map[string]string) bool

parse an URL and extract information according to a pattern

func ReadAtomHeader

func ReadAtomHeader(reader io.ReadSeeker, res *int) (string, error)

Read atom header : tag and size

func RemoveExtension

func RemoveExtension(filename string) string

Remove extension from a filename

Types

type Event

type Event struct {
	Mask   uint32 // Mask of events
	Cookie uint32 // Unique cookie associating related events (for rename(2))
	Name   string // File name (optional)
}

func (*Event) String

func (e *Event) String() string

String formats the event e in the form "filename: 0xEventMask = IN_ACCESS|IN_ATTRIB_|..."

type Queue

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

Data structure used to represent a queue

func (*Queue) Clear

func (s *Queue) Clear()

Clear queue

func (*Queue) Empty

func (s *Queue) Empty() bool

Return if the queue is empty

func (*Queue) Pop

func (s *Queue) Pop() interface{}

Pop the first element from the queue

func (*Queue) Push

func (s *Queue) Push(elms ...interface{})

Push an element to the end of the queue

func (*Queue) Size

func (s *Queue) Size() int

Return queue size

type Watcher

type Watcher struct {
	Error chan error  // Errors are sent on this channel
	Event chan *Event // Events are returned on this channel
	// contains filtered or unexported fields
}

func NewWatcher

func NewWatcher() (*Watcher, error)

NewWatcher creates and returns a new inotify instance using inotify_init(2)

func (*Watcher) AddWatch

func (w *Watcher) AddWatch(path string, flags uint32) error

AddWatch adds path to the watched file set. The flags are interpreted as described in inotify_add_watch(2).

func (*Watcher) Close

func (w *Watcher) Close() error

Close closes an inotify watcher instance It sends a message to the reader goroutine to quit and removes all watches associated with the inotify instance

func (*Watcher) RemoveWatch

func (w *Watcher) RemoveWatch(path string) error

RemoveWatch removes path from the watched file set.

func (*Watcher) Watch

func (w *Watcher) Watch(path string) error

Watch adds path to the watched file set, watching all events.