share/man/man4/man4.i386/streams.4

   1 .\" Copyright (c) 2000 Mark Newton
   2 .\" 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 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .Dd November 6, 2000
  27 .Dt STREAMS 4 i386
  28 .Os
  29 .Sh NAME
  30 .Nm streams
  31 .Nd System V STREAMS networking ABI support
  32 .Sh SYNOPSIS
  33 To link System V Release 4 (SVR4) STREAMS interprocess communication ABI
  34 support into the kernel:
  35 .Cd device streams
  36 .Pp
  37 To load the SVR4 STREAMS interprocess communication ABI support kernel
  38 module:
  39 .Dl kldload streams
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 module provides limited
  44 System V Release 4 STREAMS interprocess communication ABI
  45 (application binary interface) compatibility
  46 for userland applications.
  47 .Pp
  48 Internally,
  49 .Nm
  50 provides STREAMS handles by using socket creation kernel routines, and
  51 adding state-tracking information to the socket to permit manipulation
  52 by STREAMS emulation code in
  53 .Xr svr4 4 .
  54 Hence, opening a stream device produces a result similar to what would be
  55 obtained by calling
  56 .Xr socket 2 .
  57 .Pp
  58 Applications should never use this interface directly: STREAMS
  59 emulation is only provided as a service to support ABI requirements in
  60 the SVR4 environment which
  61 .Xr svr4 4
  62 needs to present to client binaries.
  63 .Sh SEE ALSO
  64 .Xr svr4 4
  65 .Sh HISTORY
  66 System V Release 4 ABI support first appeared in
  67 .Fx 4.0 .
  68 The ABI was ported from an equivalent facility present in
  69 .Nx 1.3
  70 written by Christos Zoulas.
  71 .Sh BUGS
  72 This whole interface is a crude hack to produce STREAMS semantics
  73 through emulation over sockets.
  74 .Pp
  75 Programmers who hope to be able to use this interface to provide
  76 SVR4 STREAMS services to
  77 .Bx
  78 applications will be sorely disappointed.