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