man/man3/libvdeslirp.3.html

Content-type: text/html; charset=UTF-8

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of LIBVDESLIRP</TITLE>
</HEAD><BODY>
<H1>LIBVDESLIRP</H1>
Section: Library Functions Manual (3)<BR>Updated: December 2022<BR><A HREF="#index">Index</A>
<A HREF="/#/man/index">Return to Main Contents</A><HR>


<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>

<P>

vdeslirp_open, vdeslirp_send, vdeslirp_recv, vdeslirp_fd, vdeslirp_close
- simple API for slirp
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>

<P>

#include *libvdeslirp.h*
<P>

struct vdeslirp *vdeslirp_open(SlirpConfig *cfg);
<P>

ssize_t vdeslirp_send(struct vdeslirp *slirp, const void *buf, size_t
count);
<P>

ssize_t vdeslirp_recv(struct vdeslirp *slirp, void *buf, size_t
count);
<P>

int vdeslirp_fd(struct vdeslirp *slirp);
<P>

int vdeslirp_close(struct vdeslirp *slirp);
<P>

These functions are provided by libvdeslirp.
Link with -lvdeslirp.
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>

<P>

Slirp is a TCP/IP emulator.
Slirp generates a virtual network using standard user privileges (no
need for root access or CAP_NET_ADMIN).
This implementation uses libslirp.
<P>

vdeslirp_open creates a slirp network.
The SlirpConfig structure is defined by libslirp and contains
the following fields:
<DL COMPACT>
<DT><DD>
<PRE>

typedef struct SlirpConfig {
    /* Version must be provided */
    uint32_t version;
    /*
     * Fields introduced in SlirpConfig version 1 begin
     */
    int restricted;
    bool in_enabled;
    struct in_addr vnetwork;
    struct in_addr vnetmask;
    struct in_addr vhost;
    bool in6_enabled;
    struct in6_addr vprefix_addr6;
    uint8_t vprefix_len;
    struct in6_addr vhost6;
    const char *vhostname;
    const char *tftp_server_name;
    const char *tftp_path;
    const char *bootfile;
    struct in_addr vdhcp_start;
    struct in_addr vnameserver;
    struct in6_addr vnameserver6;
    const char **vdnssearch;
    const char *vdomainname;
    /* Default: IF_MTU_DEFAULT */
    size_t if_mtu;
    /* Default: IF_MRU_DEFAULT */
    size_t if_mru;
    /* Prohibit connecting to 127.0.0.1:* */
    bool disable_host_loopback;
    /*
     * Enable emulation code (*warning*: this code isn't safe, it is not
     * recommended to enable it)
     */
    bool enable_emu;
    /*
     * Fields introduced in SlirpConfig version 2 begin
     */
} SlirpConfig;

</PRE>

</DL>
<P>

libvdeslirp provides helper functions to fill in the fields of
this structure, see <A HREF="/#/man/man3/libvdeslirpcfg.3.html">libvdeslirpcfg</A>(3).
<P>

Programs using libvdeslirp can send and receive packets using
vdeslirp_send and vdeslirp_recv as if they were
connected to host network (commonly the Internet) by a NAT/Masquerading
router.
vdeslirp_fd provides a valid file descriptor which can be used
to wait for incoming packets (using select or poll) and
vdeslirp_close terminates a slirp network created by
vdeslirp_open.
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>

<P>

vdeslirp_open returns the struct vdeslirp pointer in
case of success.
NULL is returned otherwise.
The return value of vdeslirp_open is the descriptor that must
be passed as first argument to all the other functions of this man page.
vdeslirp_send and vdeslirp_recv return the number of
bytes sent or received, -1 in case of error.
vdeslirp_fd returns a valid file descriptor which can be used
to wait for incoming packets (using select or poll).
vdeslirp_close returns zero in case of success, -1 in case of
error.
In case of failure, errno is set to indicate the type of
error.
<A NAME="lbAF">&nbsp;</A>
<H2>SEE ALSO</H2>

<P>

<A HREF="/#/man/man3/libvdeslirpfwd.3.html">libvdeslirpfwd</A>(3), <A HREF="/#/man/man3/libvdeslirpcfg.3.html">libvdeslirpcfg</A>(3)
<A NAME="lbAG">&nbsp;</A>
<H2>BUGS</H2>

<P>

Bug reports should be addressed to *<A HREF="mailto:info@virtualsquare.org">info@virtualsquare.org</A>*
<A NAME="lbAH">&nbsp;</A>
<H2>AUTHOR</H2>

<P>

VirtualSquare.
Project leader: Renzo Davoli.
<P>

<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT><A HREF="#lbAB">NAME</A><DD>
<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT><A HREF="#lbAE">RETURN VALUE</A><DD>
<DT><A HREF="#lbAF">SEE ALSO</A><DD>
<DT><A HREF="#lbAG">BUGS</A><DD>
<DT><A HREF="#lbAH">AUTHOR</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 15:22:07 GMT, November 27, 2023
</BODY>
</HTML>