xref: /freebsd/lib/libsys/sctp_generic_sendmsg.2 (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
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.Dd October 30, 2007
29.Dt SCTP_GENERIC_SENDMSG 2
30.Os
31.Sh NAME
32.Nm sctp_generic_sendmsg ,
33.Nm sctp_generic_sendmsg_iov
34.Nd send data to a peer
35.Sh LIBRARY
36.Lb libc
37.Sh SYNOPSIS
38.In sys/types.h
39.In sys/socket.h
40.In netinet/sctp.h
41.Ft int
42.Fn sctp_generic_sendmsg "int s" "void *msg" "int msglen" "struct sockaddr *to" "socklen_t len" "struct sctp_sndrcvinfo *sinfo" "int flags"
43.Ft int
44.Fn sctp_generic_sendmsg_iov "int s" "struct iovec *iov" "int iovlen" "struct sockaddr *to" "struct sctp_sndrcvinfo *sinfo" "int flags"
45.Sh DESCRIPTION
46.Fn sctp_generic_sendmsg
47and
48.Fn sctp_generic_sendmsg_iov
49are the true system calls used by the
50.Xr sctp_sendmsg 3
51and
52.Xr sctp_send 3
53function calls.
54These are more efficient since they are
55true system calls but they are specific to
56.Fx
57and can be expected
58.Em not
59to be present on any other operating
60system.
61For detailed usage please see either the
62.Xr sctp_send 3
63or
64.Xr sctp_sendmsg 3
65function calls.
66.Sh RETURN VALUES
67The call returns the number of bytes written on success and -1 upon failure.
68.Sh ERRORS
69.Bl -tag -width Er
70.It Bq Er EBADF
71The argument
72.Fa s
73is not a valid descriptor.
74.It Bq Er ENOTSOCK
75The argument
76.Fa s
77is not a socket.
78.El
79.Sh SEE ALSO
80.Xr sctp_send 3 ,
81.Xr sctp_sendmsg 3 ,
82.Xr sctp_sendmsgx 3 ,
83.Xr sctp_sendx 3 ,
84.Xr sctp 4
85