xref: /freebsd/lib/libc/net/sctp_getassocid.3 (revision 921ca2fd115b858c23058f4a9a3776050cbab528)
1d8b5fd91SRandall Stewart.\" Copyright (c) 1983, 1991, 1993
2d8b5fd91SRandall Stewart.\"	The Regents of the University of California.  All rights reserved.
3d8b5fd91SRandall Stewart.\"
4d8b5fd91SRandall Stewart.\" Redistribution and use in source and binary forms, with or without
5d8b5fd91SRandall Stewart.\" modification, are permitted provided that the following conditions
6d8b5fd91SRandall Stewart.\" are met:
7d8b5fd91SRandall Stewart.\" 1. Redistributions of source code must retain the above copyright
8d8b5fd91SRandall Stewart.\"    notice, this list of conditions and the following disclaimer.
9d8b5fd91SRandall Stewart.\" 2. Redistributions in binary form must reproduce the above copyright
10d8b5fd91SRandall Stewart.\"    notice, this list of conditions and the following disclaimer in the
11d8b5fd91SRandall Stewart.\"    documentation and/or other materials provided with the distribution.
12*921ca2fdSEd Maste.\" 3. Neither the name of the University nor the names of its contributors
13d8b5fd91SRandall Stewart.\"    may be used to endorse or promote products derived from this software
14d8b5fd91SRandall Stewart.\"    without specific prior written permission.
15d8b5fd91SRandall Stewart.\"
16d8b5fd91SRandall Stewart.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17d8b5fd91SRandall Stewart.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18d8b5fd91SRandall Stewart.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19d8b5fd91SRandall Stewart.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20d8b5fd91SRandall Stewart.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21d8b5fd91SRandall Stewart.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22d8b5fd91SRandall Stewart.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23d8b5fd91SRandall Stewart.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24d8b5fd91SRandall Stewart.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25d8b5fd91SRandall Stewart.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26d8b5fd91SRandall Stewart.\" SUCH DAMAGE.
27d8b5fd91SRandall Stewart.\"
28d8b5fd91SRandall Stewart.\" $FreeBSD$
29d8b5fd91SRandall Stewart.\"
30d8b5fd91SRandall Stewart.Dd December 15, 2006
31d8b5fd91SRandall Stewart.Dt SCTP_GETASSOCID 3
32d8b5fd91SRandall Stewart.Os
33d8b5fd91SRandall Stewart.Sh NAME
34d8b5fd91SRandall Stewart.Nm sctp_getassocid
35d8b5fd91SRandall Stewart.Nd return an association id for a specified socket address.
36d8b5fd91SRandall Stewart.Sh LIBRARY
37d8b5fd91SRandall Stewart.Lb libc
38d8b5fd91SRandall Stewart.Sh SYNOPSIS
39d8b5fd91SRandall Stewart.In sys/types.h
40d8b5fd91SRandall Stewart.In sys/socket.h
417c376800SRandall Stewart.In netinet/sctp.h
42d8b5fd91SRandall Stewart.Ft sctp_assoc_t
43d8b5fd91SRandall Stewart.Fn sctp_getassocid "int s" "struct sockaddr *addr"
44d8b5fd91SRandall Stewart.Sh DESCRIPTION
45d8b5fd91SRandall StewartThe
46d8b5fd91SRandall Stewart.Fn sctp_getassocid
47d8b5fd91SRandall Stewartcall attempts to look up the specified socket address
48d8b5fd91SRandall Stewart.Fa addr
49d8b5fd91SRandall Stewartand find the respective association identification.
50d8b5fd91SRandall Stewart.Sh RETURN VALUES
5116c90ceeSChristian BruefferThe call returns the association id upon success and
52d8b5fd91SRandall Stewart0 is returned upon failure.
53d8b5fd91SRandall Stewart.Sh ERRORS
54d8b5fd91SRandall StewartThe
55d8b5fd91SRandall Stewart.Fn sctp_getassocid
56a47698f8SChristian Bruefferfunction can return the following errors:
57d8b5fd91SRandall Stewart.Bl -tag -width Er
58d8b5fd91SRandall Stewart.It Bq Er ENOENT
59d8b5fd91SRandall StewartThe address does not have an association setup to it.
60d8b5fd91SRandall Stewart.It Bq Er EBADF
61d8b5fd91SRandall StewartThe argument
62d8b5fd91SRandall Stewart.Fa s
63d8b5fd91SRandall Stewartis not a valid descriptor.
64d8b5fd91SRandall Stewart.It Bq Er ENOTSOCK
65d8b5fd91SRandall StewartThe argument
66d8b5fd91SRandall Stewart.Fa s
67d8b5fd91SRandall Stewartis not a socket.
68d8b5fd91SRandall Stewart.El
69d8b5fd91SRandall Stewart.Sh SEE ALSO
7016c90ceeSChristian Brueffer.Xr sctp 4
71