mirror of
https://github.com/freebsd/freebsd-src
synced 2024-07-24 11:47:20 +00:00
5590bacaaf
Add missing documentation for sctp_sendv(3) and sctp_recvv(3). Add a note that sctp_send(3), sctp_sendx(3) and sctp_recvmsg(3) are deprecated by RFC 6458. Add a STANDARDS section to all functions specified in RFC 6458 to indicate their standards conformance. MFC after: 2 weeks Reviewed by: imp, bcr, kp, tuexen Pull Request: https://github.com/freebsd/freebsd-src/pull/965
78 lines
2.5 KiB
Groff
78 lines
2.5 KiB
Groff
.\" Copyright (c) 1983, 1991, 1993
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. Neither the name of the University nor the names of its contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.Dd February 2, 2024
|
|
.Dt SCTP_FREEPADDRS 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm sctp_freepaddrs ,
|
|
.Nm sctp_freeladdrs
|
|
.Nd release the memory returned from a previous call
|
|
.Sh LIBRARY
|
|
.Lb libc
|
|
.Sh SYNOPSIS
|
|
.In sys/types.h
|
|
.In sys/socket.h
|
|
.In netinet/sctp.h
|
|
.Ft void
|
|
.Fn sctp_freepaddrs "struct sockaddr *"
|
|
.Ft void
|
|
.Fn sctp_freeladdrs "struct sockaddr *"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn sctp_freepaddrs
|
|
and
|
|
.Fn sctp_freeladdrs
|
|
functions are used to release the memory allocated by previous
|
|
calls to
|
|
.Fn sctp_getpaddrs
|
|
or
|
|
.Fn sctp_getladdrs
|
|
respectively.
|
|
.Sh RETURN VALUES
|
|
none.
|
|
.Sh SEE ALSO
|
|
.Xr sctp_getladdrs 3 ,
|
|
.Xr sctp_getpaddrs 3 ,
|
|
.Xr sctp 4
|
|
.Rs
|
|
.%A R. Stewart
|
|
.%A M. Tuexen
|
|
.%A K. Poon
|
|
.%A P. Lei
|
|
.%A V. Yasevich
|
|
.%T Sockets API Extensions for the Stream Control Transmission Protocol (SCTP)
|
|
.%R RFC 6458
|
|
.%D December 2011
|
|
.Re
|
|
.Sh STANDARDS
|
|
The
|
|
.Fn sctp_freepaddrs
|
|
and
|
|
.Fn sctp_freeladdrs
|
|
functions conform to RFC 6458.
|