explain_socketpair_or_die(3) [debian man page]

explain_socketpair_or_die(3)				     Library Functions Manual				      explain_socketpair_or_die(3)

NAME

       explain_socketpair_or_die - create pair of connected sockets and report errors

SYNOPSIS

       #include <libexplain/socketpair.h>
       void explain_socketpair_or_die(int domain, int type, int protocol, int *sv);
       int explain_socketpair_on_error(int domain, int type, int protocol, int *sv);

DESCRIPTION

       The  explain_socketpair_or_die function is used to call the socketpair(2) system call. On failure an explanation will be printed to stderr,
       obtained from the explain_socketpair(3) function, and then the process terminates by calling exit(EXIT_FAILURE).

       The explain_socketpair_on_error function is used to call the socketpair(2) system call. On  failure  an	explanation  will  be  printed	to
       stderr, obtained from the explain_socketpair(3) function, but still returns to the caller.

       domain  The domain, exactly as to be passed to the socketpair(2) system call.

       type    The type, exactly as to be passed to the socketpair(2) system call.

       protocol
	       The protocol, exactly as to be passed to the socketpair(2) system call.

       sv      The sv, exactly as to be passed to the socketpair(2) system call.

RETURN VALUE

       The  explain_socketpair_or_die  function only returns on success, see socketpair(2) for more information. On failure, prints an explanation
       and exits, it does not return.

       The explain_socketpair_on_error function always returns the value return by the wrapped socketpair(2) system call.

EXAMPLE

       The explain_socketpair_or_die function is intended to be used in a fashion similar to the following example:
	      explain_socketpair_or_die(domain, type, protocol, sv);

SEE ALSO

       socketpair(2)
	       create a pair of connected sockets

       explain_socketpair(3)
	       explain socketpair(2) errors

       exit(2) terminate the calling process

COPYRIGHT

       libexplain version 0.52
       Copyright (C) 2010 Peter Miller

														      explain_socketpair_or_die(3)

socketpair(3SOCKET)					     Sockets Library Functions					       socketpair(3SOCKET)

NAME

       socketpair - create a pair of connected sockets

SYNOPSIS

       cc [ flag ... ] file ... -lsocket -lnsl [ library ... ]
       #include <sys/types.h>
       #include <sys/socket.h>

       int socketpair(int domain, int type, int protocol, int sv[2]);

DESCRIPTION

       The  socketpair()  library call creates an unnamed pair of connected sockets in the specified address family domain, of the specified type,
       that uses the optionally specified protocol. The descriptors that are used in referencing the new sockets are returned in sv[0] and  sv[1].
       The two sockets are indistinguishable.

RETURN VALUES

       socketpair() returns -1 on failure and 0 on success.

ERRORS

       The call succeeds unless:

       EAFNOSUPPORT		       The specified address family is not supported on this machine.

       EMFILE			       Too many descriptors are in use by this process.

       ENOMEM			       There was insufficient user memory for the operation to complete.

       ENOSR			       There were insufficient STREAMS resources for the operation to complete.

       EOPNOTSUPP		       The specified protocol does not support creation of socket pairs.

       EPROTONOSUPPORT		       The specified protocol is not supported on this machine.

       EACCES			       The process does not have appropriate privileges.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       pipe(2), read(2), write(2), socket.h(3HEAD), attributes(5)

NOTES

       This call is currently implemented only for the AF_UNIX address family.

SunOS 5.10							    10 Jan 2001 					       socketpair(3SOCKET)