lib/libc/sys/sctp_generic_sendmsg.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. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\" $FreeBSD$
  33 .\"
  34 .Dd December 15, 2006
  35 .Dt SCTP_GENERIC_SENDMSG 2
  36 .Os
  37 .Sh NAME
  38 .Nm sctp_generic_sendmsg
  39 .Nm sctp_generic_sendmsg_iov
  40 .Nd send data to a peer.
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In sys/types.h
  45 .In sys/socket.h
  46 .In netinet/sctp.h
  47 .Ft int
  48 .Fn sctp_generic_sendmsg "int s" "void *msg" "int msglen" "struct sockaddr *to" "socklen_t len" "struct sctp_sndrcvinfo *sinfo" "int flags"
  49 .Ft int
  50 .Fn sctp_generic_sendmsg_iov "int s" "struct iovec *iov" "int iovlen" "struct sockaddr *to" "struct sctp_sndrcvinfo *sinfo" "int flags"
  51
  52 .Sh DESCRIPTION
  53 The
  54 .Fn sctp_generic_sendmsg
  55 and
  56 .Fn sctp_generic_sendmsg_iov
  57 are the true system calls used by the
  58 .Fn sctp_sendmsg
  59 and
  60 .Fn sctp_send
  61 function calls. These are more efficient since they are
  62 true system calls but they are specific to FreeBSD and
  63 can be expected NOT to be present on any other Operating
  64 System. For detailed useage please see either the
  65 .Fn sctp_send
  66 or
  67 .Fn sctp_sendmsg
  68 function calls.
  69 .Sh RETURN VALUES
  70 The call returns the number of bytes written on success and -1 upon failure.
  71 .Sh ERRORS
  72 .Bl -tag -width Er
  73 .It Bq Er EBADF
  74 The argument
  75 .Fa s
  76 is not a valid descriptor.
  77 .It Bq Er ENOTSOCK
  78 The argument
  79 .Fa s
  80 is not a socket.
  81 .El
  82 .Sh SEE ALSO
  83 .Xr sctp 4 ,
  84 .Xr sctp_send 3 ,
  85 .Xr sctp_sendx 3 ,
  86 .Xr sctp_sendmsg 3 ,
  87 .Xr sctp_sendmsgx 3 ,
  88