Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

iv_inotify_init(3) [debian man page]

iv_inotify(3)						    ivykis programmer's manual						     iv_inotify(3)

NAME
IV_INOTIFY_INIT, iv_inotify_register, iv_inotify_unregister, IV_INOTIFY_WATCH_INIT, iv_inotify_watch_register, iv_inotify_watch_unregister - ivykis inotify(7) wrapper SYNOPSIS
#include <iv_inotify.h> struct iv_inotify { }; void IV_INOTIFY_INIT(struct iv_inotify *inotify); int iv_inotify_register(struct iv_inotify *inotify); void iv_inotify_unregister(struct iv_inotify *inotify); struct iv_inotify_watch { struct iv_inotify *inotify; const char *pathname; uint32_t mask; void *cookie; void (*handler)(void *, struct inotify_event *); }; void IV_INOTIFY_WATCH_INIT(struct iv_inotify_watch *watch); int iv_inotify_watch_register(struct iv_inotify_watch *watch); int iv_inotify_watch_unregister(struct iv_inotify_watch *watch); DESCRIPTION
The iv_inotify_register function registers an iv_inotify instance with the iv_inotify(3) module. The inotify parameter is a pointer to the iv_inotify structure to be registered. The iv_inotify_unregister function unregisters an iv_inotify instance from the iv_inotify(3) module. The inotify parameter is a pointer to the iv_inotify structure to be unregistered. The iv_inotify_watch_register function adds a watch to the registered iv_inotify instance specified by the ->inotify member. The iv_inotify_watch_unregister function removes a watch from the iv_inotify instance specified by the ->inotify member. In the iv_inotify_watch structure used in these functions, the ->pathname and ->mask members correspond to the members of struct ino- tify_watch as described in inotify(7). ->handler is the event handler called when this watch triggers. The arguments to this handler function are the pointer stored in the ->cookie member of the iv_inotify_watch structure and a pointer to an inotify_event structure as described in inotify(7). RETURN VALUE
iv_inotify_register and iv_inotify_watch_register return zero on success. On error, -1 is returned, and errno is set appropriately. ERRORS
iv_inotify will return errors returned by inotify_init(3) and inotify_add_watch(3). SEE ALSO
ivykis(3), inotify(7), inotify_init(3), inotify_add_watch(3), inotify_rm_watch(3) ivykis 2009-02-07 iv_inotify(3)

Check Out this Related Man Page

INOTIFY_ADD_WATCH(2)					     Linux Programmer's Manual					      INOTIFY_ADD_WATCH(2)

NAME
inotify_add_watch - add a watch to an initialized inotify instance SYNOPSIS
#include <sys/inotify.h> int inotify_add_watch(int fd, const char *pathname, uint32_t mask); DESCRIPTION
inotify_add_watch() adds a new watch, or modifies an existing watch, for the file whose location is specified in pathname; the caller must have read permission for this file. The fd argument is a file descriptor referring to the inotify instance whose watch list is to be modi- fied. The events to be monitored for pathname are specified in the mask bit-mask argument. See inotify(7) for a description of the bits that can be set in mask. A successful call to inotify_add_watch() returns the unique watch descriptor associated with pathname for this inotify instance. If path- name was not previously being watched by this inotify instance, then the watch descriptor is newly allocated. If pathname was already being watched, then the descriptor for the existing watch is returned. The watch descriptor is returned by later read(2)s from the inotify file descriptor. These reads fetch inotify_event structures (see ino- tify(7)) indicating file system events; the watch descriptor inside this structure identifies the object for which the event occurred. RETURN VALUE
On success, inotify_add_watch() returns a nonnegative watch descriptor. On error -1 is returned and errno is set appropriately. ERRORS
EACCES Read access to the given file is not permitted. EBADF The given file descriptor is not valid. EFAULT pathname points outside of the process's accessible address space. EINVAL The given event mask contains no valid events; or fd is not an inotify file descriptor. ENOENT A directory component in pathname does not exist or is a dangling symbolic link. ENOMEM Insufficient kernel memory was available. ENOSPC The user limit on the total number of inotify watches was reached or the kernel failed to allocate a needed resource. VERSIONS
Inotify was merged into the 2.6.13 Linux kernel. CONFORMING TO
This system call is Linux-specific. SEE ALSO
inotify_init(2), inotify_rm_watch(2), inotify(7) COLOPHON
This page is part of release 3.44 of the Linux man-pages project. A description of the project, and information about reporting bugs, can be found at http://www.kernel.org/doc/man-pages/. Linux 2010-10-20 INOTIFY_ADD_WATCH(2)
Man Page