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 October 30, 2007
  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 .Sh DESCRIPTION
  52 The
  53 .Fn sctp_generic_sendmsg
  54 and
  55 .Fn sctp_generic_sendmsg_iov
  56 are the true system calls used by the
  57 .Fn sctp_sendmsg
  58 and
  59 .Fn sctp_send
  60 function calls. These are more efficient since they are
  61 true system calls but they are specific to FreeBSD and
  62 can be expected NOT to be present on any other Operating
  63 System. For detailed useage please see either the
  64 .Fn sctp_send
  65 or
  66 .Fn sctp_sendmsg
  67 function calls.
  68 .Sh RETURN VALUES
  69 The call returns the number of bytes written on success and -1 upon failure.
  70 .Sh ERRORS
  71 .Bl -tag -width Er
  72 .It Bq Er EBADF
  73 The argument
  74 .Fa s
  75 is not a valid descriptor.
  76 .It Bq Er ENOTSOCK
  77 The argument
  78 .Fa s
  79 is not a socket.
  80 .El
  81 .Sh SEE ALSO
  82 .Xr sctp_send 3 ,
  83 .Xr sctp_sendmsg 3 ,
  84 .Xr sctp_sendmsgx 3 ,
  85 .Xr sctp_sendx 3 ,
  86 .Xr sctp 4