xref: /freebsd/lib/libsys/sctp_generic_recvmsg.2 (revision 783d3ff6)
1.\" Copyright (c) 1983, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd October 30, 2007
29.Dt SCTP_GENERIC_RECVMSG 2
30.Os
31.Sh NAME
32.Nm sctp_generic_recvmsg
33.Nd receive data from a peer
34.Sh LIBRARY
35.Lb libc
36.Sh SYNOPSIS
37.In sys/types.h
38.In sys/socket.h
39.In netinet/sctp.h
40.Ft int
41.Fn sctp_generic_recvmsg "int s" "struct iovec *iov" "int iovlen" "struct sockaddr *from" "socklen_t *fromlen" "struct sctp_sndrcvinfo *sinfo" "int *msgflags"
42.Sh DESCRIPTION
43.Fn sctp_generic_recvmsg
44is the true system call used by the
45.Xr sctp_recvmsg 3
46function call.
47This call is more efficient since it is a
48true system call but it is specific to
49.Fx
50and can be expected
51.Em not
52to be present on any other operating
53system.
54For detailed usage please see the
55.Xr sctp_recvmsg 3
56function call.
57.Sh RETURN VALUES
58The call returns the number of bytes read on success and -1 upon failure.
59.Sh ERRORS
60.Bl -tag -width Er
61.It Bq Er EBADF
62The argument
63.Fa s
64is not a valid descriptor.
65.It Bq Er ENOTSOCK
66The argument
67.Fa s
68is not a socket.
69.El
70.Sh SEE ALSO
71.Xr sctp_recvmsg 3 ,
72.Xr sctp 4
73