'\" t .TH "SD_EVENT_ADD_INOTIFY" "3" "" "elogind 246.9.1" "sd_event_add_inotify" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .\" http://bugs.debian.org/507673 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" sd_event_add_inotify, sd_event_source_get_inotify_mask, sd_event_inotify_handler_t \- Add an "inotify" file system inode event source to an event loop .SH "SYNOPSIS" .sp .ft B .nf #include .fi .ft .sp .ft B .nf typedef struct sd_event_source sd_event_source; .fi .ft .HP \w'typedef\ int\ (*sd_event_inotify_handler_t)('u .BI "typedef int (*sd_event_inotify_handler_t)(sd_event_source\ *" "s" ", const\ struct\ inotify_event\ *" "event" ", void\ *" "userdata" ");" .HP \w'int\ sd_event_add_inotify('u .BI "int sd_event_add_inotify(sd_event\ *" "event" ", sd_event_source\ **" "source" ", const\ char\ *" "path" ", uint32_t\ " "mask" ", sd_event_inotify_handler_t\ " "handler" ", void\ *" "userdata" ");" .HP \w'int\ sd_event_source_get_inotify_mask('u .BI "int sd_event_source_get_inotify_mask(sd_event_source\ *" "source" ", uint32_t\ *" "mask" ");" .SH "DESCRIPTION" .PP \fBsd_event_add_inotify()\fR adds a new \fBinotify\fR(7) file system inode event source to an event loop\&. The event loop object is specified in the \fIevent\fR parameter, the event source object is returned in the \fIsource\fR parameter\&. The \fIpath\fR parameter specifies the path of the file system inode to watch\&. The \fIhandler\fR must reference a function to call when the inode changes\&. The handler function will be passed the \fIuserdata\fR pointer, which may be chosen freely by the caller\&. The handler also receives a pointer to a struct inotify_event structure containing information about the inode event\&. The \fImask\fR parameter specifie which types of inode events to watch specifically\&. It must contain an OR\-ed combination of \fBIN_ACCESS\fR, \fBIN_ATTRIB\fR, \fBIN_CLOSE_WRITE\fR, \&... flags\&. See \fBinotify\fR(7) for further information\&. .PP If multiple event sources are installed for the same inode the backing inotify watch descriptor is automatically shared\&. The mask parameter may contain any flag defined by the inotify API, with the exception of \fBIN_MASK_ADD\fR\&. .PP The handler is enabled continuously (\fBSD_EVENT_ON\fR), but this may be changed with \fBsd_event_source_set_enabled\fR(3)\&. Alternatively, the \fBIN_ONESHOT\fR mask flag may be used to request \fBSD_EVENT_ONESHOT\fR mode\&. If the handler function returns a negative error code, it will be disabled after the invocation, even if the \fBSD_EVENT_ON\fR mode was requested before\&. .PP As a special limitation the priority of inotify event sources may only be altered (see \fBsd_event_source_set_priority\fR(3)) in the time between creation of the event source object with \fBsd_event_add_inotify()\fR and the beginning of the next event loop iteration\&. Attempts of changing the priority any later will be refused\&. Consider freeing and allocating a new inotify event source to change the priority at that point\&. .PP To destroy an event source object use \fBsd_event_source_unref\fR(3), but note that the event source is only removed from the event loop when all references to the event source are dropped\&. To make sure an event source does not fire anymore, even when there\*(Aqs still a reference to it kept, consider disabling it with \fBsd_event_source_set_enabled\fR(3)\&. .PP If the second parameter of \fBsd_event_add_inotify()\fR is passed as NULL no reference to the event source object is returned\&. In this case the event source is considered "floating", and will be destroyed implicitly when the event loop itself is destroyed\&. .PP \fBsd_event_source_get_inotify_mask()\fR retrieves the configured inotify watch mask of an event source created previously with \fBsd_event_add_inotify()\fR\&. It takes the event source object as the \fIsource\fR parameter and a pointer to a \fBuint32_t\fR variable to return the mask in\&. .SH "RETURN VALUE" .PP On success, these functions return 0 or a positive integer\&. On failure, they return a negative errno\-style error code\&. .SS "Errors" .PP Returned errors may indicate the following problems: .PP \fB\-ENOMEM\fR .RS 4 Not enough memory to allocate an object\&. .RE .PP \fB\-EINVAL\fR .RS 4 An invalid argument has been passed\&. This includes specifying a mask with \fBIN_MASK_ADD\fR set\&. .RE .PP \fB\-ESTALE\fR .RS 4 The event loop is already terminated\&. .RE .PP \fB\-ECHILD\fR .RS 4 The event loop has been created in a different process\&. .RE .PP \fB\-EDOM\fR .RS 4 The passed event source is not an inotify process event source\&. .RE .SH "NOTES" .PP These APIs are implemented as a shared library, which can be compiled and linked to with the \fBlibelogind\fR\ \&\fBpkg-config\fR(1) file\&. .SH "SEE ALSO" .PP \fBelogind\fR(1), \fBsd-event\fR(3), \fBsd_event_new\fR(3), \fBsd_event_now\fR(3), \fBsd_event_add_io\fR(3), \fBsd_event_add_time\fR(3), \fBsd_event_add_signal\fR(3), \fBsd_event_add_defer\fR(3), \fBsd_event_add_child\fR(3), \fBsd_event_source_set_enabled\fR(3), \fBsd_event_source_set_priority\fR(3), \fBsd_event_source_set_userdata\fR(3), \fBsd_event_source_set_description\fR(3), \fBsd_event_source_set_floating\fR(3), \fBwaitid\fR(2)