socketpair(2)

socketpair2

Create a pair of connected sockets

Usage

#include <sys/types.h>

#include <sys/socket.h>

int

socketpair(int domain, int type, int protocol, int *sv);

Library

Standard C Library (libc, -lc)

Overview

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

The SOCK_CLOEXEC, SOCK_CLOFORK and SOCK_NONBLOCK flags in the type argument apply to both descriptors.

Return values

The socketpair() function returns the value 0 if successful; otherwise the value -1 is returned and the global variable errno is set to indicate the error.

Errors

The call succeeds unless:

[EMFILE]

Too many descriptors are in use by this process.

[EAFNOSUPPORT]

The specified address family is not supported on this machine.

[EPROTONOSUPPORT]

The specified protocol is not supported on this machine.

[EOPNOTSUPP]

The specified protocol does not support creation of socket pairs.

[EFAULT]

The address sv does not specify a valid part of the process address space.

Releases

87 releases since FreeBSD 2.0.5-RELEASE; the text changed 43 times.

  1. 2.0.5–2.1.7.1
  2. 2.2.2–3.4
  3. 3.5–3.5.1
  4. 4.0
  5. 4.1–4.2
  6. 4.3
  7. 4.4
  8. 4.5–4.11
  9. 5.0
  10. 5.1–5.5
  11. 6.0–6.3
  12. 6.4
  13. 7.0
  14. 7.1
  15. 7.2
  16. 7.3
  17. 7.4
  18. 8.0
  19. 8.1
  20. 8.2
  21. 8.3
  22. 8.4
  23. 9.0
  24. 9.1
  25. 9.2
  26. 9.3
  27. 10.0
  28. 10.1
  29. 10.2
  30. 10.3
  31. 10.4
  32. 11.0
  33. 11.1
  34. 11.2
  35. 11.3
  36. 11.4
  37. 12.0
  38. 12.1
  39. 12.2
  40. 12.3
  41. 12.4
  42. 13.0–13.2
  43. 13.3–14.5
  44. 15.0–16.0

Standards

The socketpair() system call conforms to IEEE Std 1003.1-2001 (“POSIX.1”) and IEEE Std 1003.1-2008 (“POSIX.1”).

History

The socketpair() system call appeared in 4.2BSD.

Bugs

This call is currently implemented only for the UNIX domain.

From base 16.0-CURRENT-20261027-61c70dc16a79 in FreeBSD 16.0-CURRENT (2026-10-27). Parsed by carta from the page's mdoc source.