crypto/external/bsd/openssh/dist/nchan2.ms

   1 .\"     $NetBSD$
   2 .\"     $OpenBSD: nchan2.ms,v 1.4 2008/05/15 23:52:24 djm Exp $
   3 .\"
   4 .\" Copyright (c) 2000 Markus Friedl.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .TL
  27 OpenSSH Channel Close Protocol 2.0 Implementation
  28 .SH
  29 Channel Input State Diagram
  30 .PS
  31 reset
  32 l=1
  33 s=1.2
  34 ellipsewid=s*ellipsewid
  35 boxwid=s*boxwid
  36 ellipseht=s*ellipseht
  37 S1: ellipse "INPUT" "OPEN"
  38 move right 2*l from last ellipse.e
  39 S3: ellipse invis
  40 move down l from last ellipse.s
  41 S4: ellipse "INPUT" "CLOSED"
  42 move down l from 1st ellipse.s
  43 S2: ellipse "INPUT" "WAIT" "DRAIN"
  44 arrow from S1.e to S4.n
  45 box invis "rcvd CLOSE/" "shutdown_read" with .sw at last arrow.c
  46 arrow "ibuf_empty ||" "rcvd CLOSE/" "send EOF" "" from S2.e to S4.w
  47 arrow from S1.s to S2.n
  48 box invis "read_failed ||" "rcvd EOW/" "shutdown_read" with .e at last arrow.c
  49 ellipse wid .9*ellipsewid ht .9*ellipseht at S4
  50 arrow "start" "" from S1.w+(-0.5,0) to S1.w
  51 .PE
  52 .SH
  53 Channel Output State Diagram
  54 .PS
  55 S1: ellipse "OUTPUT" "OPEN"
  56 move right 2*l from last ellipse.e
  57 S3: ellipse invis
  58 move down l from last ellipse.s
  59 S4: ellipse "OUTPUT" "CLOSED"
  60 move down l from 1st ellipse.s
  61 S2: ellipse "OUTPUT" "WAIT" "DRAIN"
  62 arrow from S1.e to S4.n
  63 box invis "write_failed/" "shutdown_write" "send EOW" with .sw at last arrow.c
  64 arrow "obuf_empty ||" "write_failed/" "shutdown_write" "" from S2.e to S4.w
  65 arrow from S1.s to S2.n
  66 box invis "rcvd EOF ||" "rcvd CLOSE/" "-" with .e at last arrow.c
  67 ellipse wid .9*ellipsewid ht .9*ellipseht at S4
  68 arrow "start" "" from S1.w+(-0.5,0) to S1.w
  69 .PE
  70 .SH
  71 Notes
  72 .PP
  73 The input buffer is filled with data from the socket
  74 (the socket represents the local consumer/producer of the
  75 forwarded channel).
  76 The data is then sent over the INPUT-end (transmit-end) of the channel to the
  77 remote peer.
  78 Data sent by the peer is received on the OUTPUT-end (receive-end),
  79 saved in the output buffer and written to the socket.
  80 .PP
  81 If the local protocol instance has forwarded all data on the
  82 INPUT-end of the channel, it sends an EOF message to the peer.
  83 .PP
  84 A CLOSE message is sent to the peer if
  85 both the INPUT- and the OUTOUT-half of the local
  86 end of the channel are closed.
  87 .PP
  88 The channel can be deallocated by a protocol instance
  89 if a CLOSE message he been both sent and received.