libdill: Structured Concurrency for C

NAME

suffix_detach - terminates SUFFIX protocol and returns the underlying socket

SYNOPSIS

#include <libdill.h>

int suffix_detach(
    int s,
    int64_t deadline);

DESCRIPTION

SUFFIX is a message-based protocol that delimits messages by specific byte sequences. For example, many protocols are line-based, with individual messages separated by CR+LF sequence.

This function does the terminal handshake and returns underlying socket to the user. The socket is closed even in the case of error.

s: Handle of the SUFFIX socket.

deadline: A point in time when the operation should time out, in milliseconds. Use the now function to get your current point in time. 0 means immediate timeout, i.e., perform the operation if possible or return without blocking if not. -1 means no deadline, i.e., the call will block forever if the operation cannot be performed.

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

RETURN VALUE

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

ERRORS

EBADF: Invalid handle.
ECANCELED: Current coroutine was canceled.
ECONNRESET: Broken connection.
ENOTSUP: The handle is not a SUFFIX protocol handle.
ETIMEDOUT: Deadline was reached.

EXAMPLE

        int s = tcp_connect(&addr, -1);
        s = suffix_attach(s, "
", 2);
        msend(s, "ABC", 3, -1);
        char buf[256];
        ssize_t sz = mrecv(s, buf, sizeof(buf), -1);
        s = suffix_detach(s, -1);
        tcp_close(s);