NAME

src/io/io_passdown.c - IO layer handling

DESCRIPTION

This is a set of helper functions which search for the first implementation of a function in the layer-stack, call it with the appropriate arguments and return the value returned.

Functions

PARROT_WARN_UNUSED_RESULT PARROT_CAN_RETURN_NULL ParrotIO *PIO_open_down(PARROT_INTERP, NULLOK(ParrotIOLayer *layer), NOTNULL(const char *name), INTVAL flags)

Looks for the implementation of Open and calls it if found, returning its return value.

Returns NULL if no implementation is found.

PARROT_WARN_UNUSED_RESULT PARROT_CAN_RETURN_NULL ParrotIO *PIO_open_async_down(PARROT_INTERP, NULLOK(ParrotIOLayer *layer), NOTNULL(const char *name), NOTNULL(const char *mode), NOTNULL(DummyCodeRef *dummy))

Looks for the implementation of Open_ASync and calls it if found, returning its return value.

Returns NULL if no implementation is found.

PARROT_WARN_UNUSED_RESULT PARROT_CAN_RETURN_NULL ParrotIO *PIO_fdopen_down(PARROT_INTERP, NULLOK(ParrotIOLayer *layer), PIOHANDLE fd, INTVAL flags)

Looks for the implementation of FDOpen and calls it if found, returning its return value.

Returns NULL if no implementation is found.

PARROT_WARN_UNUSED_RESULT size_t PIO_peek_down(PARROT_INTERP, NULLOK(ParrotIOLayer *layer), NOTNULL(ParrotIO *io), NOTNULL(STRING **buf))

TODO: Not yet documented!!!

PARROT_WARN_UNUSED_RESULT INTVAL PIO_close_down(PARROT_INTERP, NULLOK(ParrotIOLayer *layer), NOTNULL(ParrotIO *io))

Looks for the implementation of Close and calls it if found, returning its return value.

Returns -1 if no implementation is found.

PARROT_WARN_UNUSED_RESULT size_t PIO_write_down(PARROT_INTERP, NULLOK(ParrotIOLayer *layer), NOTNULL(ParrotIO *io), NOTNULL(STRING *s))

Looks for the implementation of Write and calls it if found, returning its return value.

Returns 0 if no implementation is found.

PARROT_WARN_UNUSED_RESULT size_t PIO_write_async_down(PARROT_INTERP, NULLOK(ParrotIOLayer *layer), NOTNULL(ParrotIO *io), NOTNULL(STRING *s), NOTNULL(DummyCodeRef *dummy))

Looks for the implementation of WriteASync and calls it if found, returning its return value.

Returns 0 if no implementation is found.

PARROT_WARN_UNUSED_RESULT size_t PIO_read_down(PARROT_INTERP, NULLOK(ParrotIOLayer *layer), NOTNULL(ParrotIO *io), NOTNULL(STRING **buf))

Looks for the implementation of Read and calls it if found, returning its return value.

Returns 0 if no implementation is found.

PARROT_WARN_UNUSED_RESULT size_t PIO_read_async_down(PARROT_INTERP, NULLOK(ParrotIOLayer *layer), NOTNULL(ParrotIO *io), NOTNULL(STRING **buf), NOTNULL(DummyCodeRef *dummy))

Looks for the implementation of Read_ASync and calls it if found, returning its return value.

Returns 0 if no implementation is found.

PARROT_WARN_UNUSED_RESULT INTVAL PIO_flush_down(PARROT_INTERP, NULLOK(ParrotIOLayer *layer), NOTNULL(ParrotIO *io))

Looks for the implementation of Flush and calls it if found, returning its return value.

Returns 0 if no implementation is found.

PARROT_WARN_UNUSED_RESULT PIOOFF_T PIO_seek_down(PARROT_INTERP, NULLOK(ParrotIOLayer *layer), NOTNULL(ParrotIO *io), PIOOFF_T offset, INTVAL whence)

Looks for the implementation of Seek and calls it if found, returning its return value.

Returns -1 if no implementation is found.

PARROT_WARN_UNUSED_RESULT PIOOFF_T PIO_tell_down(PARROT_INTERP, NULLOK(ParrotIOLayer *layer), NOTNULL(ParrotIO *io))

Looks for the implementation of Tell and calls it if found, returning its return value.

Returns 0 if no implementation is found.

PARROT_WARN_UNUSED_RESULT INTVAL PIO_setbuf_down(PARROT_INTERP, NULLOK(ParrotIOLayer *layer), NOTNULL(ParrotIO *io), size_t bufsize)

Looks for the implementation of SetBuf and calls it if found, returning its return value.

Returns -1 if no implementation is found.

PARROT_WARN_UNUSED_RESULT INTVAL PIO_setlinebuf_down(PARROT_INTERP, NULLOK(ParrotIOLayer *layer), NOTNULL(ParrotIO *io))

Looks for the implementation of SetLineBuf and calls it if found, returning its return value.

Returns -1 if no implementation is found.

PARROT_WARN_UNUSED_RESULT INTVAL PIO_eof_down(PARROT_INTERP, NULLOK(ParrotIOLayer *layer), NOTNULL(ParrotIO *io))

Looks for the implementation of Eof and calls it if found, returning its return value.

Returns -1 if no implementation is found.

PARROT_WARN_UNUSED_RESULT INTVAL PIO_poll_down(PARROT_INTERP, NOTNULL(ParrotIOLayer *layer), NOTNULL(ParrotIO *io), INTVAL which, INTVAL sec, INTVAL usec)

Looks for the implementation of Poll and calls it if found, returning its return value.

Returns -1 if no implementation is found.

PARROT_WARN_UNUSED_RESULT PARROT_CAN_RETURN_NULL ParrotIO *PIO_socket_down(PARROT_INTERP, NOTNULL(ParrotIOLayer *layer), INTVAL fam, INTVAL type, INTVAL proto)

Looks for the implementation of Socket and calls it if found, returning its return value.

Returns NULL if no implementation is found.

PARROT_WARN_UNUSED_RESULT INTVAL PIO_recv_down(PARROT_INTERP, NOTNULL(ParrotIOLayer *layer), NOTNULL(ParrotIO *io), NOTNULL(STRING **buf))

Looks for the implementation of Recv and calls it if found, returning its return value.

Returns -1 if no implementation is found.

PARROT_WARN_UNUSED_RESULT INTVAL PIO_send_down(PARROT_INTERP, NOTNULL(ParrotIOLayer *layer), NOTNULL(ParrotIO *io), NOTNULL(STRING *buf))

Looks for the implementation of Send and calls it if found, returning its return value.

Returns -1 if no implementation is found.

PARROT_WARN_UNUSED_RESULT INTVAL PIO_connect_down(PARROT_INTERP, NOTNULL(ParrotIOLayer *layer), NOTNULL(ParrotIO *io), NOTNULL(STRING *address))

Looks for the implementation of Connect and calls it if found, returning its return value.

Returns -1 if no implementation is found.

PARROT_WARN_UNUSED_RESULT INTVAL PIO_bind_down(PARROT_INTERP, NOTNULL(ParrotIOLayer *layer), NOTNULL(ParrotIO *io), NOTNULL(STRING *address))

Looks for the implementation of Bind and calls it if found, returning its return value.

Returns -1 if no implementation is found.

PARROT_WARN_UNUSED_RESULT INTVAL PIO_listen_down(PARROT_INTERP, NOTNULL(ParrotIOLayer *layer), NOTNULL(ParrotIO *io), INTVAL backlog)

Looks for the implementation of listen and calls it if found, returning its return value.

Returns -1 if no implementation is found.

PARROT_WARN_UNUSED_RESULT PARROT_CAN_RETURN_NULL ParrotIO *PIO_accept_down(PARROT_INTERP, NOTNULL(ParrotIOLayer *layer), NOTNULL(ParrotIO *io))

Looks for the implementation of Accept and calls it if found, returning its return value.

Returns -1 if no implementation is found.

SEE ALSO

src/io/io_buf.c, src/io/io_passdown.c, src/io/io_stdio.c, src/io/io_unix.c, src/io/io_win32.c, src/io/io.c, src/io/io_private.h.

HISTORY

Initially written by Juergen Boemmels

Some ideas and goals from Perl5.7 and Nick Ing-Simmons' work.