include/nuttx/signal.h: Fix nxsig_notification comment
This commit is contained in:
parent
28abd336da
commit
74c4d4f3d7
@ -434,17 +434,17 @@ unsigned int nxsig_sleep(unsigned int seconds);
|
|||||||
int nxsig_usleep(useconds_t usec);
|
int nxsig_usleep(useconds_t usec);
|
||||||
|
|
||||||
/****************************************************************************
|
/****************************************************************************
|
||||||
* Name: nxsig_evthread
|
* Name: nxsig_notification
|
||||||
*
|
*
|
||||||
* Description:
|
* Description:
|
||||||
* Notify a client a signal event via a function call. This function is
|
* Notify a client an event via either a signal or a function call
|
||||||
* an internal OS interface that implements the common logic for signal
|
* base on the sigev_notify field.
|
||||||
* event notification for the case of SIGEV_THREAD.
|
|
||||||
*
|
*
|
||||||
* Input Parameters:
|
* Input Parameters:
|
||||||
* pid - The task/thread ID a the client thread to be signaled.
|
* pid - The task/thread ID a the client thread to be signaled.
|
||||||
* event - The instance of struct sigevent that describes how to signal
|
* event - The instance of struct sigevent that describes how to signal
|
||||||
* the client.
|
* the client.
|
||||||
|
* code - Source: SI_USER, SI_QUEUE, SI_TIMER, SI_ASYNCIO, or SI_MESGQ
|
||||||
*
|
*
|
||||||
* Returned Value:
|
* Returned Value:
|
||||||
* This is an internal OS interface and should not be used by applications.
|
* This is an internal OS interface and should not be used by applications.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user