lib/libc/net/sctp_getassocid.3

   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 .\" $FreeBSD$
  29 .\"
  30 .Dd December 15, 2006
  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
  45 The
  46 .Fn sctp_getassocid
  47 call attempts to look up the specified socket address
  48 .Fa addr
  49 and find the respective association identification.
  50 .Sh RETURN VALUES
  51 The call returns the association id upon success and
  52 0 is returned upon failure.
  53 .Sh ERRORS
  54 The
  55 .Fn sctp_getassocid
  56 function can return the following errors:
  57 .Bl -tag -width Er
  58 .It Bq Er ENOENT
  59 The address does not have an association setup to it.
  60 .It Bq Er EBADF
  61 The argument
  62 .Fa s
  63 is not a valid descriptor.
  64 .It Bq Er ENOTSOCK
  65 The argument
  66 .Fa s
  67 is not a socket.
  68 .El
  69 .Sh SEE ALSO
  70 .Xr sctp 4