These functions wrap the pipe / write / read functions to easily integrate its use into ecore's main loop. More...
Typedefs | |
| typedef struct _Ecore_Pipe | Ecore_Pipe |
| A handle for pipes. | |
| typedef void(* | Ecore_Pipe_Cb) (void *data, void *buffer, unsigned int nbyte) |
| The callback that data written to the pipe is sent to. | |
Functions | |
| Ecore_Pipe * | ecore_pipe_add (Ecore_Pipe_Cb handler, const void *data) |
| Creates two file descriptors (sockets on Windows). More... | |
| Ecore_Pipe * | ecore_pipe_full_add (Ecore_Pipe_Cb handler, const void *data, int fd_read, int fd_write, Eina_Bool read_survive_fork, Eina_Bool write_survive_fork) |
| Creates a pipe with more parameters. More... | |
| void * | ecore_pipe_del (Ecore_Pipe *p) |
| Frees an Ecore_Pipe object created with ecore_pipe_add(). More... | |
| Eina_Bool | ecore_pipe_write (Ecore_Pipe *p, const void *buffer, unsigned int nbytes) |
| Writes on the file descriptor the data passed as parameter. More... | |
| void | ecore_pipe_write_close (Ecore_Pipe *p) |
| Closes the write end of an Ecore_Pipe object created with ecore_pipe_add(). More... | |
| void | ecore_pipe_read_close (Ecore_Pipe *p) |
| Closes the read end of an Ecore_Pipe object created with ecore_pipe_add(). More... | |
| int | ecore_pipe_read_fd (Ecore_Pipe *p) |
| Gets the pipe read file descriptor. More... | |
| int | ecore_pipe_write_fd (Ecore_Pipe *p) |
| Gets the pipe write file descriptor. More... | |
| void | ecore_pipe_thaw (Ecore_Pipe *p) |
| Starts monitoring again the pipe for reading. More... | |
| void | ecore_pipe_freeze (Ecore_Pipe *p) |
| Stops monitoring if necessary the pipe for reading. More... | |
| int | ecore_pipe_wait (Ecore_Pipe *p, int message_count, double wait) |
| Waits from another thread on the read side of a pipe. More... | |
These functions wrap the pipe / write / read functions to easily integrate its use into ecore's main loop.
The ecore_pipe_add() function creates file descriptors (sockets on Windows) and attach a handle to the ecore main loop. That handle is called when data is read in the pipe. To write data in the pipe, just call ecore_pipe_write(). When you are done, just call ecore_pipe_del().
For examples see here:
| Ecore_Pipe * ecore_pipe_add | ( | Ecore_Pipe_Cb | handler, |
| const void * | data | ||
| ) |
Creates two file descriptors (sockets on Windows).
Adds a callback that will be called when the file descriptor that is listened receives data. An event is also put in the event queue when data is received.
| handler | The handler called when data is received. |
| data | Data to pass to handler when it is called. |
NULL otherwise. Referenced by ecore_fork_reset().
| Ecore_Pipe * ecore_pipe_full_add | ( | Ecore_Pipe_Cb | handler, |
| const void * | data, | ||
| int | fd_read, | ||
| int | fd_write, | ||
| Eina_Bool | read_survive_fork, | ||
| Eina_Bool | write_survive_fork | ||
| ) |
Creates a pipe with more parameters.
| handler | Same as ecore_pipe_add() |
| data | Same as ecore_pipe_add() |
| fd_read | An fd to use for reading or -1 otherwise |
| fd_write | An fd to use for writing or -1 otherwise |
| read_survive_fork | Should read fd survive a fork |
| write_survive_fork | Should write fd survive a fork |
This is the same as ecore_pipe_add() but with some added parameters.
References ECORE_FD_READ, ecore_main_fd_handler_add(), eina_file_close_on_exec(), EINA_MAIN_LOOP_CHECK_RETURN_VAL, EINA_TRUE, ERR, and fcntl().
| void * ecore_pipe_del | ( | Ecore_Pipe * | p | ) |
Frees an Ecore_Pipe object created with ecore_pipe_add().
| p | The Ecore_Pipe object to be freed. |
References EINA_MAIN_LOOP_CHECK_RETURN_VAL.
Referenced by ecore_fork_reset().
| Eina_Bool ecore_pipe_write | ( | Ecore_Pipe * | p, |
| const void * | buffer, | ||
| unsigned int | nbytes | ||
| ) |
Writes on the file descriptor the data passed as parameter.
| p | The Ecore_Pipe object. |
| buffer | The data to write into the pipe. |
| nbytes | The size of the buffer in bytes. |
EINA_TRUE on a successful write, EINA_FALSE on error. References EINA_FALSE, EINA_TRUE, and ERR.
Referenced by ecore_fork_reset(), and evas_async_events_put().
| void ecore_pipe_write_close | ( | Ecore_Pipe * | p | ) |
Closes the write end of an Ecore_Pipe object created with ecore_pipe_add().
| p | The Ecore_Pipe object. |
| void ecore_pipe_read_close | ( | Ecore_Pipe * | p | ) |
Closes the read end of an Ecore_Pipe object created with ecore_pipe_add().
| p | The Ecore_Pipe object. |
References EINA_MAIN_LOOP_CHECK_RETURN.
| int ecore_pipe_read_fd | ( | Ecore_Pipe * | p | ) |
Gets the pipe read file descriptor.
| p | The Ecore_Pipe object query. |
-1 if none References EINA_MAIN_LOOP_CHECK_RETURN_VAL.
| int ecore_pipe_write_fd | ( | Ecore_Pipe * | p | ) |
Gets the pipe write file descriptor.
| p | The Ecore_Pipe object query. |
-1 if none References EINA_MAIN_LOOP_CHECK_RETURN_VAL.
| void ecore_pipe_thaw | ( | Ecore_Pipe * | p | ) |
Starts monitoring again the pipe for reading.
See ecore_pipe_freeze() for stopping the monitoring activity. This will not work if ecore_pipe_read_close() was previously called on the same pipe.
| p | The Ecore_Pipe object. |
References ECORE_FD_READ, ecore_main_fd_handler_add(), and EINA_MAIN_LOOP_CHECK_RETURN.
| void ecore_pipe_freeze | ( | Ecore_Pipe * | p | ) |
Stops monitoring if necessary the pipe for reading.
See ecore_pipe_thaw() for monitoring it again.
| p | The Ecore_Pipe object. |
References EINA_MAIN_LOOP_CHECK_RETURN.
| int ecore_pipe_wait | ( | Ecore_Pipe * | p, |
| int | message_count, | ||
| double | wait | ||
| ) |
Waits from another thread on the read side of a pipe.
| p | The pipe to watch on. |
| message_count | The minimum number of messages to wait for before exiting. |
| wait | The amount of time in seconds to wait before exiting. |
Negative value for wait means infite wait.
Referenced by ecore_main_loop_thread_safe_call_wait(), and evas_async_events_process().