Pipe wrapper

---

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

Functions
Ecore_Pipe *	ecore_pipe_add (Ecore_Pipe_Cb handler, const void *data)
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)
void *	ecore_pipe_del (Ecore_Pipe *p)
Eina_Bool	ecore_pipe_write (Ecore_Pipe *p, const void *buffer, unsigned int nbytes)
void	ecore_pipe_write_close (Ecore_Pipe *p)
void	ecore_pipe_read_close (Ecore_Pipe *p)
int	ecore_pipe_read_fd (Ecore_Pipe *p)
int	ecore_pipe_write_fd (Ecore_Pipe *p)
void	ecore_pipe_thaw (Ecore_Pipe *p)
void	ecore_pipe_freeze (Ecore_Pipe *p)
int	ecore_pipe_wait (Ecore_Pipe *p, int message_count, double wait)
	Waits from another thread on the read side of a pipe.
Typedefs
typedef struct _Ecore_Pipe	Ecore_Pipe
typedef void(*	Ecore_Pipe_Cb )(void *data, void *buffer, unsigned int nbyte)

---

Typedef Documentation

typedef struct _Ecore_Pipe Ecore_Pipe

A handle for pipes

Ecore_Pipe_Cb Ecore_Pipe_Cb

The callback that data written to the pipe is sent to.

---

Function Documentation

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.

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.

Since :

2.3

Examples:

ecore_pipe_gstreamer_example.c, and ecore_pipe_simple_example.c.

void* ecore_pipe_del

(

Ecore_Pipe *

p

)

Frees 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

Since :

2.3

Examples:

ecore_pipe_gstreamer_example.c, and ecore_pipe_simple_example.c.

void ecore_pipe_freeze

(

Ecore_Pipe *

p

)

Stops monitoring if necessary the pipe for reading. See ecore_pipe_thaw() for monitoring it again.

Parameters:

p	The Ecore_Pipe object.

Since (EFL) :

1.1

Since :

2.3

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.

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.

Returns:

A pointer to the new Ecore_Pipe object on success, else NULL.

See also:

ecore_pipe_add()

Since :

3.0

void ecore_pipe_read_close

(

Ecore_Pipe *

p

)

Closes the read end of an Ecore_Pipe object created with ecore_pipe_add().

Parameters:

p	The Ecore_Pipe object.

Since :

2.3

Examples:

ecore_pipe_simple_example.c.

int ecore_pipe_read_fd

(

Ecore_Pipe *

p

)

Gets the pipe read file descriptor.

Parameters:

p	The Ecore_Pipe object query.

Returns:

The file descriptor, or -1 if none

Since :

3.0

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.

Parameters:

p	The Ecore_Pipe object.

Since (EFL) :

1.1

Since :

2.3

int ecore_pipe_wait	(	Ecore_Pipe *	p,
		int	message_count,
		double	wait
	)

Waits 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 (EFL) :

1.1

Negative value for wait means infite wait.

Since :

2.3

Eina_Bool ecore_pipe_write	(	Ecore_Pipe *	p,
		const void *	buffer,
		unsigned int	nbytes
	)

Writes 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.

Since :

2.3

Examples:

ecore_pipe_gstreamer_example.c, and ecore_pipe_simple_example.c.

void ecore_pipe_write_close

(

Ecore_Pipe *

p

)

Closes the write end of an Ecore_Pipe object created with ecore_pipe_add().

Parameters:

p	The Ecore_Pipe object.

Since :

2.3

Examples:

ecore_pipe_simple_example.c.

int ecore_pipe_write_fd

(

Ecore_Pipe *

p

)

Gets the pipe write file descriptor.

Parameters:

p	The Ecore_Pipe object query.

Returns:

The file descriptor, or -1 if none

Since :

3.0