xref: /freebsd/lib/libc/net/sctp_getassocid.3 (revision 7c3768006d0adbe052143f13f0d969f422c9fd3e)
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.
12d8b5fd91SRandall Stewart.\" 3. All advertising materials mentioning features or use of this software
13d8b5fd91SRandall Stewart.\"    must display the following acknowledgement:
14d8b5fd91SRandall Stewart.\"	This product includes software developed by the University of
15d8b5fd91SRandall Stewart.\"	California, Berkeley and its contributors.
16d8b5fd91SRandall Stewart.\" 4. Neither the name of the University nor the names of its contributors
17d8b5fd91SRandall Stewart.\"    may be used to endorse or promote products derived from this software
18d8b5fd91SRandall Stewart.\"    without specific prior written permission.
19d8b5fd91SRandall Stewart.\"
20d8b5fd91SRandall Stewart.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21d8b5fd91SRandall Stewart.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22d8b5fd91SRandall Stewart.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23d8b5fd91SRandall Stewart.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24d8b5fd91SRandall Stewart.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25d8b5fd91SRandall Stewart.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26d8b5fd91SRandall Stewart.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27d8b5fd91SRandall Stewart.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28d8b5fd91SRandall Stewart.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29d8b5fd91SRandall Stewart.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30d8b5fd91SRandall Stewart.\" SUCH DAMAGE.
31d8b5fd91SRandall Stewart.\"
32d8b5fd91SRandall Stewart.\" $FreeBSD$
33d8b5fd91SRandall Stewart.\"
34d8b5fd91SRandall Stewart.Dd December 15, 2006
35d8b5fd91SRandall Stewart.Dt SCTP_GETASSOCID 3
36d8b5fd91SRandall Stewart.Os
37d8b5fd91SRandall Stewart.Sh NAME
38d8b5fd91SRandall Stewart.Nm sctp_getassocid
39d8b5fd91SRandall Stewart.Nd return an association id for a specified socket address.
40d8b5fd91SRandall Stewart.Sh LIBRARY
41d8b5fd91SRandall Stewart.Lb libc
42d8b5fd91SRandall Stewart.Sh SYNOPSIS
43d8b5fd91SRandall Stewart.In sys/types.h
44d8b5fd91SRandall Stewart.In sys/socket.h
457c376800SRandall Stewart.In netinet/sctp.h
46d8b5fd91SRandall Stewart.Ft sctp_assoc_t
47d8b5fd91SRandall Stewart.Fn sctp_getassocid "int s" "struct sockaddr *addr"
48d8b5fd91SRandall Stewart.Sh DESCRIPTION
49d8b5fd91SRandall StewartThe
50d8b5fd91SRandall Stewart.Fn sctp_getassocid
51d8b5fd91SRandall Stewartcall attempts to lookup the specified socket address
52d8b5fd91SRandall Stewart.Fa addr
53d8b5fd91SRandall Stewartand find the respective association identification.
54d8b5fd91SRandall Stewart.Pp
55d8b5fd91SRandall Stewart.Sh RETURN VALUES
56d8b5fd91SRandall StewartThe call returns the association id upon success and a
57d8b5fd91SRandall Stewart0 is returned upon failure.
58d8b5fd91SRandall Stewart.Sh ERRORS
59d8b5fd91SRandall StewartThe
60d8b5fd91SRandall Stewart.Fn sctp_getassocid
61d8b5fd91SRandall Stewartfunction can return the following errors.
62d8b5fd91SRandall Stewart.Bl -tag -width Er
63d8b5fd91SRandall Stewart.It Bq Er ENOENT
64d8b5fd91SRandall StewartThe address does not have an association setup to it.
65d8b5fd91SRandall Stewart.It Bq Er EBADF
66d8b5fd91SRandall StewartThe argument
67d8b5fd91SRandall Stewart.Fa s
68d8b5fd91SRandall Stewartis not a valid descriptor.
69d8b5fd91SRandall Stewart.It Bq Er ENOTSOCK
70d8b5fd91SRandall StewartThe argument
71d8b5fd91SRandall Stewart.Fa s
72d8b5fd91SRandall Stewartis not a socket.
73d8b5fd91SRandall Stewart.El
74d8b5fd91SRandall Stewart.Sh SEE ALSO
75d8b5fd91SRandall Stewart.Xr sctp 4 ,
76d8b5fd91SRandall Stewart
77