lib/libc/net/sctp_getpaddrs.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. 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 .\"     From: @(#)send.2        8.2 (Berkeley) 2/21/94
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd December 15, 2006
  36 .Dt SCTP_GETPADDRS 3
  37 .Os
  38 .Sh NAME
  39 .Nm sctp_getpaddrs ,
  40 .Nm sctp_getladdrs
  41 .Nd return a list of addresses to the caller
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In sys/types.h
  46 .In sys/socket.h
  47 .In netinet/sctp.h
  48 .Ft int
  49 .Fn sctp_getpaddrs "int s" "sctp_assoc_t asocid" "struct sockaddr **addrs"
  50 .Ft int
  51 .Fn sctp_getladdrs "int s" "sctp_assoc_t asocid" "struct sockaddr **addrs"
  52 .Sh DESCRIPTION
  53 The
  54 .Fn sctp_getpaddrs
  55 function is used to get the list of the peers addresses.
  56 The
  57 .Fn sctp_getladdrs
  58 function is used to get the list of the local addresses.
  59 The association of interest is identified by the
  60 .Fa asocid
  61 argument.
  62 The addresses are returned in a newly allocated
  63 array of socket addresses returned in the argument
  64 .Fa addrs
  65 upon success.
  66 .Pp
  67 After the caller is finished, the function
  68 .Fn sctp_freepaddrs
  69 or
  70 .Fn sctp_freeladdrs
  71 should be used to release the memory allocated by these
  72 calls.
  73 .Sh RETURN VALUES
  74 The call returns -1 upon failure and a count of
  75 the number of addresses returned in
  76 .Fa addrs
  77 upon success.
  78 .Sh ERRORS
  79 The functions can return the following errors:
  80 .Bl -tag -width Er
  81 .It Bq Er EINVAL
  82 An address listed has an invalid family or no
  83 addresses were provided.
  84 .It Bq Er ENOMEM
  85 The call cannot allocate memory to hold the
  86 socket addresses.
  87 .It Bq Er EBADF
  88 The argument
  89 .Fa s
  90 is not a valid descriptor.
  91 .It Bq Er ENOTSOCK
  92 The argument
  93 .Fa s
  94 is not a socket.
  95 .El
  96 .Sh SEE ALSO
  97 .Xr getsockopt 2 ,
  98 .Xr sctp_freeladdrs 3 ,
  99 .Xr sctp_freepaddrs 3 ,
 100 .Xr sctp 4