xref: /illumos-gate/usr/src/man/man3socket/sctp_send.3socket (revision 8226594fdd4479be135127f43632f1f995074654)
te
Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
SCTP_SEND 3SOCKET "Mar 19, 2004"
NAME
sctp_send - send message from an SCTP socket
SYNOPSIS

cc [ flag... ] file... -lsocket  -lnsl   -lsctp  [ library... ]
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/sctp.h>

ssize_t sctp_send(int s, const void *msg, size_t *len,
 const struct sctp_sndrcvinfo *sinfo, int flags);
DESCRIPTION

The sctp_send() function sends messages from one-to-one and one-to-many style SCTP endpoints. The following parameters can be set: s

Socket created by socket(3SOCKET)

msg

Message to be sent

len

Size of the message to be sent in bytes

The caller completes the sinfo parameter with values used to send a message. Such values might include the stream number, payload protocol identifier, time to live, and the SCTP message flag and context. For a one-to-many socket, the association ID can be specified in the sinfo parameter to send a message to the association represented in the ID.

Flags supported for sctp_send() are reserved for future use.

RETURN VALUES

Upon successful completion, the sctp_send() function returns the number of bytes sent. The function returns -1 if an error occurs.

ERRORS

The sctp_send() function fails under the following conditions. EBADF

The s argument is an invalid file descriptor.

ENOTSOCK

The s argument is not a socket.

EOPNOTSUPP

MSG_ABORT or MSG_EOF is set in the sinfo_flags field of sinfo for a one-to-one style SCTP socket.

EPIPE

The socket is shutting down and no more writes are allowed.

EAGAIN

The socket is non-blocking and the transmit queue is full.

ENOTCONN

There is no established association.

EINVAL

Control message length is incorrect.

EINVAL

Specified destination address does not belong to the association.

EINVAL

The stream_no is outside the number of outbound streams supported by the association.

EAFNOSUPPORT

Address family of the specified destination address is other than AF_INET or AF_INET6.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Evolving
MT-Level Safe
SEE ALSO

in.h (3HEAD), socket.h (3HEAD), libsctp (3LIB), accept (3SOCKET), bind (3SOCKET), connect (3SOCKET), listen (3SOCKET), sctp_sendmsg (3SOCKET), sendmsg (3SOCKET), socket (3SOCKET), sctp (4P)