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: src/share/man/man4/man4.i386/streams.4,v 1.7 2005/01/21 08:36:39 ru Exp $
  26 .\" $DragonFly: src/share/man/man4/man4.i386/Attic/streams.4,v 1.1 2006/04/30 18:46:39 swildner Exp $
  27 .Dd November 6, 2000
  28 .Dt STREAMS 4 i386
  29 .Os
  30 .Sh NAME
  31 .Nm streams
  32 .Nd System V STREAMS networking ABI support
  33 .Sh SYNOPSIS
  34 To link System V Release 4 (SVR4) STREAMS interprocess communication ABI
  35 support into the kernel:
  36 .Cd pseudo-device streams
  37 .Pp
  38 To load the SVR4 STREAMS interprocess communication ABI support kernel
  39 module:
  40 .Dl kldload streams
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 module provides limited
  45 System V Release 4 STREAMS interprocess communication ABI
  46 (application binary interface) compatibility
  47 for userland applications.
  48 .Pp
  49 Internally,
  50 .Nm
  51 provides STREAMS handles by using socket creation kernel routines, and
  52 adding state-tracking information to the socket to permit manipulation
  53 by STREAMS emulation code in
  54 .Xr svr4 4 .
  55 Hence, opening a stream device produces a result similar to what would be
  56 obtained by calling
  57 .Xr socket 2 .
  58 .Pp
  59 Applications should never use this interface directly: STREAMS
  60 emulation is only provided as a service to support ABI requirements in
  61 the SVR4 environment which
  62 .Xr svr4 4
  63 needs to present to client binaries.
  64 .Sh SEE ALSO
  65 .Xr svr4 4
  66 .Sh HISTORY
  67 System V Release 4 ABI support first appeared in
  68 .Fx 4.0 .
  69 The ABI was ported from an equivalent facility present in
  70 .Nx 1.3
  71 written by Christos Zoulas.
  72 .Sh BUGS
  73 This whole interface is a crude hack to produce STREAMS semantics
  74 through emulation over sockets.
  75 .Pp
  76 Programmers who hope to be able to use this interface to provide
  77 SVR4 STREAMS services to
  78 .Bx
  79 applications will be sorely disappointed.