usr/src/man/man9s/fmodsw.9s

   1 '\" te
   2 .\" Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" Copyright 1989 AT&T
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH FMODSW 9S "Nov 14, 2002"
   8 .SH NAME
   9 fmodsw \- STREAMS module declaration structure
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/stream.h>
  14 #include <sys/conf.h>
  15 .fi
  16
  17 .SH INTERFACE LEVEL
  18 .sp
  19 .LP
  20 Solaris DDI specific (Solaris DDI)
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 The \fBfmodsw\fR structure contains information for STREAMS modules. All
  25 STREAMS modules must define a \fBfmodsw\fR structure.
  26 .sp
  27 .LP
  28 \fBf_name\fR must match \fBmi_idname\fR in the \fBmodule_info\fR structure. See
  29 \fBmodule_info\fR(9S). \fBf_name\fR should also match the module binary name.
  30 (See WARNINGS.)
  31 .sp
  32 .LP
  33 All modules must set the \fBf_flag\fR to \fBD_MP\fR to indicate that they
  34 safely allow multiple threads of execution. See \fBmt-streams\fR(9F) for
  35 additional flags.
  36 .SH STRUCTURE MEMBERS
  37 .sp
  38 .in +2
  39 .nf
  40 char              f_name[FMNAMESZ + 1];   /* module name */
  41 struct streamtab  *f_str;                 /* streams information */
  42 int               f_flag;                 /* flags */
  43 .fi
  44 .in -2
  45
  46 .SH SEE ALSO
  47 .sp
  48 .LP
  49 \fBmt-streams\fR(9F), \fBmodlstrmod\fR(9S), \fBmodule_info\fR(9S)
  50 .sp
  51 .LP
  52 \fISTREAMS Programming Guide\fR
  53 .SH WARNINGS
  54 .sp
  55 .LP
  56 If \fBf_name\fR does not match the module binary name, unexpected failures can
  57 occur.