libdill: Structured Concurrency for C

NAME

ipc_fromfd_mem - wraps an existing OS-level file descriptor

SYNOPSIS

#include <libdill.h>

int ipc_fromfd_mem(
    int fd,
    struct ipc_storage* mem);

DESCRIPTION

IPC protocol is a bytestream protocol for transporting data among processes on the same machine. It is an equivalent to POSIX AF_LOCAL sockets.

This function wraps an existing OS-level file descriptor.

This function allows to avoid one dynamic memory allocation by storing the object in user-supplied memory. Unless you are hyper-optimizing use ipc_fromfd instead.

fd: File descriptor of a connected UNIX doemain socket to wrap.

mem: The structure to store the newly created object in. It must not be deallocated before the object is closed.

The socket can be cleanly shut down using ipc_close function which will also close the underlying file descriptor.

There's no way to unwrap the file descriptor.

This function is not available if libdill is compiled with --disable-sockets option.

RETURN VALUE

In case of success the function returns newly created socket handle. In case of error it returns -1 and sets errno to one of the values below.

ERRORS

EMFILE: The maximum number of file descriptors in the process are already open.
ENFILE: The maximum number of file descriptors in the system are already open.
ENOMEM: Not enough memory.

EXAMPLE

int fd = socket(AF_UNIX, SOCK_STREAM, 0);
connect(fd, addr, sizeof(addr));
int s = ipc_fromfd(fd);
bsend(s, "ABC", 3, -1);
char buf[3];
brecv(s, buf, sizeof(buf), -1);
ipc_close(s);