share/man/man3dlpi/dlpi_fd.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_FD 3DLPI "Jun 15, 2007"
   7 .SH NAME
   8 dlpi_fd \- get DLPI file descriptor
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-ldlpi\fR [ \fIlibrary\fR ... ]
  13 #include <libdlpi.h>
  14
  15 \fBint\fR \fIdlpi_fd\fR(\fBdlpi_handle_t\fR \fIdh\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBdlpi_fd()\fR function returns the integer file descriptor that can be
  22 used to directly operate on the open \fBDLPI\fR stream associated with the
  23 \fBDLPI\fR handle \fIdh\fR. This file descriptor can be used to perform
  24 non-\fBDLPI\fR operations that do not alter the state of the \fBDLPI\fR stream,
  25 such as waiting for an event using \fBpoll\fR(2), or pushing and configuring
  26 additional \fBSTREAMS\fR modules, such as \fBpfmod\fR(7M). If \fBDLPI\fR
  27 operations are directly performed on the file descriptor, or a \fBSTREAMS\fR
  28 module is pushed that alters the message-passing interface such that \fBDLPI\fR
  29 operations can no longer be issued, future operations on \fIdh\fR might not
  30 behave as documented.
  31 .sp
  32 .LP
  33 The returned file descriptor is managed by \fBlibdlpi\fR(3LIB) and the
  34 descriptor must not be closed.
  35 .SH RETURN VALUES
  36 .sp
  37 .LP
  38 The function returns the integer file descriptor associated with the \fBDLPI\fR
  39 handle \fIdh\fR. If \fIdh\fR is invalid, \fB-1\fR is returned.
  40 .SH ATTRIBUTES
  41 .sp
  42 .LP
  43 See \fBattributes\fR(5) for description of the following attributes:
  44 .sp
  45
  46 .sp
  47 .TS
  48 box;
  49 c | c
  50 l | l .
  51 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  52 _
  53 Interface Stability     Committed
  54 _
  55 MT-Level        Safe
  56 .TE
  57
  58 .SH SEE ALSO
  59 .sp
  60 .LP
  61 \fBpoll\fR(2), \fBlibdlpi\fR(3LIB), \fBattributes\fR(5), \fBdlpi\fR(7P),
  62 \fBpfmod\fR(7M)