fssyscall

Documentation

Overview

Package fssyscall abstracts syscall file descriptors across platform.Handles

Index

• func FLockEx(f *os.File) error
• func FTryLockEx(f *os.File) error
• func FUnlockEx(f *os.File) error
• func LockEx(h Handle) error
• func TryLockEx(h Handle) error
• func UnlockEx(h Handle) error
• type Handle
  • func Open(filename string, mode int, perm fs.FileMode) (Handle, error)
  • func (h Handle) Close() error
  • func (h Handle) IsZero() bool
  • func (h Handle) Sys() int

Functions

func FLockEx

func FLockEx(f *os.File) error

FLockEx attempts to create an advisory exclusive lock on the file associated to the given *os.File.

func FTryLockEx

func FTryLockEx(f *os.File) error

FTryLockEx attempts to create an advisory exclusive lock on the file associated to the given *os.File without blocking. Returns an error if the lock cannot be acquired immediately.

func FUnlockEx

func FUnlockEx(f *os.File) error

FUnlockEx releases an advisory lock on the file associated with the given *os.File.

func LockEx

func LockEx(h Handle) error

LockEx attempts to create an advisory exclusive lock on the file associated to the given Handle.

func TryLockEx

func TryLockEx(h Handle) error

TryLockEx attempts to create an advisory exclusive lock on the file associated to the given Handle without blocking. Returns syscall.EBUSY if the lock cannot be acquired immediately.

func UnlockEx

func UnlockEx(h Handle) error

UnlockEx releases an advisory lock on the file associated with the given Handle.

Types

type Handle

type Handle int

Handle represents a OS specific file descriptor

const ZeroHandle Handle = -1

ZeroHandle represents a closed Handle

func Open

func Open(filename string, mode int, perm fs.FileMode) (Handle, error)

Open performs syscall.Open returning a Handle

func (Handle) Close

func (h Handle) Close() error

Close attempts to close the file associated to the Handle

func (Handle) IsZero

func (h Handle) IsZero() bool

IsZero indicates the Handle doesn't refer to a possibly valid descriptor

func (Handle) Sys

func (h Handle) Sys() int

Sys returns the underlying type for syscall operations