document the so_upcall option to socreate
authorphessler <phessler@openbsd.org>
Wed, 27 Jul 2016 13:02:50 +0000 (13:02 +0000)
committerphessler <phessler@openbsd.org>
Wed, 27 Jul 2016 13:02:50 +0000 (13:02 +0000)
share/man/man9/socreate.9

index 27229a1..978a924 100644 (file)
@@ -1,4 +1,4 @@
-.\"    $OpenBSD: socreate.9,v 1.5 2015/11/03 00:13:17 dlg Exp $
+.\"    $OpenBSD: socreate.9,v 1.6 2016/07/27 13:02:50 phessler Exp $
 .\"
 .\" Copyright (c) 2006 Robert N. M. Watson
 .\" All rights reserved.
@@ -26,7 +26,7 @@
 .\"
 .\" $FreeBSD: src/share/man/man9/socket.9,v 1.2 2006/12/16 10:32:10 rwatson Exp $
 .\"
-.Dd $Mdocdate: November 3 2015 $
+.Dd $Mdocdate: July 27 2016 $
 .Dt SOCREATE 9
 .Os
 .Sh NAME
@@ -35,6 +35,7 @@
 .Nm soconnect ,
 .Nm socreate ,
 .Nm soreceive ,
+.Nm so_upcall ,
 .Nm sosetopt ,
 .Nm sogetopt ,
 .Nm sosend ,
@@ -59,6 +60,8 @@
 .Fa "struct mbuf **mp0" "struct mbuf **controlp" "int *flagsp"
 .Fa "socklen_t controllen"
 .Fc
+.Ft void
+.Fn (*so_upcall) "struct socket *so" "caddr_t arg" "int waitflag"
 .Ft int
 .Fn sosetopt "struct socket *so" "int level" "int optname" "struct mbuf *m0"
 .Ft int
@@ -223,6 +226,12 @@ argument, and use the same flag name space as the
 .Xr recvmsg 2
 system call.
 .Pp
+When the
+.Fn so_upcall
+function pointer is not NULL, it is called when
+.Xr soreceive 9
+matches an incoming connection.
+.Pp
 The
 .Fn sosend
 function is equivalent to the