2007-02-22 15:32:39 +01:00
|
|
|
.\" Copyright (c) 1983, 1991, 1993
|
|
|
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
|
.\" are met:
|
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
|
|
|
.\" must display the following acknowledgement:
|
|
|
|
|
.\" This product includes software developed by the University of
|
|
|
|
|
.\" California, Berkeley and its contributors.
|
|
|
|
|
.\" 4. Neither the name of the University nor the names of its contributors
|
|
|
|
|
.\" may be used to endorse or promote products derived from this software
|
|
|
|
|
.\" without specific prior written permission.
|
|
|
|
|
.\"
|
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
|
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
|
.\" SUCH DAMAGE.
|
|
|
|
|
.\"
|
|
|
|
|
.\" $FreeBSD$
|
|
|
|
|
.\"
|
2007-10-30 16:36:40 +01:00
|
|
|
.Dd October 30, 2007
|
2007-02-22 15:32:39 +01:00
|
|
|
.Dt SCTP_GENERIC_RECVMSG 2
|
|
|
|
|
.Os
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm sctp_generic_recvmsg
|
|
|
|
|
.Nd receive data from a peer.
|
|
|
|
|
.Sh LIBRARY
|
|
|
|
|
.Lb libc
|
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.In sys/types.h
|
|
|
|
|
.In sys/socket.h
|
2007-02-26 13:23:32 +01:00
|
|
|
.In netinet/sctp.h
|
2007-02-22 15:32:39 +01:00
|
|
|
.Ft int
|
|
|
|
|
.Fn sctp_generic_recvmsg "int s" "struct iovec *iov" "int iovlen" "struct sockaddr *from" "socklen_t *fromlen" "struct sctp_sndrcvinfo *sinfo" "int *msgflags"
|
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
The
|
|
|
|
|
.Fn sctp_generic_recvmsg
|
|
|
|
|
is the true system calls used by the
|
|
|
|
|
.Fn sctp_recvmsg
|
|
|
|
|
function call. This call is more efficient since it is a
|
|
|
|
|
true system calls but it is specific to FreeBSD and
|
|
|
|
|
can be expected NOT to be present on any other Operating
|
|
|
|
|
System. For detailed useage please see either the
|
|
|
|
|
.Fn sctp_recvmsg
|
|
|
|
|
function call.
|
|
|
|
|
.Sh RETURN VALUES
|
|
|
|
|
The call returns the number of bytes read on success and -1 upon failure.
|
|
|
|
|
.Sh ERRORS
|
|
|
|
|
.Bl -tag -width Er
|
|
|
|
|
.It Bq Er EBADF
|
|
|
|
|
The argument
|
|
|
|
|
.Fa s
|
|
|
|
|
is not a valid descriptor.
|
|
|
|
|
.It Bq Er ENOTSOCK
|
|
|
|
|
The argument
|
|
|
|
|
.Fa s
|
|
|
|
|
is not a socket.
|
|
|
|
|
.El
|
|
|
|
|
.Sh SEE ALSO
|
|
|
|
|
.Xr sctp_recvmsg 3 ,
|
2009-04-13 20:32:26 +02:00
|
|
|
.Xr sctp 4
|
