lib/libc/sys/sctp_generic_recvmsg.2

   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 .\" $FreeBSD$
  29 .\"
  30 .Dd October 30, 2007
  31 .Dt SCTP_GENERIC_RECVMSG 2
  32 .Os
  33 .Sh NAME
  34 .Nm sctp_generic_recvmsg
  35 .Nd receive data from a peer
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In sys/types.h
  40 .In sys/socket.h
  41 .In netinet/sctp.h
  42 .Ft int
  43 .Fn sctp_generic_recvmsg "int s" "struct iovec *iov" "int iovlen" "struct sockaddr *from" "socklen_t *fromlen" "struct sctp_sndrcvinfo *sinfo" "int *msgflags"
  44 .Sh DESCRIPTION
  45 .Fn sctp_generic_recvmsg
  46 is the true system call used by the
  47 .Xr sctp_recvmsg 3
  48 function call.
  49 This call is more efficient since it is a
  50 true system call but it is specific to
  51 .Fx
  52 and can be expected
  53 .Em not
  54 to be present on any other operating
  55 system.
  56 For detailed usage please see the
  57 .Xr sctp_recvmsg 3
  58 function call.
  59 .Sh RETURN VALUES
  60 The call returns the number of bytes read on success and -1 upon failure.
  61 .Sh ERRORS
  62 .Bl -tag -width Er
  63 .It Bq Er EBADF
  64 The argument
  65 .Fa s
  66 is not a valid descriptor.
  67 .It Bq Er ENOTSOCK
  68 The argument
  69 .Fa s
  70 is not a socket.
  71 .El
  72 .Sh SEE ALSO
  73 .Xr sctp_recvmsg 3 ,
  74 .Xr sctp 4