---

qIo.c File Reference

I/O Handling API. More...

Defines
#define	MAX_IOSEND_SIZE   (32 * 1024)
Functions
int	qIoWaitReadable (int fd, int timeoutms)
	Test & wait until the file descriptor has readable data.
int	qIoWaitWritable (int fd, int timeoutms)
	Test & wait until the file descriptor is ready for writing.
ssize_t	qIoRead (void *buf, int fd, size_t nbytes, int timeoutms)
	Read from a file descriptor.
ssize_t	qIoWrite (int fd, const void *buf, size_t nbytes, int timeoutms)
	Write to a file descriptor.
off_t	qIoSend (int outfd, int infd, off_t nbytes, int timeoutms)
	Transfer data between file descriptors.
ssize_t	qIoGets (char *buf, size_t bufsize, int fd, int timeoutms)
	Read a line from a file descriptor into the buffer pointed to until either a terminating newline or EOF.
ssize_t	qIoPuts (int fd, const char *str, int timeoutms)
	Writes the string and a trailing newline to file descriptor.
ssize_t	qIoPrintf (int fd, int timeoutms, const char *format,...)
	Formatted output to a file descriptor.

---

Detailed Description

I/O Handling API.

---

Function Documentation

int qIoWaitReadable	(	int	fd,
		int	timeoutms
	)

Test & wait until the file descriptor has readable data.

Parameters:

	fd	file descriptor
	timeoutms	wait timeout milliseconds. 0 for no wait, -1 for infinite wait

Returns:

1 if readable, 0 on timeout, -1 if an error occurred.

Note:

The argument timeoutms can be used to set maximum wait time for a socket descriptor. In terms of general file descriptor, timeoutms may normally 0.

int qIoWaitWritable	(	int	fd,
		int	timeoutms
	)

Test & wait until the file descriptor is ready for writing.

Parameters:

	fd	file descriptor
	timeoutms	wait timeout milliseconds. 0 for no wait, -1 for infinite wait

Returns:

1 if writable, 0 on timeout, -1 if an error occurred.

ssize_t qIoRead	(	void *	buf,
		int	fd,
		size_t	nbytes,
		int	timeoutms
	)

Read from a file descriptor.

Parameters:

	buf	data buffer pointer to write to
	fd	file descriptor
	nbytes	the number of bytes to read from file descriptor & write into buffer
	timeoutms	wait timeout milliseconds. 0 for no wait, -1 for infinite wait

Returns:

the number of bytes read if successful, otherwise returns -1.

ssize_t qIoWrite	(	int	fd,
		const void *	buf,
		size_t	nbytes,
		int	timeoutms
	)

Write to a file descriptor.

Parameters:

	fd	file descriptor
	buf	data buffer pointer to read from
	nbytes	the number of bytes to write to file descriptor & read from buffer
	timeoutms	wait timeout milliseconds. 0 for no wait, -1 for infinite wait

Returns:

the number of bytes written if successful, otherwise returns -1.

off_t qIoSend	(	int	outfd,
		int	infd,
		off_t	nbytes,
		int	timeoutms
	)

Transfer data between file descriptors.

Parameters:

	outfd	output file descriptor
	infd	input file descriptor
	nbytes	the number of bytes to copy between file descriptors. 0 means transfer until end of infd.
	timeoutms	wait timeout milliseconds. 0 for no wait, -1 for infinite wait

Returns:

the number of bytes written if successful, otherwise returns -1.

ssize_t qIoGets	(	char *	buf,
		size_t	bufsize,
		int	fd,
		int	timeoutms
	)

Read a line from a file descriptor into the buffer pointed to until either a terminating newline or EOF.

New-line characters(CR, LF ) will not be stored into buffer.

Parameters:

	buf	data buffer pointer
	bufsize	buffer size
	fd	file descriptor
	timeoutms	wait timeout milliseconds

Returns:

the number of bytes read from file descriptor if successful, otherwise returns -1.

Note:

Be sure the return value does not mean the length of actual stored data. It means how many bytes are readed from the file descriptor, so the new-line characters will be counted, but not be stored.

ssize_t qIoPuts	(	int	fd,
		const char *	str,
		int	timeoutms
	)

Writes the string and a trailing newline to file descriptor.

Parameters:

	fd	file descriptor
	str	string pointer
	timeoutms	wait timeout milliseconds. 0 for no wait, -1 for infinite wait

Returns:

the number of bytes written including trailing newline characters if successful, otherwise returns -1.

ssize_t qIoPrintf	(	int	fd,
		int	timeoutms,
		const char *	format,
			...
	)

Formatted output to a file descriptor.

Parameters:

	fd	file descriptor
	timeoutms	wait timeout milliseconds. 0 for no wait, -1 for infinite wait
	format	format string

Returns:

the number of bytes written if successful, otherwise returns -1.

---

[Home] [About] [Examples] [Changes] [Download] [SVN Repository] [Install] [Reference]