1.\" $NetBSD: sctp_getassocid.3,v 1.2 2018/08/13 06:00:21 wiz Exp $ 2.\" 3.\" Copyright (c) 1983, 1991, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. Neither the name of the University nor the names of its contributors 15.\" may be used to endorse or promote products derived from this software 16.\" without specific prior written permission. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28.\" SUCH DAMAGE. 29.\" 30.Dd August 1, 2018 31.Dt SCTP_GETASSOCID 3 32.Os 33.Sh NAME 34.Nm sctp_getassocid 35.Nd return an association id for a specified socket address 36.Sh LIBRARY 37.Lb libc 38.Sh SYNOPSIS 39.In sys/types.h 40.In sys/socket.h 41.In netinet/sctp.h 42.Ft sctp_assoc_t 43.Fn sctp_getassocid "int s" "struct sockaddr *addr" 44.Sh DESCRIPTION 45The 46.Fn sctp_getassocid 47call attempts to look up the specified socket address 48.Fa addr 49and find the respective association identification. 50.Sh RETURN VALUES 51The call returns the association id upon success and 520 is returned upon failure. 53.Sh ERRORS 54The 55.Fn sctp_getassocid 56function can return the following errors: 57.Bl -tag -width Er 58.It Bq Er EBADF 59The argument 60.Fa s 61is not a valid descriptor. 62.It Bq Er ENOENT 63The address does not have an association setup to it. 64.It Bq Er ENOTSOCK 65The argument 66.Fa s 67is not a socket. 68.El 69.Sh SEE ALSO 70.Xr sctp 4 71.Rs 72.%R RFC 73.%N 6458 74.%T "Sockets API Extensions for the Stream Control Transmission Protocol (SCTP)" 75.%D December 2011 76.Re 77.Sh HISTORY 78This function first appeared in 79.Nx 9.0 . 80