ecl_io Documentation

ecl_io: Cross platform abstractions for implementation dependant and low-level io api

Most implementations (windows, posix, ...) have slightly different api for low level input-output functions. These are gathered here and re-represented with a cross platform set of functions.

• Homepage: http://ros.org/wiki/ecl_io

packageSummary

This package provides cross platform api to some of the lower level socket functions available on different platforms. Currently there is only minor support for a few functions on:

• Windows
• Posix

CompilingLinking

Include the following at the top of any translation unit which requires this library:

        #include <ecl/io.hpp>

        // Cross platform functions
        using ecl::init_sockets;
        using ecl::shutdown_sockets;
        using ecl::poll_sockets;
        using ecl::close_socket;
        using ecl::socket_pair;

You will also need to link to -lecl_io.

Library

• init_sockets() : initialises winsock on windows.
• shutdown_sockets() : shuts down winsock on windows.
• poll_sockets() : a drop in for the posix poll function on windoze.
• socketpair() : a drop in for the posix socketpair function on windoze.
• close_socket() : standardises the api for closing a socket.

A drop in for poll() on windoze is soon to come.

utilities

Really rough, no tests yet, just some examples.

• src/examples/poll.cpp : tests the basic sockets api.
• src/examples/sockets.cpp : tests the basic sockets api.
• src/examples/socketpair.cpp : tests the socketpair drop-in for windows.

ChangeLog

• Feb 11 : a drop-in for the socketpair function added for windows.
• Jan 11 : simple cross platform types and api added.