Go to main content

man pages section 3: Basic Library Functions

Exit Print View

Updated: Thursday, June 13, 2019
 
 

sctp_recvmsg(3C)

Name

sctp_recvmsg - receive message from an SCTP socket

Synopsis

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

ssize_t sctp_recvmsg(int s, void *msg, size_t len, struct sockaddr *from,
     socklen_t *fromlen, struct sctp_sndrcvinfo *sinfo, int *msg_flags);

Description

The sctp_recvmsg() function receives a message from the SCTP endpoint s.

In addition to specifying the message buffer msg and the length len of the buffer, the following parameters can be set:

from

Pointer to an address, filled in with the sender's address

fromlen

Size of the buffer associated with the from parameter

sinfo

Pointer to an sctp_sndrcvinfo structure, filled in upon the receipt of the message

msg_flags

Message flags such as MSG_CTRUNC, MSG_NOTIFICATION , MSG_EOR

The sinfo parameter is filled in only when the caller has enabled sctp_data_io_events by calling setsockopt() with the socket option SCTP_EVENTS.

Return Values

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

Errors

The sctp_recvmsg() 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_OOB is set as a flag.

ENOTCONN

There is no established association.

Attributes

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

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
Safe

See Also

in.h(3HEAD), accept(3C), bind(3C), connect(3C), listen(3C), recvmsg(3C), sctp_opt_info(3C), setsockopt(3C), socket(3C), socket.h(3HEAD), libsctp(3LIB), sctp(4P)