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