Archives/notcurses
2
0
Fork 0
mirror of https://github.com/dankamongmen/notcurses.git synced 2024-11-20 03:25:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

fds.3: detail usage of ncsubproc_destroy() #552

Browse Source
This commit is contained in:
nick black 2020-05-02 03:47:18 -04:00
parent 6e0fd72e33
commit 456c54e9bd
No known key found for this signature in database
GPG Key ID: 5F43400C21CBFACC
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/man/man3/notcurses_fds.3.md
View File

@ -42,6 +42,8 @@ typedef struct ncsubproc_options {
**struct ncsubproc* ncsubproc_createvpe(struct ncplane* n, const ncsubproc_options* opts, const char* bin, char* const arg[], char* const env[], ncfdplane_callback cbfxn, ncfdplane_done_cb donecbfxn);**
**struct ncplane* ncsubproc_plane(struct ncsubproc* n);**
**int ncsubproc_destroy(struct ncsubproc* n);**
# DESCRIPTION
@ -57,10 +59,19 @@ If **ncsubproc_destroy** is called before the subprocess has exited, it will
be sent a SIGKILL. If **ncsubproc_destroy** or **ncfdplane_destroy** is called
while a callback is being invoked, the destroy function will block until the
callback is done being invoked. If a user callback returns non-0, the calling
object will destroy itself.
object will destroy itself. If a user callback calls the relevant destroy
function itself, the thread will exit as if non-0 had been returned, and the
**ncsubproc**'s resources will at that time be reclaimed.
It is essential that the destroy function be called once and only once, whether
it is from within the thread's context, or external to that context.
# NOTES
**ncsubproc** makes use of pidfds and **pidfd_send_signal(2)**, and thus makes
reliable use of signals (it will never target a process other than the true
subprocess).
# RETURN VALUES
# SEE ALSO