usr/src/man/man3dlpi/dlpi_enabmulti.3dlpi

   1 '\" te
   2 .\"  Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH DLPI_ENABMULTI 3DLPI "Aug 22, 2007"
   7 .SH NAME
   8 dlpi_enabmulti, dlpi_disabmulti \- enable or disable DLPI multicast messages
   9 for an address
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-ldlpi\fR [ \fIlibrary\fR... ]
  14 #include <libdlpi.h>
  15
  16 \fBint\fR \fBdlpi_enabmulti\fR(\fBdlpi_handle_t\fR \fIdh\fR, \fBconst void *\fR\fIaddrp\fR,
  17      \fBsize_t\fR \fIaddrlen\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBint\fR \fBdlpi_disabmulti\fR(\fBdlpi_handle_t\fR \fIdh\fR, \fBconst void *\fR\fIaddrp\fR,
  23      \fBsize_t\fR \fIaddrlen\fR);
  24 .fi
  25
  26 .SH DESCRIPTION
  27 .sp
  28 .LP
  29 The \fBdlpi_enabmulti()\fR function enables reception of messages destined to
  30 the multicast address pointed to by \fIaddrp\fR on the \fBDLPI\fR link instance
  31 associated with \fBDLPI\fR handle \fIdh\fR. The \fBDLPI\fR link instance will
  32 pass up only those messages destined for enabled multicast addresses. This
  33 operation can be performed in any \fBDLPI\fR state of a handle.
  34 .sp
  35 .LP
  36 The \fBdlpi_disabmulti()\fR function disables a specified multicast address
  37 pointed to by \fIaddrp\fR on the \fBDLPI\fR link instance associated with
  38 \fBDLPI\fR handle \fIdh\fR. This operation can be performed in any \fBDLPI\fR
  39 state of a handle.
  40 .SH RETURN VALUES
  41 .sp
  42 .LP
  43 Upon success, \fBDLPI_SUCCESS\fR is returned. If \fBDL_SYSERR\fR is returned,
  44 \fBerrno\fR contains the specific UNIX system error value. Otherwise, a
  45 \fBDLPI\fR error value defined in \fB<sys/dlpi.h>\fR or \fBDLPI_EINHANDLE\fR is
  46 returned.
  47 .SH ERRORS
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBDLPI_EBADMSG\fR\fR
  52 .ad
  53 .RS 18n
  54 Bad DLPI message
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fBDLPI_EINHANDLE\fR\fR
  61 .ad
  62 .RS 18n
  63 Invalid \fBDLPI\fR handle
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fBDLPI_EINVAL\fR\fR
  70 .ad
  71 .RS 18n
  72 Invalid argument
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBDLPI_ETIMEDOUT\fR\fR
  79 .ad
  80 .RS 18n
  81 \fBDLPI\fR operation timed out
  82 .RE
  83
  84 .SH ATTRIBUTES
  85 .sp
  86 .LP
  87 See \fBattributes\fR(5) for description of the following attributes:
  88 .sp
  89
  90 .sp
  91 .TS
  92 box;
  93 c | c
  94 l | l .
  95 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  96 _
  97 Interface Stability     Committed
  98 _
  99 MT-Level        Safe
 100 .TE
 101
 102 .SH SEE ALSO
 103 .sp
 104 .LP
 105 \fBlibdlpi\fR(3LIB), \fBattributes\fR(5)