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. 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_SENDMSG 2
  32 .Os
  33 .Sh NAME
  34 .Nm sctp_generic_sendmsg
  35 .Nm sctp_generic_sendmsg_iov
  36 .Nd send data to a peer
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In sys/types.h
  41 .In sys/socket.h
  42 .In netinet/sctp.h
  43 .Ft int
  44 .Fn sctp_generic_sendmsg "int s" "void *msg" "int msglen" "struct sockaddr *to" "socklen_t len" "struct sctp_sndrcvinfo *sinfo" "int flags"
  45 .Ft int
  46 .Fn sctp_generic_sendmsg_iov "int s" "struct iovec *iov" "int iovlen" "struct sockaddr *to" "struct sctp_sndrcvinfo *sinfo" "int flags"
  47 .Sh DESCRIPTION
  48 .Fn sctp_generic_sendmsg
  49 and
  50 .Fn sctp_generic_sendmsg_iov
  51 are the true system calls used by the
  52 .Xr sctp_sendmsg 3
  53 and
  54 .Xr sctp_send 3
  55 function calls.
  56 These are more efficient since they are
  57 true system calls but they are specific to
  58 .Fx
  59 and can be expected
  60 .Em not
  61 to be present on any other operating
  62 system.
  63 For detailed usage please see either the
  64 .Xr sctp_send 3
  65 or
  66 .Xr sctp_sendmsg 3
  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