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 | |
EAPI Ecore_Pipe * | ecore_pipe_add (Ecore_Pipe_Cb handler, const void *data) |
Create two file descriptors (sockets on Windows). | |
EAPI void * | ecore_pipe_del (Ecore_Pipe *p) |
Free an Ecore_Pipe object created with ecore_pipe_add(). | |
EAPI Eina_Bool | ecore_pipe_write (Ecore_Pipe *p, const void *buffer, unsigned int nbytes) |
Write on the file descriptor the data passed as parameter. | |
EAPI void | ecore_pipe_write_close (Ecore_Pipe *p) |
Close the write end of an Ecore_Pipe object created with ecore_pipe_add(). | |
EAPI void | ecore_pipe_read_close (Ecore_Pipe *p) |
Close the read end of an Ecore_Pipe object created with ecore_pipe_add(). | |
EAPI void | ecore_pipe_thaw (Ecore_Pipe *p) |
Start monitoring again the pipe for reading. | |
EAPI void | ecore_pipe_freeze (Ecore_Pipe *p) |
Stop monitoring if necessary the pipe for reading. | |
EAPI int | ecore_pipe_wait (Ecore_Pipe *p, int message_count, double wait) |
Wait from another thread on the read side of a pipe. |
Detailed Description
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:
- tutorial_ecore_pipe_gstreamer_example
- tutorial_ecore_pipe_simple_example
Function Documentation
EAPI Ecore_Pipe * ecore_pipe_add | ( | Ecore_Pipe_Cb | handler, |
const void * | data | ||
) |
Create two file descriptors (sockets on Windows).
Add 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.
- Parameters:
-
handler The handler called when data is received. data Data to pass to handler
when it is called.
- Returns:
- A newly created Ecore_Pipe object if successful.
NULL
otherwise.
References ECORE_FD_READ, and ecore_main_fd_handler_add().
Referenced by ecore_init().
EAPI void * ecore_pipe_del | ( | Ecore_Pipe * | p | ) |
Free an Ecore_Pipe object created with ecore_pipe_add().
- Parameters:
-
p The Ecore_Pipe object to be freed.
- Returns:
- The pointer to the private data
EAPI void ecore_pipe_freeze | ( | Ecore_Pipe * | p | ) |
Stop monitoring if necessary the pipe for reading.
See ecore_pipe_thaw() for monitoring it again.
- Parameters:
-
p The Ecore_Pipe object.
- Since:
- 1.1
EAPI void ecore_pipe_read_close | ( | Ecore_Pipe * | p | ) |
Close the read end of an Ecore_Pipe object created with ecore_pipe_add().
- Parameters:
-
p The Ecore_Pipe object.
EAPI void ecore_pipe_thaw | ( | Ecore_Pipe * | p | ) |
Start 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.
- Parameters:
-
p The Ecore_Pipe object.
- Since:
- 1.1
References ECORE_FD_READ, and ecore_main_fd_handler_add().
EAPI int ecore_pipe_wait | ( | Ecore_Pipe * | p, |
int | message_count, | ||
double | wait | ||
) |
Wait from another thread on the read side of a pipe.
- Parameters:
-
p The pipe to watch on. message_count The minimal number of message to wait before exiting. wait The amount of time in second to wait before exiting.
- Returns:
- the number of message catched during that wait call.
- Since:
- 1.1
Negative value for wait
means infite wait.
References ecore_loop_time_get().
EAPI Eina_Bool ecore_pipe_write | ( | Ecore_Pipe * | p, |
const void * | buffer, | ||
unsigned int | nbytes | ||
) |
Write on the file descriptor the data passed as parameter.
- Parameters:
-
p The Ecore_Pipe object. buffer The data to write into the pipe. nbytes The size of the buffer
in bytes
- Returns:
EINA_TRUE
on a successful write,EINA_FALSE
on error.
EAPI void ecore_pipe_write_close | ( | Ecore_Pipe * | p | ) |
Close the write end of an Ecore_Pipe object created with ecore_pipe_add().
- Parameters:
-
p The Ecore_Pipe object.