home *** CD-ROM | disk | FTP | other *** search
/ Internet Info 1997 December / Internet_Info_CD-ROM_Walnut_Creek_December_1997.iso / rfc / rfc2204 < prev    next >
Text File  |  1997-09-25  |  152KB  |  4,148 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7. Network Working Group                                            D. Nash
  8. Request for Comments: 2204                                        ODETTE
  9. Category: Informational                                   September 1997
  10.  
  11.  
  12.                      ODETTE File Transfer Protocol
  13.  
  14. Status of this Memo
  15.  
  16.    This memo provides information for the Internet community.  It does
  17.    not specify an Internet standard of any kind.  Distribution of this
  18.    memo is unlimited.
  19.  
  20. Abstract
  21.  
  22.    This memo describes a file transfer protocol to facilitate electronic
  23.    data interchange between trading partners.
  24.  
  25.    The protocol, denoted the ODETTE File Transfer Protocol, supports
  26.    both direct communication between installations and indirect
  27.    communication via a third party clearing centre.  It was developed by
  28.    the Organisation for Data Exchange by Tele Transmission in Europe to
  29.    facilitate communication within the European motor industry and is
  30.    presented here to allow for wider use within the Internet community.
  31.  
  32. Table of Contents
  33.  
  34.    1. Introduction                                               3
  35.          1.1  -  Background                                      3
  36.          1.2  -  Relationship to the original ODETTE Standard    3
  37.          1.3  -  General Principles                              3
  38.          1.4  -  Structure                                       4
  39.          1.5  -  Virtual Files                                   4
  40.          1.6  -  Service Description                             7
  41.  
  42.    2. Network Service (TCP Transport Service)                    7
  43.          2.1  -  Introduction                                    7
  44.          2.2  -  Service Primitives                              7
  45.          2.3  -  Port Assignment                                 9
  46.  
  47.    3. File Transfer Service                                      9
  48.          3.1  -  Model                                          10
  49.          3.2  -  Session Setup                                  11
  50.          3.3  -  File Transfer                                  13
  51.          3.4  -  Session Take Down                              16
  52.          3.5  -  Service State Automata                         19
  53.  
  54.  
  55.  
  56.  
  57.  
  58. Nash                         Informational                      [Page 1]
  59.  
  60. RFC 2204             ODETTE File Transfer Protocol        September 1997
  61.  
  62.  
  63.    4. Protocol Specification                                    22
  64.          4.1  -  Overview                                       22
  65.          4.2  -  Start Session Phase                            22
  66.          4.3  -  Start File Phase                               23
  67.          4.4  -  Data Transfer Phase                            26
  68.          4.5  -  End File Phase                                 27
  69.          4.6  -  End Session Phase                              27
  70.          4.7  -  Problem Handling                               28
  71.  
  72.    5. Commands and Formats                                      28
  73.          5.1  -  Conventions                                    28
  74.          5.2  -  Commands                                       29
  75.          5.3  -  Command Formats                                29
  76.          5.4  -  Identification Code                            45
  77.  
  78.    6. ODETTE-FTP Data Exchange Buffer                           46
  79.          6.1  -  Overview                                       46
  80.          6.2  -  Data Exchange Buffer Format                    46
  81.          6.3  -  Buffer Filling Rules                           47
  82.  
  83.    7. Stream Transmission Buffer (TCP only)                     47
  84.          7.1  -  Introduction                                   47
  85.          7.2  -  Stream Transmission Header Format              49
  86.  
  87.    8. Protocol State Machine                                    50
  88.          8.1  -  ODETTE-FTP State Machine                       50
  89.          8.2  -  Error Handling                                 50
  90.          8.3  -  States                                         51
  91.          8.4  -  Input Events                                   53
  92.          8.5  -  Output Events                                  54
  93.          8.6  -  Local Variables                                55
  94.          8.7  -  Local Constants                                55
  95.          8.8  -  Session Connection State Table                 56
  96.          8.9  -  Error and Abort State Table                    58
  97.          8.10 -  Speaker State Table 1                          59
  98.          8.11 -  Speaker State Table 2                          63
  99.          8.12 -  Listener State Table                           65
  100.          8.13 -  Example                                        68
  101.  
  102.    9.  Security Considerations                                  68
  103.  
  104.    Appendix A    Virtual File Mapping Example                   69
  105.    Appendix B    ISO 646 Character Subset                       72
  106.  
  107.    Acknowledgements                                             73
  108.    References                                                   73
  109.    ODETTE Address                                               74
  110.    Author's Address                                             74
  111.  
  112.  
  113.  
  114. Nash                         Informational                      [Page 2]
  115.  
  116. RFC 2204             ODETTE File Transfer Protocol        September 1997
  117.  
  118.  
  119. 1. Introduction
  120.  
  121. 1.1  Background
  122.  
  123.    The ODETTE File Transfer Protocol (ODETTE-FTP) was defined in 1986 by
  124.    working group four of the Organisation for Data Exchange by Tele
  125.    Transmission in Europe (ODETTE) to address the electronic data
  126.    interchange (EDI) requirements of the European automotive industry.
  127.    It was designed in the spirit of the Open System Interconnection
  128.    (OSI) model utilising the Network Service provided by the CCITT X25
  129.    recommendation.
  130.  
  131.    Over the last ten years ODETTE-FTP has been widely deployed on
  132.    systems of all sizes from personal computers to large mainframes.  As
  133.    a result of the wide scale deployment of internet technology and the
  134.    trend towards global business practices, ODETTE has decided to extend
  135.    the scope of it's file transfer protocol to allow the use of TCP/IP
  136.    and to make the protocol available to the Internet community.
  137.  
  138.    This memo describes the ODETTE-FTP protocol using the Transmission
  139.    Control Protocol for it's network service.
  140.  
  141. 1.2  Relationship to the original ODETTE Standard
  142.  
  143.    This memo is an interpretation of version 1.3 of the ODETTE File
  144.    Transfer Protocol [OFTP].  In the event of any ambiguity between this
  145.    document and the original ODETTE-FTP, the original shall take
  146.    precedence.
  147.  
  148.    For ODETTE-FTP on TCP/IP the following sections have been added with
  149.    respect to the original document.
  150.  
  151.       Section 2  - Network Service
  152.       Section 7  - Stream Transmission Buffer
  153.       Appendix A - Virtual File mapping example
  154.  
  155. 1.3  General Principles
  156.  
  157.    The aim of the ODETTE-FTP is to facilitate the transmission of a file
  158.    between one or more locations in a way that is independent of the
  159.    data communication network, system hardware and software environment.
  160.  
  161.    In designing and specifying the protocol, the following factors were
  162.    considered.
  163.  
  164.    1. The possible differences of size and sophistication (file storage,
  165.       small and large systems).
  166.  
  167.  
  168.  
  169.  
  170. Nash                         Informational                      [Page 3]
  171.  
  172. RFC 2204             ODETTE File Transfer Protocol        September 1997
  173.  
  174.  
  175.    2. The necessity to work with existing systems (reduce changes to
  176.       existing products and allow easy implementation).
  177.  
  178.    3. Systems of different ages.
  179.  
  180.    4. Systems of different manufactures.
  181.  
  182.    5. The potential for growth in sophistication (limit impact and avoid
  183.       changes at other locations).
  184.  
  185. 1.4  Structure
  186.  
  187.    ODETTE-FTP is modelled on the OSI reference model.  It is designed to
  188.    use the Network Service provided by level 3 of the model and provide
  189.    a File Service to the users.  Thus the protocol spans levels 4 to 7
  190.    of model.
  191.  
  192.    The description of the ODETTE-FTP contained in this memo is closely
  193.    related to the original 'X.25' specification of the protocol and in
  194.    the spirit of the OSI model describes:
  195.  
  196.       1. A File Service provided to a user monitor.
  197.  
  198.       2. A protocol for the exchange of information between peer
  199.          ODETTE-FTP entities.
  200.  
  201.    A major consideration in adapting the protocol to use the
  202.    Transmission Control Protocol (TCP) was the desire to make no changes
  203.    to the existing protocol by adding the functionality required to
  204.    allow implementors to support internet communication with only minor
  205.    changes to existing ODETTE-FTP engines.  To this end an additional
  206.    header has been added to the start of each exchange buffer to allow
  207.    the TCP byte stream to be broken up into the discrete exchange
  208.    buffers expected by the ODETTE-FTP protocol.
  209.  
  210. 1.5  Virtual Files
  211.  
  212.    Information is always exchanged between ODETTE-FTP entities in a
  213.    standard representation called a Virtual File.  This allows data
  214.    transfer without regard for the nature of the communicating systems.
  215.  
  216.    The mapping of a file between a local and virtual representation will
  217.    vary from system to system and is not defined here.
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226. Nash                         Informational                      [Page 4]
  227.  
  228. RFC 2204             ODETTE File Transfer Protocol        September 1997
  229.  
  230.  
  231.                               o---------o
  232.                          Site | Local   |
  233.                           A   | File A  |
  234.                               o---------o
  235.                                    |
  236.       o----------------------- Mapping A ------------------------o
  237.       |                            |                             |
  238.       |                       o---------o                        |
  239.       |                       | Virtual |                        |
  240.       |                       |  File   |                        |
  241.       |                       o---------o                        |
  242.       |    o------------------------------------------------o    |
  243.       |    |                                                |    |
  244.       |    |                  ODETTE-FTP                    |    |
  245.       |    |                                                |    |
  246.       |    o------------------------------------------------o    |
  247.       |      o---------o                        o---------o      |
  248.       |      | Virtual |                        | Virtual |      |
  249.       |      |  File   |                        |  File   |      |
  250.       |      o---------o                        o----+----o      |
  251.       |           |                                  |           |
  252.       o------ Mapping B ------------------------ Mapping C ------o
  253.                   |                                  |
  254.              o---------o                        o----+----o
  255.              | Local   | Site              Site | Local   |
  256.              | File B  |  B                 C   | File C  |
  257.              o---------o                        o---------o
  258.  
  259.    A Virtual File is described by a set of attributes identifying and
  260.    defining the data to be transferred.  The main attributes are:
  261.  
  262. 1.5.1  Organisation:
  263.  
  264.    Sequential
  265.  
  266.       Logical records are presented one after another.  The ODETTE-FTP
  267.       must be aware of the record boundaries.
  268.  
  269. 1.5.2  Identification
  270.  
  271.    Dataset Name
  272.  
  273.       Dataset name of the Virtual File being transfered, assigned by
  274.       bilateral agreement.
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282. Nash                         Informational                      [Page 5]
  283.  
  284. RFC 2204             ODETTE File Transfer Protocol        September 1997
  285.  
  286.  
  287.    Time stamp (HHMMSS)
  288.  
  289.       A file qualifier indicating the time the Virtual File was made
  290.       available for transmission.
  291.  
  292.    Date stamp (YYMMDD)
  293.  
  294.       A file qualifier indicating the date the Virtual File was made
  295.       available for transmission.
  296.  
  297.    The Dataset Name, Date and Time attributes are assigned by a Virtual
  298.    File's Originator and are used to uniquely identify the file.  They
  299.    must not be changed by intermediate locations.
  300.  
  301.    The Date attribute represents the decade and year in a two digit
  302.    field.  Since the ODETTE-FTP only uses this information to identify a
  303.    particular Virtual File it will continue to operate correctly in the
  304.    year 2000 and beyond.
  305.  
  306.    The User Monitor may use the Virtual File Date attribute in local
  307.    processes involving date comparisons and calculations.  Any such use
  308.    falls outside the scope of this protocol and year 2000 handling is a
  309.    local implementation issue.
  310.  
  311. 1.5.3  Record Format
  312.  
  313.    Four record formats are defined.
  314.  
  315.       Fixed (F)
  316.  
  317.          Each record in the file has the same length.
  318.  
  319.       Variable (V)
  320.  
  321.          The records in the file can have different lengths.
  322.  
  323.       Unstructured (U)
  324.  
  325.          The file contains a stream of data.  No structure is defined.
  326.  
  327.       Text File (T)
  328.  
  329.          A Text File is defined as a sequence of ASCII characters,
  330.          containing no control characters except CR/LF which delimits
  331.          lines.  A line will not have more than 2048 characters.
  332.  
  333.  
  334.  
  335.  
  336.  
  337.  
  338. Nash                         Informational                      [Page 6]
  339.  
  340. RFC 2204             ODETTE File Transfer Protocol        September 1997
  341.  
  342.  
  343. 1.5.4  Restart
  344.  
  345.    ODETTE-FTP can negotiate the restart of an interrupted Virtual File
  346.    transmission.  Fixed and Variable format files are restarted on
  347.    record boundaries.  For Unstructured and Text files the restart
  348.    position is expressed as a file offset in 1K (1024 octet) blocks.
  349.    The restart position is always calculated relative to the Virtual
  350.    File.
  351.  
  352. 1.6  Service Description
  353.  
  354.    ODETTE-FTP provides a file transfer service to a user monitor and in
  355.    turn uses the Internet transport layer stream service to communicate
  356.    between peers.
  357.  
  358.    These services are specified in this memo using service primitives
  359.    grouped into four classes as follows:
  360.  
  361.       Request (RQ)       An entity asks the service to do some work.
  362.       Indication (IND)   A service informs an entity of an event.
  363.       Response (RS)      An entity responds to an event.
  364.       Confirm (CF)       A service informs an entity of the response.
  365.  
  366.    Services may be confirmed, using the request, indication, response
  367.    and confirm primitives, or unconfirmed using just the request and
  368.    indication primitives.
  369.  
  370. 2. Network Service (TCP Transport Service)
  371.  
  372. 2.1  Introduction
  373.  
  374.    ODETTE-FTP peer entities communicate with each other via the OSI
  375.    Network Service or the Transmission Control Protocol Transport
  376.    Service [TCP].  This is described by service primitives representing
  377.    request, indication, response and confirmation actions.
  378.  
  379.    For the internet environment, the service primitives mentioned below
  380.    for the Network Service have to be mapped to the respective Transport
  381.    Service primitives.  This section describes the network service
  382.    primitives used by ODETTE-FTP and their relationship to the TCP
  383.    interface.  In practice the local transport service application
  384.    programming interface will be used to access the TCP service.
  385.  
  386. 2.2  Service Primitives
  387.  
  388.    All Network primitives can be directly mapped to the respective
  389.    Transport primitives when using TCP.
  390.  
  391.  
  392.  
  393.  
  394. Nash                         Informational                      [Page 7]
  395.  
  396. RFC 2204             ODETTE File Transfer Protocol        September 1997
  397.  
  398.  
  399. 2.2.1  Network Connection
  400.  
  401.       N_CON_RQ   ------>   N_CON_IND
  402.       N_CON_CF   <------   N_CON_RS
  403.  
  404.    This describes the setup of a connection.  The requesting ODETTE-FTP
  405.    peer uses the N_CON_RQ primitive to request an active OPEN of a
  406.    connection to a peer ODETTE-FTP, the Responder, which has previously
  407.    requested a passive OPEN.  The Responder is notified of the incoming
  408.    connection via N_CON_IND and accepts it with N_CON_RS.  The requester
  409.    is notified of the completion of it's OPEN request upon receipt of
  410.    _CON_CF.
  411.  
  412.    Parameters
  413.  
  414.    Request           Indication        Response          Confirmation
  415.    ---------------------------------------------------------------------
  416.    Dest addr ------> same              same              same
  417.  
  418. 2.2.2  Network Data
  419.  
  420.       N_DATA_RQ  ------>   N_DATA_IND
  421.  
  422.    Data exchange is an unconfirmed service.  The Requester passes data
  423.    for transmission to the network service via the N_DATA_RQ primitive.
  424.    The Responder is notified of the availability of data via N_DATA_IND.
  425.    In practice the notification and receipt of data may be combined,
  426.    such as by the return from a blocking read from the network socket.
  427.  
  428.    Parameters
  429.  
  430.    Request                  Indication
  431.    ---------------------------------------------------------------------
  432.    Data ------------------> same
  433.  
  434. 2.2.3  Network Disconnection
  435.  
  436.       N_DISC_RQ  ------>   N_DISC_IND
  437.  
  438.    An ODETTE-FTP requests the termination of a connection with the
  439.    N_DISC_RQ service primitive.  It's peer is notified of the CLOSE by a
  440.    N_DISC_IND event.  It is recognised that each peer must issue a
  441.    N_DISC_RQ primitive to complete the TCP symmetric close procedure.
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450. Nash                         Informational                      [Page 8]
  451.  
  452. RFC 2204             ODETTE File Transfer Protocol        September 1997
  453.  
  454.  
  455. 2.2.4  Network Reset
  456.  
  457.     ------>   N_RST_IND
  458.  
  459.    An ODETTE-FTP entity is notified of a network error by a N_RST_IND
  460.    event.  It should be noted that N_RST_IND would also be generated by
  461.    a peer RESETTING the connection, but this is ignored here as N_RST_RQ
  462.    is never sent to the Network Service by ODETTE-FTP.
  463.  
  464. 2.3  Port Assignment
  465.  
  466.    A ODETTE-FTP requester will select a suitable local port.
  467.  
  468.    The responding ODETTE-FTP will listen for connections on Registered
  469.    Port 3305, the service name is 'odette-ftp'.
  470.  
  471. 3. File Transfer Service
  472.  
  473.    The File Transfer Service describes the services offered by an
  474.    ODETTE-FTP Entity to it's User Monitor.  The implementation of the
  475.    service primitives is a local matter.
  476.  
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.  
  484.  
  485.  
  486.  
  487.  
  488.  
  489.  
  490.  
  491.  
  492.  
  493.  
  494.  
  495.  
  496.  
  497.  
  498.  
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506. Nash                         Informational                      [Page 9]
  507.  
  508. RFC 2204             ODETTE File Transfer Protocol        September 1997
  509.  
  510.  
  511. 3.1  Model
  512.  
  513.           o-------------------o             o-------------------o
  514.           |                   |             |                   |
  515.           |   USER  MONITOR   |             |   USER  MONITOR   |
  516.           |                   |             |                   |
  517.           o-------------------o             o-------------------o
  518.                   |   A                             |   A
  519.    ...............|...|... FILE TRANSFER SERVICE ...|...|...............
  520.                   |   |                             |   |
  521.       F_XXX_RQ/RS |   | F_XXX_IND/CF    F_XXX_RQ/RS |   | F_XXX_IND/CF
  522.                   V   |                             V   |
  523.           o-------------------o             o-------------------o
  524.           |                   |- - - - - - >|                   |
  525.           | ODETTE-FTP Entity |   E-Buffer  | ODETTE-FTP Entity |
  526.           |                   |< - - - - - -|                   |
  527.           o-------------------o             o-------------------o
  528.                   |   A                             |   A
  529.       N_XXX_RQ/RS |   | N_XXX_IND/CF    N_XXX_RQ/RS |   | N_XXX_IND/CF
  530.                   |   |                             |   |
  531.    ...............|...|...... NETWORK SERVICE ......|...|...............
  532.                   V   |                             V   |
  533.         o---------------------------------------------------------o
  534.         |                                                         |
  535.         |                      N E T W O R K                      |
  536.         |                                                         |
  537.         o---------------------------------------------------------o
  538.  
  539.          Key:  E-Buffer - Exchange Buffer
  540.                F_       - File Transfer Service Primitive
  541.                N_       - Network Service Primitive
  542.  
  543.  
  544.  
  545.  
  546.  
  547.  
  548.  
  549.  
  550.  
  551.  
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562. Nash                         Informational                     [Page 10]
  563.  
  564. RFC 2204             ODETTE File Transfer Protocol        September 1997
  565.  
  566.  
  567. 3.2  Session Setup
  568.  
  569. 3.2.1  Session Connection Service
  570.  
  571.                              |            |
  572.            F_CONNECT_RQ ---->|------------|----> F_CONNECT_IND
  573.                              |            |
  574.            F_CONNECT_CF <----|------------|<---- F_CONNECT_RS
  575.                              |            |
  576.  
  577.    Parameters
  578.  
  579.    Request           Indication        Response          Confirm
  580.    ---------------------------------------------------------------------
  581.    called-address -> same              ---               ----
  582.    calling-address-> same              ---               ----
  583.    ID1 ------------> same              ID2 ------------> same
  584.    PSW1------------> same              PSW2 -----------> same
  585.    mode1 ----------> mode2 ----------> mode3 ----------> same
  586.    restart1 -------> same -----------> restart2 -------> same
  587.    ---------------------------------------------------------------------
  588.  
  589.    Mode
  590.  
  591.       Specifies the file transfer capabilities of the entity sending or
  592.       receiving a F_CONNECT primitive for the duration of the session.
  593.  
  594.       Value:
  595.          Sender-Only    The entity can only send files.
  596.          Receiver-Only  The entity can only receive files.
  597.          Both           The entity can both send and receive files.
  598.  
  599.       Negotiation:
  600.         Sender-Only    Not negotiable.
  601.         Receiver-Only  Not negotiable.
  602.         Both           Can be negotiated down to Sender-Only or
  603.                        Receiver-Only by the User Monitor or the
  604.                        ODETTE-FTP entity.
  605.  
  606.  
  607.  
  608.  
  609.  
  610.  
  611.  
  612.  
  613.  
  614.  
  615.  
  616.  
  617.  
  618. Nash                         Informational                     [Page 11]
  619.  
  620. RFC 2204             ODETTE File Transfer Protocol        September 1997
  621.  
  622.  
  623.    Request           Indication        Response          Confirm
  624.    ---------------------------------------------------------------------
  625.    Sender-only ----> Receiver-only --> Receiver-only --> Sender-only
  626.  
  627.    Receiver-only --> Sender-only ----> Sender-only ----> Receiver-only
  628.  
  629.    Both -----+-----> Both ----+------> Both -----------> Both
  630.              |             or +------> Receiver-only --> Sender-only
  631.              |             or +------> Sender-only ----> Receiver-only
  632.              |
  633.           or +-----> Receiver-only --> Receiver-only --> Sender-only
  634.           or +-----> Sender-only ----> Sender-only ----> Receiver-only
  635.    ---------------------------------------------------------------------
  636.  
  637.    Restart
  638.  
  639.       Specifies the file transfer restart capabilities of the User
  640.       Monitor.
  641.  
  642.       Value:
  643.  
  644.       Negotiation:
  645.  
  646.    Request           Indication        Response          Confirm
  647.    ---------------------------------------------------------------------
  648.    restart = Y ----> restart = Y --+-> restart = Y ----> restart = Y
  649.                                 or +-> restart = N ----> restart = N
  650.  
  651.    restart = N ----> restart = N ----> restart = N ----> restart = N
  652.    ---------------------------------------------------------------------
  653.  
  654.  
  655.  
  656.  
  657.  
  658.  
  659.  
  660.  
  661.  
  662.  
  663.  
  664.  
  665.  
  666.  
  667.  
  668.  
  669.  
  670.  
  671.  
  672.  
  673.  
  674. Nash                         Informational                     [Page 12]
  675.  
  676. RFC 2204             ODETTE File Transfer Protocol        September 1997
  677.  
  678.  
  679. 3.3  File Transfer
  680.  
  681. 3.3.1  File Opening
  682.  
  683.                              |            |
  684.         F_START_FILE_RQ ---->|------------|----> F_START_FILE_IND
  685.                              |            |
  686.    F_START_FILE_CF(+|-) <----|------------|<---- F_START_FILE_RS(+|-)
  687.                              |            |
  688.  
  689.    Parameters:
  690.  
  691.    Request         Ind.   RS(+)          CF(+)     RS(-)         CF(-)
  692.    --------------------------------------------------------------------
  693.    file-name ----> same   ----           ----      ----          ----
  694.    date-time ----> same   ----           ----      ----          ----
  695.    destination---> same   ----           ----      ----          ----
  696.    originator----> same   ----           ----      ----          ----
  697.    rec-format----> same   ----           ----      ----          ----
  698.    rec-size -----> same   ----           ----      ----          ----
  699.    file-size-----> same   ----           ----      ----          ----
  700.    restart-pos1--> same-> restart-pos2-> same      ----          ----
  701.    ----            ----   ----           ----      cause ------> same
  702.    ----            ----   ----           ----      retry-later-> same
  703.    --------------------------------------------------------------------
  704.  
  705.    Notes:
  706.  
  707.    1. Retry-later has values "Y" or "N".  2. Cause is the reason for
  708.    refusing the transfer (1,..,13,99).  3. Restart-pos1 not equal 0 is
  709.    only valid if restart has been agreed
  710.       during initial negotiation.
  711.    4. Restart-pos2 is less than or equal to restart-pos1.
  712.  
  713. 3.3.2  Data Regime
  714.  
  715.                              |            |
  716.               F_DATA_RQ ---->|------------|----> F_DATA_IND
  717.                              |            |
  718.  
  719.    Notes:
  720.  
  721.    1. The data format within a F_DATA primitive is locally defined.
  722.  
  723.    2. The File Transfer service may have to provide a flow control
  724.       mechanism to regulate the flow of F_DATA primitives.
  725.  
  726.  
  727.  
  728.  
  729.  
  730. Nash                         Informational                     [Page 13]
  731.  
  732. RFC 2204             ODETTE File Transfer Protocol        September 1997
  733.  
  734.  
  735. 3.3.3  File Closing
  736.  
  737.                              |            |
  738.          F_CLOSE_FILE_RQ --->|------------|----> F_CLOSE_FILE_IND
  739.                              |            |
  740.     F_CLOSE_FILE_CF(+|-) <---|------------|<---- F_CLOSE_FILE_RS(+|-)
  741.                              |            |
  742.    Parameters
  743.  
  744.    Request         Ind    RS(+)          CF(+)     RS(-)         CF(-)
  745.    ---------------------------------------------------------------------
  746.    rec-count --->  same   ----           ----      ----          ----
  747.    unit-count -->  same   ----           ----      ----          ----
  748.    ----            ----   Speaker=Y ---> Speaker=N ----          ----
  749.    ----            ----   Speaker=N ---> Speaker=Y ----          ----
  750.    ----            ----   ----           ----      cause --->    same
  751.    ---------------------------------------------------------------------
  752.  
  753.    In a positive Close File response (F_CLOSE_FILE_RS(+)) the current
  754.    Speaker may either:
  755.  
  756.       1.  Set Speaker to "Yes" and become the Speaker.  2.  Set Speaker
  757.       to "No"  and remain the Listener.
  758.  
  759.    The File Transfer service will ensure that the setting of the speaker
  760.    parameter is consistent with the capabilities of the peer user.
  761.  
  762.    The turn is never exchanged in the case of a negative response or
  763.    confirmation.
  764.  
  765.    Only the Speaker is allowed to issue F_XXX_FILE_RQ primitives.
  766.  
  767. 3.3.4  Exchanging the Turn
  768.  
  769. 3.3.4.1  Initial Turn (First Speaker)
  770.  
  771.    The Initiator becomes the first Speaker at the end of the Session
  772.    Setup (F_CONNECT_CF received by Initiator and F_CONNECT_RS sent by
  773.    Responder).
  774.  
  775. 3.3.4.2  Following Turns
  776.  
  777.    Rules:
  778.  
  779.    1. At each unsuccessful End of File the turn is not exchanged.
  780.  
  781.    2. At each successful End of File the turn is exchanged if requested
  782.       by the Listener:
  783.  
  784.  
  785.  
  786. Nash                         Informational                     [Page 14]
  787.  
  788. RFC 2204             ODETTE File Transfer Protocol        September 1997
  789.  
  790.  
  791.       - The current Listener receives F_CLOSE_FILE_IND
  792.         (Speaker = choice).
  793.  
  794.       - If the Listener answers F_CLOSE_FILE_RS(Speaker = YES), it
  795.         becomes Speaker, the Speaker receives F_CLOSE_FILE_CF (Speaker =
  796.         NO) and becomes Listener.
  797.  
  798.       - If the Listener answers F_CLOSE_FILE_RS(Speaker = NO), it
  799.         remains Listener, and the Speaker receives F_CLOSE_FILE_CF
  800.         (Speaker = YES) and remains Speaker.
  801.  
  802.    3. The Speaker can issue a Change Direction request (F_CD_RQ) to
  803.       become the Listener.  The Listener receives a Change Direction
  804.       indication (F_CD_IND) and becomes the Speaker.
  805.  
  806.    4. In order to prevent loops of F_CD_RQ/IND, it is an error to send
  807.       F_CD_RQ immediately after having received a F_CD_IND.
  808.  
  809. 3.3.5  End to End Response
  810.  
  811.    This service is initiated by the current Speaker (if there is no file
  812.    transfer in progress) to send an End-to-End response from the final
  813.    destination to the originator of a file.
  814.  
  815.                              |            |
  816.               F_EERP_RQ ---->|------------|----> F_EERP_IND
  817.                              |            |
  818.    Parameters
  819.  
  820.    Request           Indication
  821.    ------------------------------------
  822.    filename -------> same
  823.    date -----------> same
  824.    time -----------> same
  825.    destination ----> same
  826.    originator -----> same
  827.    ------------------------------------
  828.  
  829.    Relationship with Turn:
  830.  
  831.    -  Only the Speaker may send an End to End Response request.
  832.  
  833.    -  Invoking the EERP service does not change the turn.
  834.  
  835.    -  If a F_CD_IND has been received just before F_EERP_RQ is issued,
  836.       this results in leaving the special condition created by the
  837.       reception of F_CD_IND; i.e. while it was possible to issue
  838.       F_RELEASE_RQ and not possible to issue F_CD_RQ just after the
  839.  
  840.  
  841.  
  842. Nash                         Informational                     [Page 15]
  843.  
  844. RFC 2204             ODETTE File Transfer Protocol        September 1997
  845.  
  846.  
  847.       reception of F_CD_IND, after having issued F_EERP_RQ the normal
  848.       Speaker status is entered again (F_CD_RQ valid, but F_RELEASE_RQ
  849.       not valid).
  850.  
  851. 3.4  Session Take Down
  852.  
  853. 3.4.1  Normal Close
  854.  
  855.                              |            |
  856.            F_RELEASE_RQ ---->|------------|----> F_RELEASE_IND
  857.                              |            |
  858.  
  859.    Parameters
  860.  
  861.    Request                  Indication
  862.    ---------------------------------------------------------------------
  863.    reason = normal -------> ----
  864.    ---------------------------------------------------------------------
  865.  
  866.    The Release service can only be initiated by the Speaker.
  867.  
  868.    The Speaker can only issue a Release request (F_RELEASE_RQ) just
  869.    after receiving an unsolicited Change Direction indication
  870.    (F_CD_IND).  This ensures that the other partner doesn't want to send
  871.    any more files in this session.
  872.  
  873.    Peer ODETTE-FTP entities action a normal session release by
  874.    specifying Reason = Normal in an End Session (ESID) command.
  875.  
  876. 3.4.2  Abnormal close
  877.  
  878.                              |            |
  879.            F_RELEASE_RQ ---->|------------|----> F_ABORT_IND
  880.                              |            |
  881.  
  882.  
  883.    Parameters
  884.  
  885.    Request                  Indication
  886.    ---------------------------------------------------------------------
  887.    reason = error value --> same (or equivalent)
  888.                               AO (Abort Origin) = (L)ocal or (D)istant
  889.    ---------------------------------------------------------------------
  890.  
  891.    Abnormal session release can be initiated by either the Speaker or
  892.    the Listener and also by the user or provider.
  893.  
  894.    Abnormal session release can occur at any time within the session.
  895.  
  896.  
  897.  
  898. Nash                         Informational                     [Page 16]
  899.  
  900. RFC 2204             ODETTE File Transfer Protocol        September 1997
  901.  
  902.  
  903.    Peer ODETTE-FTP entities action an abnormal session release by
  904.    specifying Reason = Error-value in an End Session (ESID) command.
  905.  
  906.    The abnormal session release deals with the following types of error:
  907.  
  908.    1. The service provider will initiate an abnormal release in the
  909.       following cases:
  910.  
  911.       1. Protocol error, 2. Failure of the Start Session (SSID)
  912.       negotiation, 3. Command not recognised, 4. Exchange buffer size
  913.       error, 5. Resources not available, 6. Other unspecified abort code
  914.       (with "REASON" = unspecified).
  915.  
  916.    2. The User Monitor will initiate an abnormal release in the
  917.       following cases:
  918.  
  919.       1. Local site emergency close down, 2. Resources not available, 3.
  920.       Other unspecified abort code (with "REASON" = unspecified).
  921.  
  922.    Other error types may be handled by an abort of the connection.
  923.  
  924. 3.4.3  Abort
  925.  
  926.  
  927.                              |            |
  928.              F_ABORT_RQ ---->|------------|----> F_ABORT_IND
  929.                              |            |
  930.              User Initiated Abort
  931.  
  932.  
  933.                              |            |
  934.             F_ABORT_IND <----|------------|----> F_ABORT_IND
  935.                              |            |
  936.             Provider Initiated Abort
  937.  
  938.    Parameters
  939.  
  940.    Request                  Indication
  941.    ---------------------------------------------------------------------
  942.    --                       R  (Reason): specified or unspecified
  943.    --                       AO (Abort Origin): (L)ocal or (D)istant
  944.    ---------------------------------------------------------------------
  945.  
  946.    The Abort service may be invoked by either entity at any time.
  947.  
  948.    The service provider may initiate an abort in case of error
  949.    detection.
  950.  
  951.  
  952.  
  953.  
  954. Nash                         Informational                     [Page 17]
  955.  
  956. RFC 2204             ODETTE File Transfer Protocol        September 1997
  957.  
  958.  
  959. 3.4.4  Explanation of Session Take Down Services
  960.  
  961.             User  | OFTP |        Network       | OFTP |  User
  962.    ---------------|------|----------------------|------|---------------
  963.                   |      |                      |      |
  964.  
  965.    1. Normal Release
  966.  
  967.      F_RELEASE_RQ |      | ESID(R=normal)       |      | F_RELEASE_IND
  968.    *--------------|->  ==|======================|=>  --|-------------->
  969.      (R=normal)   |      |                      |      |
  970.  
  971.  
  972.    2. User Initiated Abnormal Release
  973.  
  974.      F_RELEASE_RQ |      | ESID(R=error)        |      | F_ABORT_IND
  975.    *--------------|->  ==|======================|=>   -|-------------->
  976.    (R=error value)|      |                      |      | (R=error,AO=D)
  977.  
  978.  
  979.             User  | OFTP |        Network       | OFTP |  User
  980.    ---------------|------|----------------------|------|---------------
  981.                   |      |                      |      |
  982.  
  983.    3. Provider Initiated Abnormal Release
  984.  
  985.      F_ABORT_IND  |      | ESID(R=error)        |      | F_ABORT_IND
  986.    <--------------|-*  *=|======================|=>  --|-------------->
  987.                   |      |                      |      |
  988.  
  989.  
  990.    4. User Initiated Connection Abort
  991.  
  992.     F_ABORT_RQ    |      | N_DISC_RQ            |      | F_ABORT_IND
  993.    *--------------|->  --|--------->..----------|->  --|-------------->
  994.                   |      |           N_DISC_IND |      | (R=unsp.,AO=D)
  995.  
  996.  
  997.    5. Provider Initiated Connection Abort
  998.  
  999.      F_ABORT_IND  |      | N_DISC_RQ            |      | F_ABORT_IND
  1000.    <--------------|-*  *-|--------->..----------|->  --|-------------->
  1001.    (R=error,AO=L) |      |           N_DISC_IND |      | (R=unsp.,AO=D)
  1002.  
  1003.            Key:  *        Origin of command flow
  1004.                  F_ --->  File Transfer Service primitive
  1005.                  N_ --->  Network Service primitive
  1006.                     ===>  ODETTE-FTP (OFTP) protocol message
  1007.  
  1008.  
  1009.  
  1010. Nash                         Informational                     [Page 18]
  1011.  
  1012. RFC 2204             ODETTE File Transfer Protocol        September 1997
  1013.  
  1014.  
  1015. 3.5  Service State Automata
  1016.  
  1017.    This state automata defines the service as viewed by the User
  1018.    Monitor.  Events causing a state transition are shown in lower case
  1019.    and the resulting action in upper case where appropriate.
  1020.  
  1021. 3.5.1  Idle State Diagram
  1022.  
  1023.                                  o------------o
  1024.                      decision    |            |  f_connect_ind
  1025.                +-----------------|    IDLE    |-----------------+
  1026.                |   F_CONNECT_RQ  |    (0)     |  F_CONNECT_RS   |
  1027.                |                 o------------o                 |
  1028.                V                                                |
  1029.       o-----------------o                                       |
  1030.       |                 |                                       |
  1031.       | I_WF_FCONNECTCF |                                       |
  1032.       |                 |                                       |
  1033.       o--------+--------o                                       |
  1034.                |                                                |
  1035.                | F_CONNECT_CF                                   |
  1036.                V                                                V
  1037.       o-----------------o                              o-----------------o
  1038.       |                 |                              |                 |
  1039.       |  IDLE  SPEAKER  |                              | IDLE  LISTENER  |
  1040.       |       (1)       |                              |       (2)       |
  1041.       |   See Speaker   |                              |  See Listener   |
  1042.       |  State Diagram  |                              |  State Diagram  |
  1043.       |                 |                              |                 |
  1044.       o-----------------o                              o-----------------o
  1045.  
  1046.  
  1047.  
  1048.  
  1049.  
  1050.  
  1051.  
  1052.  
  1053.  
  1054.  
  1055.  
  1056.  
  1057.  
  1058.  
  1059.  
  1060.  
  1061.  
  1062.  
  1063.  
  1064.  
  1065.  
  1066. Nash                         Informational                     [Page 19]
  1067.  
  1068. RFC 2204             ODETTE File Transfer Protocol        September 1997
  1069.  
  1070.  
  1071. 3.5.2  Speaker State Diagram
  1072.    o-----------------o                              o-----------------o
  1073.    |  IDLE LISTENER  |                              |      IDLE       |
  1074.    | CD_RQ just sent |                              |     see (0)     |
  1075.    | see (3), Listen |                              |      Idle       |
  1076.    |  State Diagram  |                              |  State Diagram  |
  1077.    o-----------------o                              o-----------------o
  1078.             A                                                A
  1079.             |                                                |
  1080.         decision          decision                        decision
  1081.         F_CD_RQ    +----------------+                   F_RELEASE_RQ
  1082.             |      |     F_EERP_RQ  |                        |
  1083.    o=================o              |               o-----------------o
  1084.    |                 |<-------------+               |  IDLE SPEAKER   |
  1085.    |  IDLE SPEAKER   |                              |       (4)       |
  1086.    |       (1)       |       decision               |     CD_IND      |
  1087.    |                 |<-----------------------------|  just received  |
  1088.    o=================o       F_EERP_RQ              o-----------------o
  1089.      A  A        |                                               |
  1090.      |  |        | decision and P1              decision and P1  |
  1091.      |  |        +-----------------+       +---------------------+
  1092.      |  |         F_START_FILE_RQ  |       |    F_START_FILE_RQ
  1093.      |  |                          V       V
  1094.      |  |                      o---------------o
  1095.      |  |  f_file_start_cf(-)  |               |
  1096.      |  +----------------------|    OPENING    |
  1097.      |                         |               |
  1098.      |                         o---------------o
  1099.      |                                 |
  1100.    f_file_close_cf(-)          f_start_file_cf(+)
  1101.      and not P2                        |
  1102.      |                                 V
  1103.    o---------------o           o---------------o
  1104.    |               |           |               |------------------+
  1105.    |    CLOSING    |           | DATA TRANSFER |  record to send  |
  1106.    |               |           |               |<-----------------+
  1107.    o---------------o           o---------------o    F_DATA_RQ
  1108.      |         A                   |
  1109.      |         |    end of file    |
  1110.      |         +-------------------+
  1111.      |            F_CLOSE_FILE_RQ
  1112.      |                                              o-----------------o
  1113.      |                f_close_file(+) and P2        |  IDLE LISTENER  |
  1114.      +--------------------------------------------->| see (2), Listen |
  1115.                                                     |  State Diagram  |
  1116.    Predicates:                                      o-----------------o
  1117.    P1: Mode = Both or (Mode = Sender-Only)
  1118.    P2: Negative confirmation or (positive confirmation, Speaker = YES)
  1119.  
  1120.  
  1121.  
  1122. Nash                         Informational                     [Page 20]
  1123.  
  1124. RFC 2204             ODETTE File Transfer Protocol        September 1997
  1125.  
  1126.  
  1127. 3.5.3  Listener State Diagram
  1128.    o-----------------o                              o-----------------o
  1129.    |  IDLE SPEAKER   |                              |      IDLE       |
  1130.    |   CD_IND just   |                              |                 |
  1131.    | received see(4) |                              |     see (0)     |
  1132.    |  Speaker State  |                              |      Idle       |
  1133.    |     Diagram     |                              |  State Diagram  |
  1134.    o-----------------o                              o-----------------o
  1135.             A                                                A
  1136.             |                                                |
  1137.          decision     f_eerp_ind                          decision
  1138.          F_CD_IND  +--------------+                    F_RELEASE_IND
  1139.             |      |              |                          |
  1140.    o=================o            |                 o-----------------o
  1141.    |                 |<-----------+    f_eerp_ind   |                 |
  1142.    |                 |<-----------------------------|  IDLE LISTENER  |
  1143.    |  IDLE LISTENER  |                              |       (3)       |
  1144.    |                 | f_start_file_ind             |      CD_RQ      |
  1145.    |       (2)       |    and not p2                |    just sent    |
  1146.    |                 |---------------------+        |                 |
  1147.    o=================o F_START_FILE_RS(-)  |        o-----------------o
  1148.      A   |      A  A                       |           |          |
  1149.      |   |      |  +-----------------------+           |          |
  1150.      |   |      |                                      |          |
  1151.      |   |      | f_start_file_ind and not p2          |          |
  1152.      |   |      +--------------------------------------+          |
  1153.      |   |               F_START_FILE_RS(-)                       |
  1154.      |   |                                                        |
  1155.      |   |           f_start_file_ind           f_start_file_ind  |
  1156.      |   |              and p2                        and p2      |
  1157.      |   +-------------------------------+     +------------------+
  1158.      |               F_START_FILE_RS(+)  |     | F_START_FILE_RS(+)
  1159.      |                                   V     V
  1160.      |                              o---------------o
  1161.      |  f_close_file_ind and not p1 |     DATA      |-------------+
  1162.      +------------------------------|   TRANSFER    |             |
  1163.           F_CLOSE_FILE_RS(-)        |               |<------------+
  1164.                                     o---------------o  F_DATA_IND
  1165.    o---------------o                           |
  1166.    | IDLE SPEAKER  |  f_close_file_ind and p1  |
  1167.    | see (1), Spkr |<--------------------------+
  1168.    | State Diagram |    F_CLOSE_FILE_RS(+)
  1169.    o---------------o
  1170.  
  1171.    Predicates:
  1172.    P1: (decision to send F_CLOSE_FILE_RS(+)) and
  1173.        (decision to set Speaker = yes in F_CLOSE_FILE_RS(+))
  1174.    P2: (decision to send F_START_FILE_RS(+))
  1175.  
  1176.  
  1177.  
  1178. Nash                         Informational                     [Page 21]
  1179.  
  1180. RFC 2204             ODETTE File Transfer Protocol        September 1997
  1181.  
  1182.  
  1183. 4. Protocol Specification
  1184.  
  1185. 4.1  Overview
  1186.  
  1187.    The ODETTE-FTP protocol is divided into five operating phases.
  1188.  
  1189.       Start Session
  1190.       Start File
  1191.       Data Transfer
  1192.       End File
  1193.       End Session
  1194.  
  1195.    After the End File phase an ODETTE-FTP entity may enter a new Start
  1196.    File phase or terminate the session via the End Session phase.
  1197.  
  1198.    ODETTE-FTP peers communicate by sending and receiving messages in
  1199.    Exchange Buffers via the Network Service.  Each Exchange Buffer
  1200.    contains one of the following commands.
  1201.  
  1202.       SSRM    Start Session Ready Message
  1203.       SSID    Start Session
  1204.       SFID    Start File
  1205.       SFPA    Start File Positive Answer
  1206.       SFNA    Start File Negative Answer
  1207.       DATA    Data
  1208.       CDT     Set Credit
  1209.       EFID    End File
  1210.       EFPA    End File Positive Answer
  1211.       EFNA    End File Negative Answer
  1212.       ESID    End Session
  1213.       CD      Change Direction
  1214.       EERP    End to End Response
  1215.       RTR     Ready To Receive
  1216.  
  1217.    The remainder of this section describes the protocol flows.  Section
  1218.    five details the command formats.
  1219.  
  1220. 4.2  Start Session Phase
  1221.  
  1222.    The Start Session phase is entered immediately after the network
  1223.    connection has been established.
  1224.  
  1225. 4.2.1  Entity Definition
  1226.  
  1227.    The ODETTE-FTP entity that took the initiative to establish the
  1228.    network connection becomes the Initiator.  It's peer becomes the
  1229.    Responder.
  1230.  
  1231.  
  1232.  
  1233.  
  1234. Nash                         Informational                     [Page 22]
  1235.  
  1236. RFC 2204             ODETTE File Transfer Protocol        September 1997
  1237.  
  1238.  
  1239. 4.2.2  Protocol Sequence
  1240.  
  1241.    The first message must be sent by the Responder.
  1242.  
  1243.    1. Initiator <-------------SSRM -- Responder   Ready Message
  1244.                 -- SSID ------------>             Identification
  1245.                 <------------ SSID --             Identification
  1246.  
  1247. 4.3  Start File Phase
  1248.  
  1249. 4.3.1  Entity Definition
  1250.  
  1251.    The Initiator from the Start Session phase is designated the Speaker
  1252.    while the Responder becomes the Listener.  The roles are reversed by
  1253.    the Speaker sending a Change Direction command to the Listener.
  1254.  
  1255. 4.3.2  Protocol Sequence
  1256.  
  1257.    1. Speaker  -- SFID ------------> Listener   Start File
  1258.                <------------ SFPA --            Answer YES
  1259.  
  1260.  
  1261.    2. Speaker  -- SFID ------------> Listener   Start File
  1262.                <------------ SFNA --            Answer NO
  1263.                      Go To 1
  1264.  
  1265.       Note: The User Monitor should take steps to prevent a loop
  1266.             situation occurring.
  1267.  
  1268.    2. Speaker  -- CD --------------> Listener   Change Direction
  1269.       Listener <------------ EERP -- Speaker    End to End Response
  1270.                -- RTR ------------->            Ready to Receive
  1271.                <------------ SFID --            Start File
  1272.  
  1273. 4.3.3  Restart Facilities
  1274.  
  1275.    The Start File command includes a count allowing the restart of an
  1276.    interrupted transmission to be negotiated.  If restart facilities are
  1277.    not available the restart count must be set to zero.  The sender will
  1278.    start with the lowest record count + 1.
  1279.  
  1280. 4.3.4  Broadcast Facilities
  1281.  
  1282.    The destination in a Start File command can be specified as follows.
  1283.  
  1284.    1.  An explicitly defined destination.
  1285.  
  1286.  
  1287.  
  1288.  
  1289.  
  1290. Nash                         Informational                     [Page 23]
  1291.  
  1292. RFC 2204             ODETTE File Transfer Protocol        September 1997
  1293.  
  1294.  
  1295.    2.  A group destination that allows an intermediate location to
  1296.        broadcast the Virtual File to multiple destinations.
  1297.  
  1298.    The Listener will send a negative answer to the Speaker when the
  1299.    destination is not known.
  1300.  
  1301. 4.3.5  Priority
  1302.  
  1303.    The prioritisation of files for transmission is left to the local
  1304.    implementation.  To allow some flexibility, a change direction
  1305.    mechanism is available in the End File phase.
  1306.  
  1307. 4.3.6  End To End Response (EERP)
  1308.  
  1309.    The End to End Response (EERP) command notifies the originator of a
  1310.    Virtual File that it has been successfully delivered to it's final
  1311.    destination.  This allows the originator to perform house keeping
  1312.    tasks such as deleting copies of the delivered data.
  1313.  
  1314.    A Response Command must be sent from the location performing the
  1315.    final processing or distribution of the data to the originator.  The
  1316.    Response is mandatory and may be sent in the same or in any
  1317.    subsequent session.
  1318.  
  1319.    When an intermediate location broadcasts or distributes a Virtual
  1320.    File it must receive a Response command from all the locations to
  1321.    which it forwarded the data before sending it's own Response.  This
  1322.    ensures that the Response received by the Virtual File's originator
  1323.    accounts for all the destination locations.  An intermediate location
  1324.    therefore needs to track the status of files it processes over time.
  1325.  
  1326.    Example: Point to Point
  1327.  
  1328.    Location A sends file Ba to Location B which will send an EERP to
  1329.    location A after it successfully receives the file.
  1330.  
  1331.    o----------o                          o-----------o
  1332.    | Loc. A   |----------- S1 ---------->| Loc. B    |
  1333.    |          |                          |           |
  1334.    | [Ba]     |<---------- R2 -----------| [Ba]      |
  1335.    +----------o                          o-----------o
  1336.  
  1337.    Key:
  1338.       S - File Transfer  R - Response EERP  [Ba] - File for B from A
  1339.  
  1340.  
  1341.  
  1342.  
  1343.  
  1344.  
  1345.  
  1346. Nash                         Informational                     [Page 24]
  1347.  
  1348. RFC 2204             ODETTE File Transfer Protocol        September 1997
  1349.  
  1350.  
  1351.    Example: Data distribution
  1352.  
  1353.    Location A sends a Virtual File containing data for distribution to
  1354.    locations B and C via clearing centres E1 and E2.  Clearing centre E1
  1355.    must wait for a response from E2 (for file Ba) and location C before
  1356.    it sends it's response, R8, to location A.  Clearing centre E2 can
  1357.    only send response R7 to E1 when location B acknowledges file Ba with
  1358.    response R6.
  1359.  
  1360.    o---------o        o---------o        o---------o        o---------o
  1361.    | Loc. A  |-- S1 ->| Loc. E1 |-- S2 ->| Loc. E2 |-- S5 ->| Loc. B  |
  1362.    |         |        |         |        |         |        |         |
  1363.    | [Ba,Ca] |<- R8 --| [Ba,Ca] |<- R7 --| [Ba]    |<- R6 --| [Ba]    |
  1364.    o---------o        o---------o        o---------o        o---------o
  1365.                          A   |
  1366.                          |   |           o---------o
  1367.                          |   +----- S3 ->| Loc. C  |
  1368.                          |               |         |
  1369.                          +--------- R4 --| [Ca]    |
  1370.                                          o---------o
  1371.  
  1372.    Example: Data collection
  1373.  
  1374.    Locations A and B send files Ca and Cb to clearing centre E1 which
  1375.    forwards both files to location C in a single Virtual File.  When it
  1376.    receives response R4 from C, clearing centre E1 sends response R5 to
  1377.    location A and R6 to location B.
  1378.  
  1379.    o---------o        o---------o        o---------o
  1380.    | Loc. A  |-- S1 ->| Loc. E1 |-- S3 ->| Loc. C  |
  1381.    |         |        |         |        |         |
  1382.    | [Ca]    |<- R5 --| [Ca,Cb] |<- R4 --| [Ca,Cb] |
  1383.    o---------o        o---------o        o---------o
  1384.                          A   |
  1385.    o---------o           |   |
  1386.    | Loc. B  |-- S2 -----+   |
  1387.    |         |               |
  1388.    | [Cb]    |<- R6 ---------+
  1389.    o---------o
  1390.  
  1391. 4.3.7  Ready To Receive Command (RTR)
  1392.  
  1393.    In order to avoid congestion between two adjacent nodes caused by a
  1394.    continuous flow of EERP's, a Ready To Receive (RTR) command is
  1395.    provided.  The RTR acts as an EERP acknowledgement for flow control
  1396.    but has no end-to-end significance.
  1397.  
  1398.  
  1399.  
  1400.  
  1401.  
  1402. Nash                         Informational                     [Page 25]
  1403.  
  1404. RFC 2204             ODETTE File Transfer Protocol        September 1997
  1405.  
  1406.  
  1407.       Speaker  -- EERP ------------> Listener   End to End Response
  1408.                <------------- RTR --            Ready to Receive
  1409.                -- EERP ------------>            End to End Response
  1410.                <------------- RTR --            Ready to Receive
  1411.                -- SFID ------------>            Start File
  1412.                          or
  1413.                -- CD -------------->            Exchange the turn
  1414.  
  1415.    After sending an EERP, the Speaker must wait for an RTR before
  1416.    sending any other commands.
  1417.  
  1418. 4.4  Data Transfer Phase
  1419.  
  1420.    Virtual File data flows from the Speaker to the Listener during the
  1421.    Data Transfer phase which is entered after the Start File phase.
  1422.  
  1423. 4.4.1  Protocol Sequence
  1424.  
  1425.    To avoid congestion at the protocol level a flow control mechanism is
  1426.    provided via the Credit (CDT) command.
  1427.  
  1428.    A Credit limit is negotiated in the Start Session phase, this
  1429.    represents the number of Data Exchange Buffers that the Speaker may
  1430.    send before it is obliged to wait for a Credit command from the
  1431.    Listener.
  1432.  
  1433.    The available credit is initially set to the negotiated value by the
  1434.    Start File positive answer, which acts as an implicit Credit command.
  1435.    The Speaker decreases the available credit count by one for each data
  1436.    buffer sent to the Listener.
  1437.  
  1438.    When the available credit is exhausted, the Speaker must wait for a
  1439.    Credit command from the Listener otherwise a protocol error will
  1440.    occur and the session will be aborted.
  1441.  
  1442.    The Listener should endeavour to send the Credit command without
  1443.    delay to prevent the Speaker blocking.
  1444.  
  1445.    1. Speaker  -- SFID ------------> Listener   Start File
  1446.                <------------ SFPA --            Answer YES
  1447.  
  1448.  
  1449.  
  1450.  
  1451.  
  1452.  
  1453.  
  1454.  
  1455.  
  1456.  
  1457.  
  1458. Nash                         Informational                     [Page 26]
  1459.  
  1460. RFC 2204             ODETTE File Transfer Protocol        September 1997
  1461.  
  1462.  
  1463.    2. If the Credit Value is set to 2
  1464.  
  1465.       Speaker  -- Data ------------> Listener   Start File
  1466.                -- Data ------------>
  1467.                <------------- CDT --            Set Credit
  1468.                -- Data ------------>
  1469.                -- EFID ------------>            End File
  1470.  
  1471. 4.5  End File Phase
  1472.  
  1473. 4.5.1  Protocol Sequence
  1474.  
  1475.    The Speaker notifies the Listener that it has finished sending a
  1476.    Virtual File by sending an End File (EFID) command.  The Listener
  1477.    replies with a positive or negative End File command and has the
  1478.    option to request a Change Direction command from the Speaker.
  1479.  
  1480.    1. Speaker  -- EFID ------------> Listener   End File
  1481.                <------------ EFPA --            Answer YES
  1482.  
  1483.  
  1484.    2. Speaker  -- EFID ------------> Listener   End File
  1485.                <------------ EFPA --            Answer YES + CD
  1486.                -- CD -------------->            Change Direction
  1487.       Listener <------------ EERP -- Speaker    End to End Response
  1488.                -------------- RTR ->            Ready to Receive
  1489.                Go to Start File Phase
  1490.  
  1491.  
  1492.    3. Speaker  -- EFID ------------> Listener   End File
  1493.                <------------ EFNA --            Answer NO
  1494.  
  1495. 4.6  End Session Phase
  1496.  
  1497. 4.6.1  Protocol Sequence
  1498.  
  1499.    The Speaker terminates the session by sending an End Session (ESID)
  1500.    command.
  1501.  
  1502.    1. Speaker  -- EFID ------------> Listener   End File
  1503.                <------------ EFPA --            Answer YES
  1504.                -- CD -------------->            Change Direction
  1505.       Listener <------------ ESID -- Speaker    End Session
  1506.  
  1507.  
  1508.  
  1509.  
  1510.  
  1511.  
  1512.  
  1513.  
  1514. Nash                         Informational                     [Page 27]
  1515.  
  1516. RFC 2204             ODETTE File Transfer Protocol        September 1997
  1517.  
  1518.  
  1519. 4.7  Problem Handling
  1520.  
  1521.    Error detection and handling should be done as close as possible to
  1522.    the problem.  This aids problem determination and correction.  Each
  1523.    layer of the reference model is responsible for it's own error
  1524.    handling.
  1525.  
  1526.    ODETTE-FTP can detect protocol errors through the construction of
  1527.    it's state machine, and uses activity timers to detect session hang
  1528.    conditions.  These mechanisms are separate from the End to End
  1529.    controls.
  1530.  
  1531. 4.7.1  Protocol Errors
  1532.  
  1533.    If a protocol error occurs the session will be terminated and
  1534.    application activity aborted.  Both locations enter the IDLE state.
  1535.  
  1536. 4.7.2  Timers
  1537.  
  1538.    To protect against application and network hang conditions ODETTE-FTP
  1539.    uses activity timers for all situations where a response is required.
  1540.    The timers and actions to be taken if they expire are described in
  1541.    section 8, the Protocol State Machine.
  1542.  
  1543. 4.7.3  Clearing Centres
  1544.  
  1545.    The use of clearing centres introduces the possibility of errors
  1546.    occurring as a result of data processing activities within the
  1547.    centre.  Such errors are not directly related to ODETTE-FTP or the
  1548.    communication network and are therefore outside the scope of this
  1549.    specification.
  1550.  
  1551. 5. Commands and Formats
  1552.  
  1553.    ODETTE-FTP entities communicate via Exchange Buffers.  The Command
  1554.    Exchange Buffers are described below.  Virtual File data is carried
  1555.    in Data Exchange Buffers which are described in Section 6.
  1556.  
  1557. 5.1  Conventions
  1558.  
  1559. 5.1.1  Representation unit:
  1560.  
  1561.    The basic unit of information is an octet, containing eight bits.
  1562.  
  1563. 5.1.2  Values and Characters:
  1564.  
  1565.    The ISO 646 IRV 7-bit coded character set [ISO-646] is used to encode
  1566.    constants and strings within command exchange buffers.
  1567.  
  1568.  
  1569.  
  1570. Nash                         Informational                     [Page 28]
  1571.  
  1572. RFC 2204             ODETTE File Transfer Protocol        September 1997
  1573.  
  1574.  
  1575. 5.2  Commands
  1576.  
  1577.    A Command Exchange Buffer contains a single command starting at the
  1578.    beginning of the buffer.  Commands and data are never mixed within an
  1579.    Exchange Buffer.  Each command has a fixed length and can not be
  1580.    compressed.
  1581.  
  1582.    Components:
  1583.  
  1584.    1. Command identifier:
  1585.  
  1586.       The first octet of an Exchange Buffer is the Command Identifier
  1587.       and defines the format of the buffer.
  1588.  
  1589.    2. Parameter(s):
  1590.  
  1591.       Command parameters are stored in fixed fields within a Command
  1592.       Exchange Buffer.  All values are required.
  1593.  
  1594. 5.3  Command Formats
  1595.  
  1596.    The ODETTE-FTP commands are described below using the following
  1597.    definitions.
  1598.  
  1599.    Position (Pos.)
  1600.  
  1601.       Field offset within the command exchange buffer, relative to a
  1602.       zero origin.
  1603.  
  1604.       Field
  1605.  
  1606.       The name of the field.
  1607.  
  1608.    Description
  1609.  
  1610.       A description of the field.
  1611.  
  1612.    Format
  1613.  
  1614.       F    - A field containing fixed values.  All allowable values for
  1615.              the field are enumerated in the command definition.
  1616.  
  1617.       V    - A field with variable values within a defined range.  For
  1618.              example the SFIDFSIZ field may contain any integer value
  1619.              between 0000000 and 9999999.
  1620.  
  1621.       X(n) - An alphanumeric field of length n octets.
  1622.  
  1623.  
  1624.  
  1625.  
  1626. Nash                         Informational                     [Page 29]
  1627.  
  1628. RFC 2204             ODETTE File Transfer Protocol        September 1997
  1629.  
  1630.  
  1631.       9(n) - A numeric field of length n octets.
  1632.  
  1633.       All attributes are in character format.
  1634.  
  1635.       A String contains alphanumeric characters from the following set:
  1636.  
  1637.          The numerals:               0 to 9
  1638.          The upper case letters:     A to Z
  1639.          The following special set:  / - . & ( ) space.
  1640.  
  1641.       Space is not allowed as an embedded character.
  1642.  
  1643.       Numeric fields are always right justified and left padding with
  1644.       zeros must be done when needed.
  1645.  
  1646. 5.3.1  SSRM - Start Session Ready Message
  1647.  
  1648.    o-------------------------------------------------------------------o
  1649.    |       SSRM        Start Session Ready Message                     |
  1650.    |                                                                   |
  1651.    |       Start Session Phase     Initiator <---- Responder           |
  1652.    |-------------------------------------------------------------------|
  1653.    | Pos | Field     | Description                           | Format  |
  1654.    |-----+-----------+---------------------------------------+---------|
  1655.    |   0 | SSRMCMD   | SSRM Command, 'I'                     | F X(1)  |
  1656.    |   1 | SSRMMSG   | Ready Message, 'ODETTE FTP READY '    | F X(17) |
  1657.    |  18 | SSRMCR    | Carriage Return                       | F X(1)  |
  1658.    o-------------------------------------------------------------------o
  1659.  
  1660.    SSRMCMD   Command Code                                      Character
  1661.  
  1662.       Value: 'I'  SSRM Command identifier.
  1663.  
  1664.    SSRMMSG   Ready Message                                    String(17)
  1665.  
  1666.       Value: 'ODETTE FTP READY '
  1667.  
  1668.    SSRMCR    Carriage Return                                   Character
  1669.  
  1670.       Value: Character with hex value '0D' or '8D'.
  1671.  
  1672.  
  1673.  
  1674.  
  1675.  
  1676.  
  1677.  
  1678.  
  1679.  
  1680.  
  1681.  
  1682. Nash                         Informational                     [Page 30]
  1683.  
  1684. RFC 2204             ODETTE File Transfer Protocol        September 1997
  1685.  
  1686.  
  1687. 5.3.2  SSID - Start Session
  1688.  
  1689.    o-------------------------------------------------------------------o
  1690.    |       SSID        Start Session                                   |
  1691.    |                                                                   |
  1692.    |       Start Session Phase     Initiator <---> Responder           |
  1693.    |-------------------------------------------------------------------|
  1694.    | Pos | Field     | Description                           | Format  |
  1695.    |-----+-----------+---------------------------------------+---------|
  1696.    |   0 | SSIDCMD   | SSID Command 'X'                      | F X(1)  |
  1697.    |   1 | SSIDLEV   | Protocol Release Level                | F 9(1)  |
  1698.    |   2 | SSIDCODE  | Initiator's Identification Code       | V X(25) |
  1699.    |  27 | SSIDPSWD  | Initiator's Password                  | V X(8)  |
  1700.    |  35 | SSIDSDEB  | Exchange Buffer Size                  | V 9(5)  |
  1701.    |  40 | SSIDSR    | Send / Receive Capabilities (S/R/B)   | F X(1)  |
  1702.    |  41 | SSIDCMPR  | Compression Indicator (Y/N)           | F X(1)  |
  1703.    |  42 | SSIDREST  | Restart Indicator (Y/N)               | F X(1)  |
  1704.    |  43 | SSIDSPEC  | Special Logic Indicator (N)           | F X(1)  |
  1705.    |  44 | SSIDCRED  | Credit                                | V 9(3)  |
  1706.    |  47 | SSIDRSV1  | Reserved                              | F X(5)  |
  1707.    |  52 | SSIDUSER  | User Data                             | V X(8)  |
  1708.    |  60 | SSIDCR    | Carriage Return                       | F X(1)  |
  1709.    o-------------------------------------------------------------------o
  1710.  
  1711.    SSIDCMD   Command Code                                      Character
  1712.  
  1713.       Value: 'X'  SSID Command identifier.
  1714.  
  1715.    SSIDLEV   Protocol Release Level                           Numeric(1)
  1716.  
  1717.       Value: '1' ODETTE-FTP protocol release level 1.
  1718.  
  1719.              Future release levels will have higher numbers.  The
  1720.              protocol release level is negotiable, with the lowest level
  1721.              being selected.
  1722.  
  1723.    SSIDCODE  Initiator's Identification Code                  String(25)
  1724.  
  1725.     Format:  See Identification Code (Section 5.4)
  1726.  
  1727.              Uniquely identifies the Initiator (sender) participating
  1728.              in the ODETTE-FTP session.
  1729.  
  1730.    SSIDPSWD  Password                                          String(8)
  1731.  
  1732.              Key to authenticate the sender.  Assigned by bilateral
  1733.              agreement.
  1734.  
  1735.  
  1736.  
  1737.  
  1738. Nash                         Informational                     [Page 31]
  1739.  
  1740. RFC 2204             ODETTE File Transfer Protocol        September 1997
  1741.  
  1742.  
  1743.    SSIDSDEB  Exchange Buffer Size                             Numeric(5)
  1744.  
  1745.     Minimum: 128
  1746.     Maximum: 99999
  1747.  
  1748.              The length, in octets, of the largest Exchange Buffer that
  1749.              can be accepted by the location.  The length includes the
  1750.              command octet but does not include the Stream Transmission
  1751.              Header.
  1752.  
  1753.              After negotiation the smallest size will be selected.
  1754.  
  1755.    SSIDSR    Send / Receive Capabilities                       Character
  1756.  
  1757.       Value: 'S'  Location can only send files.
  1758.              'R'  Location can only receive files.
  1759.              'B'  Location can both send and receive files.
  1760.  
  1761.              Sending and receiving will be serialised during the
  1762.              session, so parallel sessions will not take place.
  1763.  
  1764.              An error occurs if adjacent locations both specify the send
  1765.              or receive capability.
  1766.  
  1767.    SSIDCMPR  Compression Indication                            Character
  1768.  
  1769.       Value: 'Y'  The location can handle compressed data.
  1770.              'N'  The location can not handle compressed data.
  1771.  
  1772.              Compression is only used if supported by both locations.
  1773.              The compression mechanism is described in Section 6.2
  1774.  
  1775.    SSIDREST  Restart Indication                                Character
  1776.  
  1777.       Value: 'Y'  The location can handle the restart of a partially
  1778.                   transmitted file.
  1779.              'N'  The location can not restart a file.
  1780.  
  1781.    SSIDSPEC  Special Logic Indication                          Character
  1782.  
  1783.       Value: 'N'  Only valid value for TCP.
  1784.  
  1785.              The Special Logic extensions are only useful in an X.25
  1786.              environment and are not supported for TCP/IP.
  1787.  
  1788.  
  1789.  
  1790.  
  1791.  
  1792.  
  1793.  
  1794. Nash                         Informational                     [Page 32]
  1795.  
  1796. RFC 2204             ODETTE File Transfer Protocol        September 1997
  1797.  
  1798.  
  1799.    SSIDCRED  Credit                                           Numeric(3)
  1800.  
  1801.     Maximum: 999
  1802.  
  1803.              The number of consecutive Data Exchange Buffers sent by the
  1804.              Speaker before it must wait for a Credit (CDT) command from
  1805.              the Listener.
  1806.  
  1807.              The credit value is only applied to Data flow in the Data
  1808.              Transfer phase.
  1809.  
  1810.              The Speaker's available credit is initialised to SSIDCRED
  1811.              when it receives a Start File Positive Answer (SFPA)
  1812.              command from the Listener.  It is zeroed by the End File
  1813.              (EFID) command.
  1814.  
  1815.              After negotiation, the smallest size must be selected in
  1816.              the answer of the Responder, otherwise a protocol error
  1817.              will abort the session.
  1818.  
  1819.              Negotiation of the "credit-window-size" parameter.
  1820.  
  1821.              Window Size m  -- SSID ------------>
  1822.                             <------------ SSID --  Window Size n
  1823.                                                    (n less or equal m)
  1824.              Note: negotiated value will be "n".
  1825.  
  1826.    SSIDRSV1  Reserved                                          String(5)
  1827.  
  1828.              This field is reserved for future use.
  1829.  
  1830.    SSIDUSER  User Data                                         String(8)
  1831.  
  1832.              May be used by the ODETTE-FTP in any way.  If unused it
  1833.              should be initialised to spaces.  It is expected that a
  1834.              bilateral agreement exists as to the meaning of the data.
  1835.  
  1836.    SSIDCR    Carriage Return                                   Character
  1837.  
  1838.       Value: Character with hex value '0D' or '8D'.
  1839.  
  1840.  
  1841.  
  1842.  
  1843.  
  1844.  
  1845.  
  1846.  
  1847.  
  1848.  
  1849.  
  1850. Nash                         Informational                     [Page 33]
  1851.  
  1852. RFC 2204             ODETTE File Transfer Protocol        September 1997
  1853.  
  1854.  
  1855. 5.3.3  SFID - Start File
  1856.    o-------------------------------------------------------------------o
  1857.    |       SFID        Start File                                      |
  1858.    |                                                                   |
  1859.    |       Start File Phase           Speaker ----> Listener           |
  1860.    |-------------------------------------------------------------------|
  1861.    | Pos | Field     | Description                           | Format  |
  1862.    |-----+-----------+---------------------------------------+---------|
  1863.    |   0 | SFIDCMD   | SFID Command, 'H'                     | F X(1)  |
  1864.    |   1 | SFIDDSN   | Virtual File Dataset Name             | V X(26) |
  1865.    |  27 | SFIDRSV1  | Reserved                              | F X(9)  |
  1866.    |  36 | SFIDDATE  | Virtual File Date stamp, (YYMMDD)     | V X(6)  |
  1867.    |  42 | SFIDTIME  | Virtual File Time stamp, (HHMMSS)     | V X(6)  |
  1868.    |  48 | SFIDUSER  | User Data                             | V X(8)  |
  1869.    |  56 | SFIDDEST  | Destination                           | V X(25) |
  1870.    |  81 | SFIDORIG  | Originator                            | V X(25) |
  1871.    | 106 | SFIDFMT   | File Format, (F/V/U/T)                | F X(1)  |
  1872.    | 107 | SFIDLRECL | Maximum Record Size                   | V 9(5)  |
  1873.    | 112 | SFIDFSIZ  | File Size, 1K blocks                  | V 9(7)  |
  1874.    | 119 | SFIDREST  | Restart Position                      | V 9(9)  |
  1875.    o-------------------------------------------------------------------o
  1876.    SFIDCMD   Command Code                                      Character
  1877.  
  1878.       Value: 'H'  SFID Command identifier.
  1879.  
  1880.    SFIDDSN   Virtual File Dataset Name                        String(26)
  1881.  
  1882.              Dataset name of the Virtual File being transferred,
  1883.              assigned by bilateral agreement.
  1884.  
  1885.              No general structure is defined for this attribute.
  1886.  
  1887.              See Virtual Files - Identification (Section 1.5.2)
  1888.  
  1889.    SFIDRSV1  Reserved                                          String(9)
  1890.  
  1891.              This field is reserved for future use.
  1892.  
  1893.    SFIDDATE  Virtual File Date stamp                           String(6)
  1894.  
  1895.      Format: 'YYMMDD'  6 decimal digits representing the year, month
  1896.              and day respectively [ISO-8601].
  1897.  
  1898.              Date stamp assigned by the Virtual File's Originator
  1899.              indicating when the file was made available for
  1900.              transmission.
  1901.  
  1902.              See Virtual Files - Identification (Section 1.5.2)
  1903.  
  1904.  
  1905.  
  1906. Nash                         Informational                     [Page 34]
  1907.  
  1908. RFC 2204             ODETTE File Transfer Protocol        September 1997
  1909.  
  1910.  
  1911.    SFIDTIME  Virtual File Time stamp                           String(6)
  1912.  
  1913.      Format: 'HHMMSS'  6 decimal digits representing hours, minutes
  1914.              and seconds respectively [ISO-8601].
  1915.  
  1916.              Time stamp assigned by the Virtual File's Originator
  1917.              indicating when the file was made available for
  1918.              transmission.
  1919.  
  1920.              See Virtual Files - Identification (Section 1.5.2)
  1921.  
  1922.    SFIDUSER  User Data                                         String(8)
  1923.  
  1924.              May be used by the ODETTE-FTP in any way.  If unused it
  1925.              should be initialised to spaces.  It is expected that a
  1926.              bilateral agreement exists as to the meaning of the data.
  1927.  
  1928.    SFIDDEST  Destination                                      String(25)
  1929.  
  1930.      Format: See Identification Code (Section 5.4)
  1931.  
  1932.              The Final Recipient of the Virtual File.
  1933.  
  1934.              This is the location that will look into the Virtual File
  1935.              content and perform mapping functions.  It is also the
  1936.              location that creates the End to End Response (EERP)
  1937.              command for the received file.
  1938.  
  1939.    SFIDORIG  Originator                                       String(25)
  1940.  
  1941.      Format: See Identification Code (Section 5.4)
  1942.  
  1943.              Originator of the Virtual File.
  1944.              It is the location that created (mapped) the data for
  1945.              transmission.
  1946.  
  1947.    SFIDFMT   File Format                                       Character
  1948.  
  1949.       Value: 'F'  Fixed format binary file.
  1950.              'V'  Variable format binary file.
  1951.              'U'  Unstructured binary file.
  1952.              'T'  Text
  1953.  
  1954.              Virtual File format.  Used to calculate the restart
  1955.              position. (Section 1.5.3)
  1956.  
  1957.  
  1958.  
  1959.  
  1960.  
  1961.  
  1962. Nash                         Informational                     [Page 35]
  1963.  
  1964. RFC 2204             ODETTE File Transfer Protocol        September 1997
  1965.  
  1966.  
  1967.    SFIDLRECL Maximum Record Size                              Numeric(5)
  1968.  
  1969.     Maximum: 99999
  1970.  
  1971.              Length in octets of the longest logical record which may be
  1972.              transferred to a location.  Only user data is included.
  1973.  
  1974.              If SFIDFMT is 'T' or 'U' then this attribute must be set to
  1975.              '00000'.
  1976.  
  1977.    SFIDFSIZ  File Size                                        Numeric(7)
  1978.  
  1979.     Maximum: 9999999
  1980.  
  1981.              Space in 1K (1024 octet) blocks required at the Originator
  1982.              location to store the Virtual File.
  1983.  
  1984.              This parameter is intended to provide only a good estimate
  1985.              of the Virtual File size.
  1986.  
  1987.    SFIDREST  Restart Position                                 Numeric(9)
  1988.  
  1989.     Maximum: 999999999
  1990.  
  1991.              Virtual File restart position.
  1992.  
  1993.              The count represents the:
  1994.                 - Record Number if SSIDFMT is 'F' or 'V'.
  1995.                 - File offset in 1K (1024 octet) blocks if SSIDFMT is
  1996.                   'U' or 'T'.
  1997.  
  1998.              The count will express the transmitted user data (i.e.
  1999.              before compression, header not included).
  2000.  
  2001.              After negotiation between adjacent locations,
  2002.              retransmission will start at the lowest value.
  2003.  
  2004. 5.3.4  SFPA - Start File Positive Answer
  2005.    o-------------------------------------------------------------------o
  2006.    |       SFPA        Start File Positive Answer                      |
  2007.    |                                                                   |
  2008.    |       Start File Phase           Speaker <---- Listener           |
  2009.    |-------------------------------------------------------------------|
  2010.    | Pos | Field     | Description                           | Format  |
  2011.    |-----+-----------+---------------------------------------+---------|
  2012.    |   0 | SFPACMD   | SFPA Command, '2'                     | F X(1)  |
  2013.    |   1 | SFPAACNT  | Answer Count                          | V 9(9)  |
  2014.    o-------------------------------------------------------------------o
  2015.  
  2016.  
  2017.  
  2018. Nash                         Informational                     [Page 36]
  2019.  
  2020. RFC 2204             ODETTE File Transfer Protocol        September 1997
  2021.  
  2022.  
  2023.    SFPACMD   Command Code                                      Character
  2024.  
  2025.       Value: '2'  SFPA Command identifier.
  2026.  
  2027.    SFPAACNT  Answer Count                                     Numeric(9)
  2028.  
  2029.              The Listener must enter a count lower or equal to the
  2030.              restart count specified by the Speaker in the Start File
  2031.              (SFID) command.  The count expresses the received user
  2032.              data.  If restart facilities are not available, a count of
  2033.              zero must be specified.
  2034.  
  2035. 5.3.5  SFNA - Start File Negative Answer
  2036.  
  2037.    o-------------------------------------------------------------------o
  2038.    |       SFNA        Start File Negative Answer                      |
  2039.    |                                                                   |
  2040.    |       Start File Phase           Speaker <---- Listener           |
  2041.    |-------------------------------------------------------------------|
  2042.    | Pos | Field     | Description                           | Format  |
  2043.    |-----+-----------+---------------------------------------+---------|
  2044.    |   0 | SFNACMD   | SFNA Command, '3'                     | F X(1)  |
  2045.    |   1 | SFNAREAS  | Answer Reason                         | F 9(2)  |
  2046.    |   3 | SFNARRTR  | Retry Indicator, (Y/N)                | F X(1)  |
  2047.    o-------------------------------------------------------------------o
  2048.  
  2049.    SFNACMD   Command Code                                      Character
  2050.  
  2051.       Value: '3'  SFNA Command identifier.
  2052.  
  2053.    SFNAREAS  Answer Reason                                    Numeric(2)
  2054.  
  2055.       Value: '01'  Invalid filename.
  2056.              '02'  Invalid destination.
  2057.              '03'  Invalid origin.
  2058.              '04'  Storage record format not supported.
  2059.              '05'  Maximum record length not supported.
  2060.              '06'  File size is too big.
  2061.              '10'  Invalid record count.
  2062.              '11'  Invalid byte count.
  2063.              '12'  Access method failure.
  2064.              '13'  Duplicate file.
  2065.              '99'  Unspecified reason.
  2066.  
  2067.              Reason why transmission can not proceed.
  2068.  
  2069.  
  2070.  
  2071.  
  2072.  
  2073.  
  2074. Nash                         Informational                     [Page 37]
  2075.  
  2076. RFC 2204             ODETTE File Transfer Protocol        September 1997
  2077.  
  2078.  
  2079.    SFNARRTR  Retry Indicator                                   Character
  2080.  
  2081.       Value: 'N'  Transmission should not be retried.
  2082.              'Y'  The transmission may be retried latter.
  2083.  
  2084.              This parameter is used to advise the Speaker if it should
  2085.              retry at a latter point in time due to a temporary
  2086.              condition at the Listener site, such as a lack of storage
  2087.              space.  It should be used in conjunction with the Answer
  2088.              Reason code (SFNAREAS).
  2089.  
  2090.              An invalid file name error code may be the consequence of a
  2091.              problem in the mapping of the Virtual File on to a real
  2092.              file.  Such problems cannot always be resolved immediately.
  2093.              It it therefore recommended that when a SFNA with Retry = Y
  2094.              is received the User Monitor attempts to retransmit the
  2095.              relevant file in a subsequent session.
  2096.  
  2097. 5.3.6  DATA - Data Exchange Buffer
  2098.  
  2099.    o-------------------------------------------------------------------o
  2100.    |       DATA        Data Exchange Buffer                            |
  2101.    |                                                                   |
  2102.    |       Data Transfer Phase        Speaker ----> Listener           |
  2103.    |-------------------------------------------------------------------|
  2104.    | Pos | Field     | Description                           | Format  |
  2105.    |-----+-----------+---------------------------------------+---------|
  2106.    |   0 | DATACMD   | DATA Command, 'D'                     | F X(1)  |
  2107.    |   1 | DATABUF   | Data Exchange Buffer payload          | V X(n)  |
  2108.    o-------------------------------------------------------------------o
  2109.  
  2110.    DATACMD   Command Code                                      Character
  2111.  
  2112.       Value: 'D'  DATA Command identifier.
  2113.  
  2114.    DATABUF   Data Exchange Buffer payload                      String(n)
  2115.  
  2116.              Variable length buffer containing the data payload.  The
  2117.              Data Exchange Buffer is described in Section 6.
  2118.  
  2119.  
  2120.  
  2121.  
  2122.  
  2123.  
  2124.  
  2125.  
  2126.  
  2127.  
  2128.  
  2129.  
  2130. Nash                         Informational                     [Page 38]
  2131.  
  2132. RFC 2204             ODETTE File Transfer Protocol        September 1997
  2133.  
  2134.  
  2135. 5.3.7  CDT - Set Credit
  2136.  
  2137.    o-------------------------------------------------------------------o
  2138.    |       CDT         Set Credit                                      |
  2139.    |                                                                   |
  2140.    |       Data Transfer Phase        Speaker <---- Listener           |
  2141.    |-------------------------------------------------------------------|
  2142.    | Pos | Field     | Description                           | Format  |
  2143.    |-----+-----------+---------------------------------------+---------|
  2144.    |   0 | CDTCMD    | CDT Command, 'C'                      | F X(1)  |
  2145.    |   1 | CDTRSV1   | Reserved                              | F X(2)  |
  2146.    o-------------------------------------------------------------------o
  2147.  
  2148.    CDTCMD    Command Code                                      Character
  2149.  
  2150.       Value: 'C'  CDT Command identifier.
  2151.  
  2152.    CDTRSV1   Reserved                                          String(2)
  2153.  
  2154.              This field is reserved for future use.
  2155.  
  2156. 5.3.8  EFID - End File
  2157.  
  2158.    o-------------------------------------------------------------------o
  2159.    |       EFID        End File                                        |
  2160.    |                                                                   |
  2161.    |       End File Phase             Speaker ----> Listener           |
  2162.    |-------------------------------------------------------------------|
  2163.    | Pos | Field     | Description                           | Format  |
  2164.    |-----+-----------+---------------------------------------+---------|
  2165.    |   0 | EFIDCMD   | EFID Command, 'T'                     | F X(1)  |
  2166.    |   1 | EFIDRCNT  | Record Count                          | V 9(9)  |
  2167.    |  10 | EFIDUCNT  | Unit Count                            | V 9(12) |
  2168.    o-------------------------------------------------------------------o
  2169.  
  2170.    EFIDCMD   Command Code                                      Character
  2171.  
  2172.       Value: 'T'  EFID Command identifier.
  2173.  
  2174.    EFIDRCNT  Record Count                                     Numeric(9)
  2175.  
  2176.     Maximum: 999999999
  2177.  
  2178.              For SSIDFMT 'F' or 'V' the exact record count.
  2179.              For SSIDFMT 'U' or 'T' zeros.
  2180.  
  2181.  
  2182.  
  2183.  
  2184.  
  2185.  
  2186. Nash                         Informational                     [Page 39]
  2187.  
  2188. RFC 2204             ODETTE File Transfer Protocol        September 1997
  2189.  
  2190.  
  2191.              The count will express the real size of the file (before
  2192.              compression, header not included).  The total count is
  2193.              always used, even during restart processing.
  2194.  
  2195.    EFIDUCNT  Unit Count                                      Numeric(12)
  2196.  
  2197.     Maximum: 999999999999
  2198.  
  2199.              Exact number of units (octets) transmitted.
  2200.  
  2201.              The count will express the real size of the file.  The
  2202.              total count is always used, even during restart processing.
  2203.  
  2204. 5.3.9  EFPA - End File Positive Answer
  2205.    o-------------------------------------------------------------------o
  2206.    |       EFPA        End File Positive Answer                        |
  2207.    |                                                                   |
  2208.    |       End File Phase             Speaker <---- Listener           |
  2209.    |-------------------------------------------------------------------|
  2210.    | Pos | Field     | Description                           | Format  |
  2211.    |-----+-----------+---------------------------------------+---------|
  2212.    |   0 | EFPACMD   | EFPA Command, '4'                     | F X(1)  |
  2213.    |   1 | EFPACD    | Change Direction Indicator, (Y/N)     | F X(1)  |
  2214.    o-------------------------------------------------------------------o
  2215.  
  2216.    EFPACMD   Command Code                                      Character
  2217.  
  2218.       Value: '4'  EFPA Command identifier.
  2219.  
  2220.    EFPACD    Change Direction Indicator                        Character
  2221.  
  2222.       Value: 'N'  Change direction not requested.
  2223.              'Y'  Change direction requested.
  2224.  
  2225.              This parameter allows the Listener to request a Change
  2226.              Direction (CD) command from the Speaker.
  2227.  
  2228. 5.3.10  EFNA - End File Negative Answer
  2229.    o-------------------------------------------------------------------o
  2230.    |       EFNA        End File Negative Answer                        |
  2231.    |                                                                   |
  2232.    |       End File Phase             Speaker <---- Listener           |
  2233.    |-------------------------------------------------------------------|
  2234.    | Pos | Field     | Description                           | Format  |
  2235.    |-----+-----------+---------------------------------------+---------|
  2236.    |   0 | EFNACMD   | EFNA Command, '5'                     | F X(1)  |
  2237.    |   1 | EFNAREAS  | Answer Reason                         | F 9(2)  |
  2238.    o-------------------------------------------------------------------o
  2239.  
  2240.  
  2241.  
  2242. Nash                         Informational                     [Page 40]
  2243.  
  2244. RFC 2204             ODETTE File Transfer Protocol        September 1997
  2245.  
  2246.  
  2247.    EFNACMD   Command Code                                      Character
  2248.  
  2249.       Value: '5'  EFNA Command identifier.
  2250.  
  2251.    EFNAREAS  Answer Reason                                    Numeric(2)
  2252.  
  2253.       Value: '01'  Invalid filename.
  2254.              '02'  Invalid destination.
  2255.              '03'  Invalid origin.
  2256.              '04'  Storage record format not supported.
  2257.              '05'  Maximum record length not supported.
  2258.              '06'  File size is too big.
  2259.              '10'  Invalid record count.
  2260.              '11'  Invalid byte count.
  2261.              '12'  Access method failure.
  2262.              '13'  Duplicate file.
  2263.              '99'  Unspecified reason.
  2264.  
  2265.              Reason why transmission can not proceed.
  2266.  
  2267. 5.3.11  ESID - End Session
  2268.  
  2269.    o-------------------------------------------------------------------o
  2270.    |       ESID        End Session                                     |
  2271.    |                                                                   |
  2272.    |       End Session Phase          Speaker ----> Listener           |
  2273.    |-------------------------------------------------------------------|
  2274.    | Pos | Field     | Description                           | Format  |
  2275.    |-----+-----------+---------------------------------------+---------|
  2276.    |   0 | ESIDCMD   | ESID Command, 'F'                     | F X(1)  |
  2277.    |   1 | ESIDREAS  | Reason Code                           | F 9(2)  |
  2278.    |   3 | ESIDCR    | Carriage Return                       | F X(1)  |
  2279.    o-------------------------------------------------------------------o
  2280.  
  2281.    ESIDCMD   Command Code                                      Character
  2282.  
  2283.       Value: 'F'  ESID Command identifier.
  2284.  
  2285.    ESIDREAS  Reason Code                                      Numeric(2)
  2286.  
  2287.       Value  '00'  Normal session termination
  2288.  
  2289.              '01'  Command not recognised
  2290.  
  2291.                    An Exchange Buffer contains an invalid command code
  2292.                    (1st octet of the buffer).
  2293.  
  2294.  
  2295.  
  2296.  
  2297.  
  2298. Nash                         Informational                     [Page 41]
  2299.  
  2300. RFC 2204             ODETTE File Transfer Protocol        September 1997
  2301.  
  2302.  
  2303.              '02'  Protocol violation
  2304.  
  2305.                    An Exchange Buffer contains an invalid command for
  2306.                    the current state of the receiver.
  2307.  
  2308.              '03'  User code not known
  2309.  
  2310.                    A Start Session (SSID) command contains an unknown or
  2311.                    invalid Identification Code.
  2312.  
  2313.              '04'  Invalid password
  2314.  
  2315.                    A Start Session (SSID) command contained an invalid
  2316.                    password.
  2317.  
  2318.              '05'  Local site emergency close down
  2319.  
  2320.                    The local site has entered an emergency close down
  2321.                    mode.  Communications are being forcibly terminated.
  2322.  
  2323.              '06'  Command contained invalid data
  2324.  
  2325.                    A field within a Command Exchange buffer contains
  2326.                    invalid data.
  2327.  
  2328.              '07'  Exchange Buffer size error
  2329.  
  2330.                    The length of the Exchange Buffer as determined by
  2331.                    the Stream Transmission Header is different to the
  2332.                    length implied by the Command Code.
  2333.  
  2334.              '08'  Resources not available
  2335.  
  2336.                    The request for connection has been denied due to a
  2337.                    resource shortage.  The connection attempt should be
  2338.                    retried later.
  2339.  
  2340.              '09'  Time out
  2341.  
  2342.              '10'  Mode or capabilities incompatible
  2343.  
  2344.              '99'  Unspecified Abort code
  2345.  
  2346.                    An error was detected for which no specific code is
  2347.                    defined.
  2348.  
  2349.  
  2350.  
  2351.  
  2352.  
  2353.  
  2354. Nash                         Informational                     [Page 42]
  2355.  
  2356. RFC 2204             ODETTE File Transfer Protocol        September 1997
  2357.  
  2358.  
  2359.    ESIDCR    Carriage Return                                   Character
  2360.  
  2361.       Value: Character with hex value '0D' or '8D'.
  2362.  
  2363. 5.3.12  CD - Change Direction
  2364.  
  2365.    o-------------------------------------------------------------------o
  2366.    |       CD          Change Direction                                |
  2367.    |                                                                   |
  2368.    |       Start File Phase           Speaker ----> Listener           |
  2369.    |       End File Phase             Speaker ----> Listener           |
  2370.    |       End Session Phase        Initiator <---> Responder          |
  2371.    |-------------------------------------------------------------------|
  2372.    | Pos | Field     | Description                           | Format  |
  2373.    |-----+-----------+---------------------------------------+---------|
  2374.    |   0 | CDCMD     | CD Command, 'R'                       | F X(1)  |
  2375.    o-------------------------------------------------------------------o
  2376.  
  2377.    CDCMD     Command Code                                      Character
  2378.  
  2379.       Value: 'R'  CD Command identifier.
  2380.  
  2381. 5.3.13  EERP - End to End Response
  2382.  
  2383.    o-------------------------------------------------------------------o
  2384.    |       EERP        End to End Response                             |
  2385.    |                                                                   |
  2386.    |       Start File Phase           Speaker ----> Listener           |
  2387.    |       End File Phase             Speaker ----> Listener           |
  2388.    |-------------------------------------------------------------------|
  2389.    | Pos | Field     | Description                           | Format  |
  2390.    |-----+-----------+---------------------------------------+---------|
  2391.    |   0 | EERPCMD   | EERP Command, 'E'                     | F X(1)  |
  2392.    |   1 | EERPDSN   | Virtual File Dataset Name             | V X(26) |
  2393.    |  27 | EERPRSV1  | Reserved                              | F X(9)  |
  2394.    |  36 | EERPDATE  | Virtual File Date stamp, (YYMMDD)     | V X(6)  |
  2395.    |  42 | EERPTIME  | Virtual File Time stamp, (HHMMSS)     | V X(6)  |
  2396.    |  48 | EERPUSER  | User Data                             | V X(8)  |
  2397.    |  56 | EERPDEST  | Destination                           | V X(25) |
  2398.    |  81 | EERPORIG  | Originator                            | V X(25) |
  2399.    o-------------------------------------------------------------------o
  2400.  
  2401.    EERPCMD   Command Code                                      Character
  2402.  
  2403.       Value: 'E'  EERP Command identifier.
  2404.  
  2405.  
  2406.  
  2407.  
  2408.  
  2409.  
  2410. Nash                         Informational                     [Page 43]
  2411.  
  2412. RFC 2204             ODETTE File Transfer Protocol        September 1997
  2413.  
  2414.  
  2415.    EERPDSN   Virtual File Dataset Name                        String(26)
  2416.  
  2417.              Dataset name of the Virtual File being transferred,
  2418.              assigned by bilateral agreement.
  2419.  
  2420.              No general structure is defined for this attribute.
  2421.              See Virtual Files - Identification (Section 1.5.2)
  2422.  
  2423.    EERPRSV1  Reserved                                          String(9)
  2424.  
  2425.              This field is reserved for future use.
  2426.  
  2427.    EERPDATE  Virtual File Date stamp                           String(6)
  2428.  
  2429.      Format: 'YYMMDD'  6 decimal digits representing the year, month
  2430.              and day respectively [ISO-8601].
  2431.  
  2432.              Date stamp assigned by the Virtual File's Originator
  2433.              indicating when the file was made available for
  2434.              transmission.
  2435.  
  2436.              See Virtual Files - Identification (Section 1.5.2)
  2437.  
  2438.    EERPTIME  Virtual File Time stamp                           String(6)
  2439.  
  2440.       Format: 'HHMMSS'  6 decimal digits representing hours, minutes
  2441.              and seconds respectively [ISO-8601].
  2442.  
  2443.              Time stamp assigned by the Virtual File's Originator
  2444.              indicating when the file was made available for
  2445.              transmission.
  2446.  
  2447.              See Virtual Files - Identification (Section 1.5.2)
  2448.  
  2449.    EERPUSER  User Data                                         String(8)
  2450.  
  2451.              May be used by the ODETTE-FTP in any way.  If unused it
  2452.              should be initialised to spaces.  It is expected that a
  2453.              bilateral agreement exists as to the meaning of the data.
  2454.  
  2455.    EERPDEST  Destination                                      String(25)
  2456.  
  2457.      Format: See Identification Code (Section 5.4)
  2458.  
  2459.              Originator of the Virtual File.
  2460.  
  2461.              This is the location that created (mapped) the data for
  2462.              transmission.
  2463.  
  2464.  
  2465.  
  2466. Nash                         Informational                     [Page 44]
  2467.  
  2468. RFC 2204             ODETTE File Transfer Protocol        September 1997
  2469.  
  2470.  
  2471.    EERPORIG  Originator                                       String(25)
  2472.  
  2473.      Format: See Identification Code (Section 5.4)
  2474.  
  2475.              Final Recipient of the Virtual File.
  2476.              This is the location that will look into the Virtual File
  2477.              content and perform mapping functions.  It is also the
  2478.              location that creates the EERP for the received file.
  2479.  
  2480. 5.3.14  RTR - Ready To Receive
  2481.  
  2482.    o-------------------------------------------------------------------o
  2483.    |       RTR         Ready To Receive                                |
  2484.    |                                                                   |
  2485.    |       Start File Phase         Initiator <---- Responder          |
  2486.    |       End File Phase           Initiator <---- Responder          |
  2487.    |-------------------------------------------------------------------|
  2488.    | Pos | Field     | Description                           | Format  |
  2489.    |-----+-----------+---------------------------------------+---------|
  2490.    |   0 | RTRCMD    | RTR Command, 'P'                      | F X(1)  |
  2491.    o-------------------------------------------------------------------o
  2492.  
  2493.    RTRCMD    Command Code                                      Character
  2494.  
  2495.       Value: 'P'  RTR Command identifier.
  2496.  
  2497. 5.4  Identification Code
  2498.  
  2499.    The Initiator (sender) and Responder (receiver) participating in an
  2500.    ODETTE-FTP session are uniquely identified by an Identification Code
  2501.    based on [ISO 6523], Structure for the Identification of
  2502.    Organisations (SIO).  The locations are considered to be adjacent for
  2503.    the duration of the transmission.
  2504.  
  2505.    The SIO has the following format.
  2506.  
  2507.    o-------------------------------------------------------------------o
  2508.    | Pos | Field     | Description                           | Format  |
  2509.    |-----+-----------+---------------------------------------+---------|
  2510.    |   0 | SIOOID    | ODETTE Identifier                     | F X(1)  |
  2511.    |   1 | SIOICD    | International Code Designator         | V 9(4)  |
  2512.    |   5 | SIOORG    | Organisation Code                     | V X(14) |
  2513.    |  19 | SIOCSA    | Computer Sub-Address                  | V X(6)  |
  2514.    o-------------------------------------------------------------------o
  2515.    SIOOID    ODETTE Identifier                                 Character
  2516.  
  2517.       Value: 'O' Indicates ODETTE assigned Organisation Identifier.
  2518.                  Other values may be used for non-ODETTE codes.
  2519.  
  2520.  
  2521.  
  2522. Nash                         Informational                     [Page 45]
  2523.  
  2524. RFC 2204             ODETTE File Transfer Protocol        September 1997
  2525.  
  2526.  
  2527.    SIOICD    International Code Designator                     String(4)
  2528.  
  2529.              A code forming part of the Organisation Identifier.
  2530.  
  2531.    SIOORG    Organisation Code                                String(14)
  2532.  
  2533.              A code forming part of the Organisation Identifier.  This
  2534.              field may contain the letters A to Z, the digits 0 to 9,
  2535.              apace and hyphen characters.
  2536.  
  2537.    SIOCSA    Computer Sub-Address                              String(6)
  2538.  
  2539.              A locally assigned address which uniquely identifies a
  2540.              system within an organisation (defined by an Organisation
  2541.              Identifier).
  2542.  
  2543. 6. ODETTE-FTP Data Exchange Buffer
  2544.  
  2545. 6.1  Overview
  2546.  
  2547.    Virtual Files are transmitted by mapping the Virtual File records
  2548.    into Data Exchange Buffers, the maximum length of which was
  2549.    negotiated between the ODETTE-FTP entities via the Start Session
  2550.    (SSID) commands exchanged during the Start Session Phase of the
  2551.    protocol.  The format is based on the Network Independent File
  2552.    Transfer Protocol [NIFTP].
  2553.  
  2554.    Virtual File records may be of arbitrary length.  A simple
  2555.    compression scheme is defined for strings of repeated characters.
  2556.  
  2557.    An example of the use of the Data Exchange Buffer can be found in
  2558.    Appendix A.
  2559.  
  2560. 6.2  Data Exchange Buffer Format
  2561.  
  2562.    For transmission of Virtual File records, data is divided into
  2563.    Subrecords, each of which is preceded by a one octet Subrecord
  2564.    Header.
  2565.  
  2566.    The Data Exchange Buffer is made up of the initial Command character,
  2567.  
  2568.       o--------------------------------------------------------
  2569.       | C | H |           | H |           | H |           |   /
  2570.       | M | D | SUBRECORD | D | SUBRECORD | D | SUBRECORD |  /_
  2571.       | D | R |           | R |           | R |           |   /
  2572.       o-------------------------------------------------------
  2573.  
  2574.  
  2575.  
  2576.  
  2577.  
  2578. Nash                         Informational                     [Page 46]
  2579.  
  2580. RFC 2204             ODETTE File Transfer Protocol        September 1997
  2581.  
  2582.  
  2583.    CMD
  2584.  
  2585.       The Data Exchange Buffer Command Character, 'D'.
  2586.  
  2587.    HDR
  2588.  
  2589.       A one octet Subrecord Header defined as follows:
  2590.  
  2591.           0   1   2   3   4   5   6   7
  2592.         o-------------------------------o
  2593.         | E | C |                       |
  2594.         | o | F | C O U N T             |
  2595.         | R |   |                       |
  2596.         o-------------------------------o
  2597.  
  2598.       Bits
  2599.  
  2600.        0     End of Record Flag
  2601.  
  2602.              Set to indicate that the next subrecord is the last
  2603.              subrecord of the current record.
  2604.  
  2605.              Unstructured files are transmitted as a single record, in
  2606.              this case the flag acts as an end of file marker.
  2607.  
  2608.        1     Compression Flag
  2609.  
  2610.              Set to indicate that the next subrecord is compressed.
  2611.  
  2612.       2-7    Subrecord Count
  2613.  
  2614.              The number of octets in the Virtual File represented by the
  2615.              next subrecord expressed as a binary value.
  2616.  
  2617.              For uncompressed data this is simply the length of the
  2618.              subrecord.
  2619.  
  2620.              For compressed data this is the number of times that the
  2621.              single octet in the following subrecord must be inserted in
  2622.              the Virtual File.
  2623.  
  2624.              As six bits are available, the next subrecord may
  2625.              represent between 0 and 63 octets of the Virtual File.
  2626.  
  2627. 6.3  Buffer Filling Rules
  2628.  
  2629.    An Exchange Buffer may be any length up to the value negotiated in
  2630.    the Start Session exchange.
  2631.  
  2632.  
  2633.  
  2634. Nash                         Informational                     [Page 47]
  2635.  
  2636. RFC 2204             ODETTE File Transfer Protocol        September 1997
  2637.  
  2638.  
  2639.    Virtual File records may be concatenated within one Exchange Buffer
  2640.    or split across a number of buffers.
  2641.  
  2642.    A subrecord is never split between two Exchange Buffers.  If the
  2643.    remaining space in the current Exchange Buffer is insufficient to
  2644.    contain the next 'complete' subrecord one of the following strategies
  2645.    should be used:
  2646.  
  2647.    1. Truncate the Exchange Buffer, and put the complete
  2648.       subrecord (preceded by its header octet) in a new Exchange Buffer.
  2649.  
  2650.    2. Split the subrecord into two, filling the remainder of the
  2651.       Exchange Buffer with the first new subrecord and starting a new
  2652.       Exchange Buffer with the second.
  2653.  
  2654.    A record of length zero may appear anywhere in the Exchange Buffer.
  2655.  
  2656.    A subrecord of length zero may appear anywhere in the record and/or
  2657.    the Exchange Buffer.
  2658.  
  2659. 7. Stream Transmission Buffer (TCP only)
  2660.  
  2661. 7.1  Introduction
  2662.  
  2663.    The ODETTE-FTP was originally designed to utilise the ISO Network
  2664.    Service, specifically the X.25 specification.  It relies on the fact
  2665.    that the network service will preserve the sequence and boundaries of
  2666.    data units transmitted through the network and that the network
  2667.    service will pass the length of the data unit to the receiving
  2668.    ODETTE-FTP.  The TCP offers a stream based connection which does not
  2669.    provide these functions.
  2670.  
  2671.    In order to utilise the TCP stream without disruption to the existing
  2672.    ODETTE-FTP a Stream Transmission Buffer (STB) is created by adding a
  2673.    Stream Transmission Header (STH) to the start of all Command and Data
  2674.    Exchange Buffers before they are passed to the TCP transport service.
  2675.    This allows the receiving ODETTE-FTP to recover the original Exchange
  2676.    Buffers.
  2677.  
  2678.       STH - Stream Transmission Header
  2679.       OEB - ODETTE-FTP Exchange Buffer
  2680.  
  2681.    The Stream Transmission Buffer comprises of a STH and OEB.
  2682.  
  2683.    o-----+-----------------+-----+--------------------+-----+------
  2684.    | STH | OEB             | STH |  OEB               | STH | OEB/
  2685.    o-----+-----------------+-----+--------------------+-----+----
  2686.  
  2687.  
  2688.  
  2689.  
  2690. Nash                         Informational                     [Page 48]
  2691.  
  2692. RFC 2204             ODETTE File Transfer Protocol        September 1997
  2693.  
  2694.  
  2695. 7.2  Stream Transmission Header Format
  2696.  
  2697.    The Stream Transmission Header is shown below.  The fields are
  2698.    transmitted from left to right.
  2699.  
  2700.     0                   1                   2                   3
  2701.     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  2702.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2703.    |Version| Flags | Length                                        |
  2704.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  2705.  
  2706.    Version
  2707.  
  2708.       Value: 0001 (binary)
  2709.  
  2710.              Stream Transmission Header version number.
  2711.  
  2712.    Flags
  2713.  
  2714.       Value: 0000 (binary)
  2715.  
  2716.              Reserved for future use.
  2717.  
  2718.    Length
  2719.  
  2720.       Range: 5 - 100003 (decimal)
  2721.  
  2722.       The length of the Stream Transmission Buffer (STH+OEB).
  2723.  
  2724.       The smallest STB is 5 octets consisting of a 4 octet header
  2725.       followed by a 1 octet Exchange Buffer such as a Change Direction
  2726.       (CD) command.
  2727.  
  2728.       The maximum Exchange Buffer length that can be negotiated is 99999
  2729.       octets (Section 5.3.2) giving a STB length of 100003.
  2730.  
  2731.       The length is expressed as a binary number with the most
  2732.       significant bit on the left.
  2733.  
  2734.    It is expected that implementations of this protocol will follow the
  2735.    Internet robustness principle of being conservative in what is sent
  2736.    and liberal in what is accepted.
  2737.  
  2738.  
  2739.  
  2740.  
  2741.  
  2742.  
  2743.  
  2744.  
  2745.  
  2746. Nash                         Informational                     [Page 49]
  2747.  
  2748. RFC 2204             ODETTE File Transfer Protocol        September 1997
  2749.  
  2750.  
  2751. 8. Protocol State Machine
  2752.  
  2753. 8.1  ODETTE-FTP State Machine
  2754.  
  2755.    The operation of an ODETTE-FTP entity is formally defined by the
  2756.    State Machine presented below.  There are five State and Transition
  2757.    tables and for each table additional information is given in the
  2758.    associated Predicate and Action lists.
  2759.  
  2760.    The response of an ODETTE-FTP entity to the receipt of an event is
  2761.    defined by a Transition table entry indexed by the Event/State
  2762.    intersection within the appropriate State table.
  2763.  
  2764.    Each Transition table entry defines the actions taken, events
  2765.    generated and new state entered.  Predicates may be used within a
  2766.    table entry to select the correct response on the basis of local
  2767.    information held by the entity.
  2768.  
  2769.    A transition table contains the following fields:
  2770.  
  2771.    Index(I)    State transition index.
  2772.  
  2773.    Predicate   A list of predicates used to select between different
  2774.                possible transitions.  The predicates are defined in the
  2775.                Predicate and Action list.
  2776.  
  2777.    Actions     A list of actions taken by the entity.  The actions are
  2778.                defined in the Predicate and Action list.
  2779.  
  2780.    Events      Output events generated by the entity
  2781.  
  2782.    Next State  The new state of the entity.
  2783.  
  2784. 8.2  Error Handling
  2785.  
  2786.    The receipt of an event in a given state may be invalid for three
  2787.    reasons.
  2788.  
  2789.    1.  The case is impossible by construction of the state automata,
  2790.        denoted 'X' in the State tables.  For example a timer which has
  2791.        not been set cannot run out.
  2792.  
  2793.    2.  The event is the result of an error in the Network Service
  2794.        implementation, also denoted 'X' in the state tables.  The
  2795.        Network Service implementation is considered to be correct.
  2796.  
  2797.    3.  For all other cases the event is considered to be a User Error,
  2798.        denoted "U" in the state tables.
  2799.  
  2800.  
  2801.  
  2802. Nash                         Informational                     [Page 50]
  2803.  
  2804. RFC 2204             ODETTE File Transfer Protocol        September 1997
  2805.  
  2806.  
  2807.    The State tables define the conditions under which a User event is
  2808.    valid, thus preventing the generation of a protocol error by the
  2809.    ODETTE-FTP entity as a result of a User Monitor error.  The reaction
  2810.    of the entity to such errors is undefined and regarded as a local
  2811.    implementation issue.
  2812.  
  2813.    The State tables also allow protocol errors due to the receipt of
  2814.    invalid Exchange Buffers, to be detected.  In such cases the reaction
  2815.    of the entity to the error is defined.
  2816.  
  2817. 8.3  States
  2818.  
  2819.    The Command Mode is strictly a Half Duplex Flip-Flop Mode.
  2820.  
  2821.    A_NC_ONLY   Responder, Network Connection opened
  2822.  
  2823.                The Responder has sent it's Ready Message (SSRM) and is
  2824.                waiting for Start Session (SSID) from the Initiator.
  2825.  
  2826.    A_WF_CONRS  Responder Waiting for F_CONNECT_RS
  2827.  
  2828.                The Responder has received the Initiator's Start Session
  2829.                (SSID) and is waiting for a response (F_CONNECT_RS) from
  2830.                it's User Monitor.
  2831.  
  2832.    CDSTWFCD    CD_RQ stored in WF_CD state
  2833.  
  2834.                Since the User Monitor doesn't see the WF_CD state it may
  2835.                send a Change Direction request (F_CD_RQ) before the
  2836.                ODETTE-FTP receives a Change Direction (CD) command.
  2837.  
  2838.    CLIP        Close Input Pending
  2839.  
  2840.                The Listener has received an End File (EFID) command and
  2841.                is waiting for the Close File response (F_CLOSE_FILE_RS)
  2842.                from it's User Monitor.
  2843.  
  2844.    CLOP        Close Out Pending
  2845.  
  2846.                The Speaker has sent an End File (EFID) command and is
  2847.                waiting for an End File Answer (EFPA or EFNA).
  2848.  
  2849.    ERSTWFCD    End to End Response stored in WF_CD state
  2850.  
  2851.                Since the User Monitor doesn't see the WF_CD state it may
  2852.                send F_EERP_RQ, before the ODETTE-FTP receives a Change
  2853.                Direction (CD) command.
  2854.  
  2855.  
  2856.  
  2857.  
  2858. Nash                         Informational                     [Page 51]
  2859.  
  2860. RFC 2204             ODETTE File Transfer Protocol        September 1997
  2861.  
  2862.  
  2863.    IDLE        Connection IDLE
  2864.  
  2865.    IDLELI      Idle Listener
  2866.  
  2867.    IDLELICD    Idle Listener, F_CD_RQ Received
  2868.  
  2869.                The ODETTE-FTP entity has become the Listener after
  2870.                receiving a Change Direction request (F_CD_RQ) from the
  2871.                User Monitor.  The receipt of an End Session (ESID) is
  2872.                valid in this state.
  2873.  
  2874.    IDLESP      Idle Speaker
  2875.  
  2876.    IDLESPCD    Idle Speaker, F_CD_IND Sent
  2877.  
  2878.                The ODETTE-FTP entity has sent a Change Direction
  2879.                indication (F_CD_IND) to the User Monitor.  A Change
  2880.                Direction request (F_CD_RQ) is invalid in this state.
  2881.  
  2882.    I_WF_NC     Initiator Waiting for Network Connection
  2883.  
  2884.                The Initiator has requested a new network connection and
  2885.                is waiting for a Connection confirmation (N_CON_CF) from
  2886.                the Network Service.
  2887.  
  2888.    I_WF_RM     Initiator Waiting for Ready Message
  2889.  
  2890.                Before sending Start Session (SSID), the Initiator must
  2891.                wait for a Ready Message (SSRM) from the Responder.
  2892.  
  2893.    I_WF_SSID   Initiator Waiting for SSID
  2894.  
  2895.                The Initiator has sent a Start Session (SSID) command and
  2896.                is waiting for Start Session from the Responder.
  2897.  
  2898.    OPI         Open Input (Data Transfer Phase)
  2899.  
  2900.                The Listener is waiting for the Speaker to send a Data
  2901.                Exchange buffer.
  2902.  
  2903.    OPIP        Open Input Pending
  2904.  
  2905.                The Listener has received a Start File (SFID) command and
  2906.                is waiting for the Start File response (F_START_FILE_RS)
  2907.                from it's User Monitor.
  2908.  
  2909.  
  2910.  
  2911.  
  2912.  
  2913.  
  2914. Nash                         Informational                     [Page 52]
  2915.  
  2916. RFC 2204             ODETTE File Transfer Protocol        September 1997
  2917.  
  2918.  
  2919.    OPO         Open Out (Data Transfer Phase)
  2920.  
  2921.                The Speaker has received a Start File Positive Answer
  2922.                (SFPA) and is waiting for a Data (F_DATA_RQ) or Close
  2923.                File (F_CLOSE_FILE) request from it's User Monitor.
  2924.  
  2925.    OPOP        Open Out Pending
  2926.  
  2927.                The Speaker has sent a Start File (SFID) command and is
  2928.                waiting for a Start File Answer (SFPA or SFNA).
  2929.  
  2930.    OPOWFC      Open Out Wait for Credit
  2931.  
  2932.                The Speaker is waiting for a Set Credit (CDT) command
  2933.                before sending further Data Exchange buffers.
  2934.  
  2935.    SFSTWFCD    Start File Request stored in WF_CD state.
  2936.  
  2937.                Since the User Monitor doesn't see the WF_CD state it may
  2938.                send a Start File request (F_START_FILE_RQ) before the
  2939.                ODETTE-FTP receives a Change Direction (CD) command.
  2940.  
  2941.    WF_CD       Wait for Change Direction
  2942.  
  2943.                The Listener wishes to become the Speaker and is waiting
  2944.                for a Change Direction (CD) command after sending an End
  2945.                File Positive Answer (EFPA) requesting change direction.
  2946.  
  2947.    WF_RTR      Wait for Ready To Receive
  2948.  
  2949.                The Initiator has sent an End to End Response (EERP)
  2950.                command and must wait for Ready To Receive (RTR) from the
  2951.                Responder.
  2952.  
  2953.    WF_NDISC    Wait for N_DISC_IND
  2954.  
  2955.                ODETTE-FTP has sent an End Session (ESID) command and is
  2956.                waiting for a Disconnection indication (N_DISC_IND) from
  2957.                the Network Service.
  2958.  
  2959. 8.4  Input Events
  2960.  
  2961.    User Monitor Input Events (Section 3)
  2962.  
  2963.      F_DATA_RQ   F_CONNECT_RQ   F_START_FILE_RQ      F_CLOSE_FILE_RQ
  2964.      F_EERP_RQ   F_CONNECT_RS   F_START_FILE_RS(+)   F_CLOSE_FILE_RS(+)
  2965.      F_CD_RQ     F_ABORT_RQ     F_START_FILE_RS(-)   F_CLOSE_FILE_RS(-)
  2966.                  F_RELEASE_RQ
  2967.  
  2968.  
  2969.  
  2970. Nash                         Informational                     [Page 53]
  2971.  
  2972. RFC 2204             ODETTE File Transfer Protocol        September 1997
  2973.  
  2974.  
  2975.    Network Input Events (Section 2.2)
  2976.  
  2977.       N_CON_IND   N_CON_CF   N_DATA_IND   N_DISC_IND   N_RST_IND
  2978.  
  2979.    Peer ODETTE-FTP Input Events (Section 4)
  2980.  
  2981.       SSID   SFID   SFPA   SFNA   EFID   EFPA   EFNA
  2982.       DATA   ESID   EERP   RTR    CD     CDT    SSRM
  2983.  
  2984.    Internal Input Events
  2985.  
  2986.       TIME-OUT - Internal ODETTE-FTP timer expires.
  2987.  
  2988.    Input event parameters are denoted I.Event-name.Parameter-name within
  2989.    the state table action and predicate lists.  Their value can be
  2990.    examined but not changed by the ODETTE-FTP entity.
  2991.  
  2992. 8.5  Output Events
  2993.  
  2994.    User Monitor Output Events (Section 3)
  2995.  
  2996.      F_DATA_IND  F_CONNECT_IND  F_START_FILE_IND     F_CLOSE_FILE_IND
  2997.      F_EERP_IND  F_CONNECT_CF   F_START_FILE_CF(+)   F_CLOSE_FILE_CF(+)
  2998.      F_CD_IND    F_ABORT_IND    F_START_FILE_CF(-)   F_CLOSE_FILE_CF(-)
  2999.                  F_RELEASE_IND
  3000.  
  3001.    Network Output Events (Section 2.2)
  3002.  
  3003.       N_CON_RQ   N_CON_RS   N_DATA_RQ   N_DISC_RQ
  3004.  
  3005.    Peer ODETTE-FTP Output Events (Section 4)
  3006.  
  3007.       SSID   SFID   SFPA   SFNA   EFID   EFPA   EFNA
  3008.       DATA   ESID   EERP   RTR    CD     CDT    SSRM
  3009.  
  3010.    Output event parameters are denoted O.Event-name.Parameter-name
  3011.    within the state table action and predicate lists.  Their values can
  3012.    be examined and changed by the ODETTE-FTP entity.
  3013.  
  3014.  
  3015.  
  3016.  
  3017.  
  3018.  
  3019.  
  3020.  
  3021.  
  3022.  
  3023.  
  3024.  
  3025.  
  3026. Nash                         Informational                     [Page 54]
  3027.  
  3028. RFC 2204             ODETTE File Transfer Protocol        September 1997
  3029.  
  3030.  
  3031. 8.6  Local Variables
  3032.  
  3033.    The following variables are maintained by the ODETTE-FTP entity to
  3034.    assist the operation of the protocol.  They are denoted V.Variable-
  3035.    name within the state table action and predicate lists.  Their value
  3036.    can be examined and changed by the ODETTE-FTP entity.  The initial
  3037.    value of each variable is undefined.
  3038.  
  3039.    Variable     Type       Comments
  3040.    ---------------------------------------------------------------------
  3041.    Buf-size     Integer    Negotiated Exchange Buffer size.
  3042.    Called-addr  Address    Used to build O.F_CONNECT_IND.Called-addr
  3043.    Calling-addr Address    To build O.F_CONNECT_IND.Calling-addr
  3044.    Compression  Yes/No     Compression in used as agreed.
  3045.    Credit_L     Integer    Listeners credit counter.
  3046.    Credit_S     Integer    Speaker's credit counter.
  3047.    Id           String     Used to build O.SSID.Id
  3048.    Mode                    Sender-only, Receiver-only, Both.
  3049.    Pswd         String     Password, used to build O.SSID.Pswd
  3050.    Req-buf      Primitive  Input event (F_XXX_RQ) stored in WF_CD state.
  3051.    Restart      Yes/No     Restart in used as agreed.
  3052.    Restart-pos  Integer    Used only during file opening.
  3053.    Window       Integer    The Credit value negotiated for the session.
  3054.    ---------------------------------------------------------------------
  3055.  
  3056. 8.7  Local Constants
  3057.  
  3058.    The following constants define the capabilities of a given ODETTE-FTP
  3059.    entity.  They are denoted C.Constant-name within the state table
  3060.    action and predicate lists.  Their value can be examined but not
  3061.    changed by the ODETTE-FTP entity.
  3062.  
  3063.    Constant         Value               Comments
  3064.    ---------------------------------------------------------------------
  3065.    Cap-compression  Yes/No              Compression supported?
  3066.    Cap-init         Initiator           Must be Initiator.
  3067.                     Responder           Must be Responder.
  3068.                     Both                Can be Initiator or Responder.
  3069.    Cap-mode         Sender-only         Must be sender.
  3070.                     Receiver-only       Must be receiver.
  3071.                     Both                Can be sender or receiver.
  3072.    Max-buf-size     127 < Int < 100000  Maximum buffer size supported.
  3073.    Max-window       Int < 1000          Local maximum credit value.
  3074.    ---------------------------------------------------------------------
  3075.  
  3076.  
  3077.  
  3078.  
  3079.  
  3080.  
  3081.  
  3082. Nash                         Informational                     [Page 55]
  3083.  
  3084. RFC 2204             ODETTE File Transfer Protocol        September 1997
  3085.  
  3086.  
  3087. 8.8  Session Connection State Table
  3088.  
  3089. 8.8.1  State Table
  3090.  
  3091.    o----------------------------------------------o
  3092.    |   | Other States                             |
  3093.    |   |--------------------------------------o   |
  3094.    | S | A_WF_CONRS                           |   |
  3095.    |   |----------------------------------o   |   |
  3096.    | T | A_NC_ONLY                        |   |   |
  3097.    |   |------------------------------o   |   |   |
  3098.    | A | I_WF_SSID                    |   |   |   |
  3099.    |   |--------------------------o   |   |   |   |
  3100.    | T | I_WF_RM                  |   |   |   |   |
  3101.    |   |----------------------o   |   |   |   |   |
  3102.    | E | I_WF_NC              |   |   |   |   |   |
  3103.    |   |------------------o   |   |   |   |   |   |
  3104.    |   | IDLE             |   |   |   |   |   |   |
  3105.    |==================o---+---+---+---+---+---+---|
  3106.    |   | F_CONNECT_RQ | A | X | X | X | X | X | X |
  3107.    |   |--------------+---+---+---+---+---+---+---|
  3108.    | E | N_CON_CF     | X | C | X | X | X | X | X |
  3109.    |   |--------------+---+---+---+---+---+---+---|
  3110.    | V | SSRM         | X | X | H | X | X | X | X |
  3111.    |   |--------------+---+---+---+---+---+---+---|
  3112.    | E | SSID         | X | X | X | D | E | F | F |
  3113.    |   |--------------+---+---+---+---+---+---+---|
  3114.    | N | N_CON_IND    | B | X | X | X | X | X | X |
  3115.    |   |--------------+---+---+---+---+---+---+---|
  3116.    | T | F_CONNECT_RS | X | U | U | U | U | G | U |
  3117.    |   |--------------+---+---+---+---+---+---+---|
  3118.    |   | ESID(R=10)   | X | X | X | F | X | X | X |
  3119.    o----------------------------------------------o
  3120.  
  3121.  
  3122.  
  3123.  
  3124.  
  3125.  
  3126.  
  3127.  
  3128.  
  3129.  
  3130.  
  3131.  
  3132.  
  3133.  
  3134.  
  3135.  
  3136.  
  3137.  
  3138. Nash                         Informational                     [Page 56]
  3139.  
  3140. RFC 2204             ODETTE File Transfer Protocol        September 1997
  3141.  
  3142.  
  3143. 8.8.2  Transition Table
  3144.  
  3145.     I | Predicate    Actions     Output Events               Next State
  3146.    ===o=================================================================
  3147.     A | P1:                      F_ABORT_IND                 IDLE
  3148.       | not P1:      1           N_CON_RQ                    I_WF_NC
  3149.    ---+-----------------------------------------------------------------
  3150.     B | P3:                      N_DISC_RQ                   IDLE
  3151.       | not P3:                  N_CON_RS
  3152.       |                          SSRM                        A_NC_ONLY
  3153.    ---+-----------------------------------------------------------------
  3154.     C |              2                                       I_WF_RM
  3155.    ---+-----------------------------------------------------------------
  3156.     D | P2:          4,2,5       F_CONNECT_CF                IDLESP
  3157.       | not P2:      4,2         ESID(R=10)
  3158.       |                          F_ABORT_IND(R,AO=L)         WF_NDISC
  3159.    ---+-----------------------------------------------------------------
  3160.     E | P4:          4           N_DISC_RQ                   IDLE
  3161.       | not P4:                  F_CONNECT_IND               A_WF_CONRS
  3162.    ---+-----------------------------------------------------------------
  3163.     F |                          F_ABORT_IND
  3164.       |                          N_DISC_RQ                   IDLE
  3165.    ---+-----------------------------------------------------------------
  3166.     G | P2:          4,2,5       SSID                        IDLELI
  3167.       | not P2:      4,2         ESID(R=10)
  3168.       |                          F_ABORT_IND(R,AO=L)         WF_NDISC
  3169.    ---+-----------------------------------------------------------------
  3170.     H |              4,2,3       SSID                        I_WF_SSID
  3171.    ---------------------------------------------------------------------
  3172.  
  3173. 8.8.3  Predicates and Actions.
  3174.  
  3175.    Predicate P1:  (No resources available) OR
  3176.                   (C.Cap-init = Responder) OR
  3177.                   (C.Cap-mode = Sender-only AND
  3178.                      I.F_CONNECT_RQ.Mode = Receiver-only) OR
  3179.                   (C.Cap-mode = Receiver-only AND
  3180.                      I.F_CONNECT_RQ.Mode = Sender-only)
  3181.  
  3182.    Predicate P2:  Negotiation of (Buf-size, Restart, Compression,
  3183.                                   Mode, Credit) is OK.
  3184.  
  3185.    Predicate P3:  C.Cap-init = Initiator
  3186.  
  3187.    Predicate P4:  Mode in SSID incompatible with C.Cap-mode
  3188.  
  3189.  
  3190.  
  3191.  
  3192.  
  3193.  
  3194. Nash                         Informational                     [Page 57]
  3195.  
  3196. RFC 2204             ODETTE File Transfer Protocol        September 1997
  3197.  
  3198.  
  3199.        Action 1:  Set V.Mode from (C.Cap-mode, I.F_CONNECT_RQ.Mode)
  3200.                   Set V.Pswd, V.Id, V.Restart from I.F_CONNECT_RQ
  3201.                   Set V.Buf-size = C.Max-buf-size
  3202.                   Set V.Compression = C.Cap-compression
  3203.                   Build O.N_CON_RQ
  3204.  
  3205.        Action 2:  Start inactivity timer
  3206.  
  3207.        Action 3:  Set parameters in O.SSID = from local variables
  3208.  
  3209.        Action 4:  Stop timer
  3210.  
  3211.        Action 5:  Set V.Mode, V.Restart, V.Compression, V.Buf-size,
  3212.                       V.Window = from SSID
  3213.  
  3214. 8.9  Error and Abort State Table
  3215.  
  3216. 8.9.1  State Table
  3217.  
  3218.    o--------------------------------------o
  3219.    |   | Other States                     |
  3220.    | S |------------------------------o   |
  3221.    | T | WF_NDISC                     |   |
  3222.    | A |--------------------------o   |   |
  3223.    | T | I_WF_NC                  |   |   |
  3224.    | E |----------------------o   |   |   |
  3225.    |   | IDLE                 |   |   |   |
  3226.    |======================o---+---+---+---|
  3227.    |   | TIME-OUT         | X | X | A | B |
  3228.    |   |------------------+---+---+---+---|
  3229.    | E | F_ABORT_RQ       | X | A | X | C |
  3230.    | V |------------------+---+---+---+---|
  3231.    | E | N_RST_IND        | X | X | A | D |
  3232.    | N |------------------+---+---+---+---|
  3233.    | T | N_DISC_IND       | X | E | F | G |
  3234.    |   |------------------+---+---+---+---|
  3235.    |   | Invalid Buffer   | X | X | H | I |
  3236.    o--------------------------------------o
  3237.  
  3238.  
  3239.  
  3240.  
  3241.  
  3242.  
  3243.  
  3244.  
  3245.  
  3246.  
  3247.  
  3248.  
  3249.  
  3250. Nash                         Informational                     [Page 58]
  3251.  
  3252. RFC 2204             ODETTE File Transfer Protocol        September 1997
  3253.  
  3254.  
  3255. 8.9.2  Transition Table
  3256.  
  3257.     I | Predicate    Actions     Output Events              Next State
  3258.    ===o=================================================================
  3259.     A |                          N_DISC_RQ                 IDLE
  3260.    ---+-----------------------------------------------------------------
  3261.     B |                          F_ABORT_IND
  3262.       |                          N_DISC_RQ                 IDLE
  3263.    ---+-----------------------------------------------------------------
  3264.     C |              1           N_DISC_RQ                 IDLE
  3265.    ---+-----------------------------------------------------------------
  3266.     D |              1           N_DISC_RQ
  3267.       |                          F_ABORT_IND               IDLE
  3268.    ---+-----------------------------------------------------------------
  3269.     E |                          F_ABORT_IND               IDLE
  3270.    ---+-----------------------------------------------------------------
  3271.     F |              1                                     IDLE
  3272.    ---+-----------------------------------------------------------------
  3273.     G |              1           F_ABORT_IND               IDLE
  3274.    ---+-----------------------------------------------------------------
  3275.     H |                                                    WF_NDISC
  3276.    ---+-----------------------------------------------------------------
  3277.     I |              1,2         ESID(R=01)
  3278.       |                          F_ABORT_IND(R,AO=L)       WF_NDISC
  3279.    ---------------------------------------------------------------------
  3280.  
  3281. 8.9.3  Predicates and Actions.
  3282.  
  3283.        Action 1:  Stop inactivity timer
  3284.  
  3285.        Action 2:  Start inactivity timer
  3286.  
  3287. 8.10  Speaker State Table 1
  3288.  
  3289. 8.10.1  State Table
  3290.  
  3291.    The following abbreviations are used in the Speaker State table.
  3292.  
  3293.       F_REL_RQ(Ok)   -  F_RELEASE_RQ Reason = Normal
  3294.       F_REL_RQ(Err)  -  F_RELEASE_RQ Reason = Error
  3295.  
  3296.  
  3297.  
  3298.  
  3299.  
  3300.  
  3301.  
  3302.  
  3303.  
  3304.  
  3305.  
  3306. Nash                         Informational                     [Page 59]
  3307.  
  3308. RFC 2204             ODETTE File Transfer Protocol        September 1997
  3309.  
  3310.  
  3311.    o------------------------------------------------------------------o
  3312.    |   | Other State                                                  |
  3313.    |   |----------------------------------------------------------o   |
  3314.    |   | WF_NDISC                                                 |   |
  3315.    |   |------------------------------------------------------o   |   |
  3316.    |   | OPOWFC                                               |   |   |
  3317.    |   |--------------------------------------------------o   |   |   |
  3318.    |   | OPO                                              |   |   |   |
  3319.    | S |----------------------------------------------o   |   |   |   |
  3320.    |   | OPOP                                         |   |   |   |   |
  3321.    | T |------------------------------------------o   |   |   |   |   |
  3322.    |   | CDSTWFCD                                 |   |   |   |   |   |
  3323.    | A |--------------------------------------o   |   |   |   |   |   |
  3324.    |   | SFSTWFCD                             |   |   |   |   |   |   |
  3325.    | T |----------------------------------o   |   |   |   |   |   |   |
  3326.    |   | ERSTWFCD                         |   |   |   |   |   |   |   |
  3327.    | E |------------------------------o   |   |   |   |   |   |   |   |
  3328.    |   | WF_CD                        |   |   |   |   |   |   |   |   |
  3329.    |   |--------------------------o   |   |   |   |   |   |   |   |   |
  3330.    |   | WF_RTR                   |   |   |   |   |   |   |   |   |   |
  3331.    |   |----------------------o   |   |   |   |   |   |   |   |   |   |
  3332.    |   | IDLESPCD             |   |   |   |   |   |   |   |   |   |   |
  3333.    |   |------------------o   |   |   |   |   |   |   |   |   |   |   |
  3334.    |   | IDLESP           |   |   |   |   |   |   |   |   |   |   |   |
  3335.    |===+==============o---+---+---+---+---+---+---+---+---+---+---+---|
  3336.    |   | F_EERP_RQ    | A | A | W | F | W | U | U | U | U | U | U | U |
  3337.    |   |--------------+---+---+---+---+---+---+---+---+---+---+---+---|
  3338.    |   | F_START_     | B | B | W | G | W | U | U | U | U | U | X | U |
  3339.    |   |   FILE_RQ    |   |   |   |   |   |   |   |   |   |   |   |   |
  3340.    |   |--------------+---+---+---+---+---+---+---+---+---+---+---+---|
  3341.    |   | SFPA         | C | C | C | C | C | C | C | K | C | C | S | C |
  3342.    |   |--------------+---+---+---+---+---+---+---+---+---+---+---+---|
  3343.    | E | SFNA         | C | C | C | C | C | C | C | L | C | C | S | C |
  3344.    |   |--------------+---+---+---+---+---+---+---+---+---+---+---+---|
  3345.    | V | CD           | C | C | C | H | R | I | J | C | C | C | S | C |
  3346.    |   |--------------+---+---+---+---+---+---+---+---+---+---+---+---|
  3347.    | E | F_DATA_RQ    | U | U | U | U | U | U | U | U | M | V | S | U |
  3348.    |   |--------------+---+---+---+---+---+---+---+---+---+---+---+---|
  3349.    | N | CDT          | C | C | C | C | C | C | C | C | P | O | S | C |
  3350.    |   |--------------+---+---+---+---+---+---+---+---+---+---+---+---|
  3351.    | T | F_CD_RQ      | D | U | W | T | W | U | U | U | U | U | X | U |
  3352.    |   |--------------+---+---+---+---+---+---+---+---+---+---+---+---|
  3353.    |   | F_REL_RQ(Ok) | U | E | U | U | U | U | U | U | U | U | X | U |
  3354.    |   |--------------+---+---+---+---+---+---+---+---+---+---+---+---|
  3355.    |   | F_REL_RQ(Err)| Q | Q | Q | Q | Q | Q | Q | Q | Q | Q | S | Q |
  3356.    |   |--------------+---+---+---+---+---+---+---+---+---+---+---+---|
  3357.    |   | RTR          | C | C | N | C | C | C | C | C | C | C | S | C |
  3358.    o------------------------------------------------------------------o
  3359.  
  3360.  
  3361.  
  3362. Nash                         Informational                     [Page 60]
  3363.  
  3364. RFC 2204             ODETTE File Transfer Protocol        September 1997
  3365.  
  3366.  
  3367. 8.10.2  Transition Table
  3368.  
  3369.     I | Predicate    Actions     Output Events              Next State
  3370.    ===o=================================================================
  3371.     A |              1,2,3       EERP                       WF_RTR
  3372.    ---+-----------------------------------------------------------------
  3373.     B | P1:                                                 UE
  3374.       | not P1:      1,2,5       SFID                       OPOP
  3375.    ---+-----------------------------------------------------------------
  3376.     C |              1,2         ESID(R=02)
  3377.       |                          F_ABORT_IND(R,AO=L)        WF_NDISC
  3378.    ---+-----------------------------------------------------------------
  3379.     D |              1,2         CD                         IDLELICD
  3380.    ---+-----------------------------------------------------------------
  3381.     E |              1,2         ESID(R=00)                 WF_NDISC
  3382.    ---+-----------------------------------------------------------------
  3383.     F |              4                                      ERSTWFCD
  3384.    ---+-----------------------------------------------------------------
  3385.     G | P1:                                                 UE
  3386.       | not P1:      6                                      SFSTWFCD
  3387.    ---+-----------------------------------------------------------------
  3388.     H |              1,2                                    IDLESP
  3389.    ---+-----------------------------------------------------------------
  3390.     I |              1,2,10      SFID                       OPOP
  3391.    ---+-----------------------------------------------------------------
  3392.     J |              1,2         CD                         IDLELICD
  3393.    ---+-----------------------------------------------------------------
  3394.     K | P2:          1,2         ESID(R=02)
  3395.       |                          F_ABORT_IND(R,AO=L)        WF_NDISC
  3396.       | not P2:      1,2,7,12    F_START_FILE_CF(+)         OPO
  3397.    ---+-----------------------------------------------------------------
  3398.     L |              1,2,8       F_START_FILE_CF(-)         IDLESP
  3399.    ---+-----------------------------------------------------------------
  3400.     M | P3:          1,2,11,13   DATA                       OPOWFC
  3401.       | not P3:      1,2,11,13   DATA                       OPO
  3402.    ---+-----------------------------------------------------------------
  3403.     N |                          Note 3                     IDLESP
  3404.    ---+-----------------------------------------------------------------
  3405.     O |              12                                     OPO
  3406.       |                                                     See Note 1
  3407.    ---+-----------------------------------------------------------------
  3408.     P | Protocol     1,2         ESID(R=02)
  3409.       | Error                    F_ABORT_IND(R,AO=L)        WF_NDISC
  3410.    ---+-----------------------------------------------------------------
  3411.     Q |              1,2         ESID(R)                    WF_NDISC
  3412.    ---+-----------------------------------------------------------------
  3413.                                                             Continued -->
  3414.  
  3415.  
  3416.  
  3417.  
  3418. Nash                         Informational                     [Page 61]
  3419.  
  3420. RFC 2204             ODETTE File Transfer Protocol        September 1997
  3421.  
  3422.  
  3423.     I | Predicate    Actions     Output Events              Next State
  3424.    ===o=================================================================
  3425.     R |              1,2,9       EERP                       WF_RTR
  3426.    ---+-----------------------------------------------------------------
  3427.     S |                                                     WF_NDISC
  3428.    ---+-----------------------------------------------------------------
  3429.     T |                                                     CDSTWFCD
  3430.    ---+-----------------------------------------------------------------
  3431.     U |                          User Error                 UE
  3432.    ---+-----------------------------------------------------------------
  3433.     V |                          User Error - Note 1        UE
  3434.    ---+-----------------------------------------------------------------
  3435.     W |                          User Error - Note 2        UE
  3436.    ---+-----------------------------------------------------------------
  3437.     X |                          Error
  3438.    ---------------------------------------------------------------------
  3439.  
  3440. 8.10.3  Predicates and Actions.
  3441.  
  3442.    Predicate P1:  (I.F_START_FILE_RQ.Restart-pos > 0) AND
  3443.                   ((V.Restart = No) OR (V.Mode = Receiver-only))
  3444.  
  3445.            Note:  Restart requested and not supported for this session.
  3446.  
  3447.    Predicate P2:  (I.SFPA.Restart-pos > V.Restart-pos)
  3448.  
  3449.            Note:  Protocol error due to the restart position in the
  3450.                   SFPA acknowledgement being greater than the position
  3451.                   requested in the SFID request.
  3452.  
  3453.    Predicate P3:  V.Credit_S - 1 = 0
  3454.  
  3455.            Note:  Speaker's Credit is exhausted.
  3456.  
  3457.        Action 1:  Stop inactivity timer
  3458.  
  3459.        Action 2:  Start inactivity timer
  3460.  
  3461.        Action 3:  Build an EERP from F_EERP_RQ
  3462.  
  3463.        Action 4:  Store F_EERP_RQ in V.Req-buf
  3464.  
  3465.        Action 5:  Build SFID from F_START_FILE_RQ
  3466.                   V.Restart-pos = I.F_START_FILE_RQ.Restart-pos
  3467.  
  3468.        Action 6:  Store F_START_FILE_RQ in V.Req-buf
  3469.  
  3470.        Action 7:  Build F_START_FILE_CF(+) from I.SFPA
  3471.  
  3472.  
  3473.  
  3474. Nash                         Informational                     [Page 62]
  3475.  
  3476. RFC 2204             ODETTE File Transfer Protocol        September 1997
  3477.  
  3478.  
  3479.        Action 8:  Build F_START_FILE_CF(-) from I.SFNA
  3480.  
  3481.        Action 9:  Build EERP from F_EERP_RQ stored in V.Req-buf
  3482.  
  3483.        Action 10: Build SFID from F_START_FILE_RQ stored in V.Req-buf
  3484.                   Set V.Restart-pos
  3485.  
  3486.        Action 11: Build Exchange Buffer
  3487.  
  3488.        Action 12: V.Credit_S = V.Window
  3489.  
  3490.        Action 13: V.Credit_S = V.Credit_S - 1
  3491.  
  3492.           Note 1: The OPOWFC state prevents the Speaker from sending
  3493.                   data buffers because it is waiting for credit.  The
  3494.                   ODETTE-FTP entity may need to control the flow of Data
  3495.                   requests (F_DATA_RQ) from it's User Monitor to protect
  3496.                   it's own buffers.  Any such mechanism and the
  3497.                   behaviour of the entity should a User Error occur are
  3498.                   regarded as local implementation issues.
  3499.  
  3500.           Note 2: The choice to accept this "Request/Event" while in
  3501.                   this state is a matter of local implementation.  The
  3502.                   ODETTE state tables are based on the assumption that
  3503.                   this event cannot occur in this state and is
  3504.                   considered to be a user error (UE).
  3505.  
  3506.           Note 3: It is a local matter to make the User Monitor aware
  3507.                   that since the RTR is received, the protocol machine
  3508.                   is now ready to accept the next request.
  3509.  
  3510. 8.11  Speaker State Table 2
  3511.  
  3512. 8.11.1  State Table
  3513.  
  3514.    o---------------------------------o
  3515.    | S | CLOP                        |
  3516.    | T |-------------------------o   |
  3517.    | A | OPOWFC                  |   |
  3518.    | T |---------------------o   |   |
  3519.    | E | OPO                 |   |   |
  3520.    |=====================o---+---+---|
  3521.    | E | F_CLOSE_FILE_RQ | A | E | U |
  3522.    | V |-----------------+---+---+---|
  3523.    | E | EFPA            | B | B | C |
  3524.    | N |-----------------+---+---+---|
  3525.    | T | EFNA            | B | B | D |
  3526.    o---------------------------------o
  3527.  
  3528.  
  3529.  
  3530. Nash                         Informational                     [Page 63]
  3531.  
  3532. RFC 2204             ODETTE File Transfer Protocol        September 1997
  3533.  
  3534.  
  3535. 8.11.2  Transition Table
  3536.  
  3537.     I | Predicate    Actions     Output Events              Next State
  3538.    ===o=================================================================
  3539.     A |              1,2,5,7     EFID                       CLOP
  3540.    ---+-----------------------------------------------------------------
  3541.     B |              1,2         ESID(R=02)
  3542.       |                          F_ABORT_IND(R,AO=L)        WF_NDISC
  3543.    ---+-----------------------------------------------------------------
  3544.     C | P1:          1,2,3       F_CLOSE_FILE_CF(+,SP=No)
  3545.       |                          CD                         IDLELI
  3546.       | not P1:      1,2,4       F_CLOSE_FILE_CF(+,SP=Yes)  IDLESP
  3547.    ---+-----------------------------------------------------------------
  3548.     D |              1,2,6       F_CLOSE_FILE_CF(-)         IDLESP
  3549.    ---+-----------------------------------------------------------------
  3550.     E |                          See Note 1
  3551.    ---+-----------------------------------------------------------------
  3552.     U |                          User Error                 UE
  3553.    ---------------------------------------------------------------------
  3554.  
  3555. 8.11.3  Predicates and Actions.
  3556.  
  3557.    Predicate P1: (I.EFPA.CD-Request = Yes)  AND (V.Mode = Both)
  3558.  
  3559.        Action 1:  Stop inactivity timer
  3560.  
  3561.        Action 2:  Start inactivity timer
  3562.  
  3563.        Action 3:  O.F_CLOSE_FILE_CF(+).Speaker = No
  3564.  
  3565.        Action 4:  O.F_CLOSE_FILE_CF(+).Speaker = Yes
  3566.  
  3567.        Action 5:  Build EFID from F_CLOSE_FILE_RQ
  3568.  
  3569.        Action 6:  Build F_CLOSE_FILE_CF(-) from EFNA
  3570.  
  3571.        Action 7:  Set V.Credit_S = 0
  3572.  
  3573.          Note 1:  In order to respect the "half duplex" property of
  3574.                   ODETTE-FTP it is forbidden to send EFID while in the
  3575.                   OPOWFC state. EFID can be sent only in the OPO state.
  3576.  
  3577.                   The ODETTE-FTP implementation must avoid sending EFID
  3578.                   (or receiving F_CLOSE_FILE_RQ) while in the OPOWFC
  3579.                   state.
  3580.  
  3581.  
  3582.  
  3583.  
  3584.  
  3585.  
  3586. Nash                         Informational                     [Page 64]
  3587.  
  3588. RFC 2204             ODETTE File Transfer Protocol        September 1997
  3589.  
  3590.  
  3591. 8.12  Listener State Table
  3592.  
  3593. 8.12.1  State Table
  3594.  
  3595.    o-----------------------------------------o
  3596.    |   | CLIP                                |
  3597.    |   |---------------------------------o   |
  3598.    |   | OPI                             |   |
  3599.    | S |-----------------------------o   |   |
  3600.    | T | OPIP                        |   |   |
  3601.    | A |-------------------------o   |   |   |
  3602.    | T | IDLELICD                |   |   |   |
  3603.    | E |---------------------o   |   |   |   |
  3604.    |   | IDLELI              |   |   |   |   |
  3605.    |=====================o---+---+---+---+---|
  3606.    |   | SFID            | A | A | B | B | B |
  3607.    |   |-----------------+---+---+---+---+---|
  3608.    | E | DATA            | B | B | B | I | B |
  3609.    | V |-----------------+---+---+---+---+---|
  3610.    | E | EFID            | B | B | B | J | B |
  3611.    | N |-----------------+---+---+---+---+---|
  3612.    | T | F_START_FILE_RS | U | U | H | U | U |
  3613.    |   |-----------------+---+---+---+---+---|
  3614.    |   | F_CLOSE_FILE_RS | U | U | U | U | K |
  3615.    |   |-----------------+---+---+---+---+---|
  3616.    |   | CD              | C | B | B | B | B |
  3617.    |   |-----------------+---+---+---+---+---|
  3618.    |   | ESID R=Normal   | D | F | D | D | D |
  3619.    |   |-----------------+---+---+---+---+---|
  3620.    |   | ESID R=Error    | D | D | D | D | D |
  3621.    |   |-----------------+---+---+---+---+---|
  3622.    |   | EERP            | E | G | B | B | B |
  3623.    o-----------------------------------------o
  3624.  
  3625.  
  3626.  
  3627.  
  3628.  
  3629.  
  3630.  
  3631.  
  3632.  
  3633.  
  3634.  
  3635.  
  3636.  
  3637.  
  3638.  
  3639.  
  3640.  
  3641.  
  3642. Nash                         Informational                     [Page 65]
  3643.  
  3644. RFC 2204             ODETTE File Transfer Protocol        September 1997
  3645.  
  3646.  
  3647. 8.12.2  Transition Table
  3648.  
  3649.     I | Predicate    Actions       Output Events             Next State
  3650.    ===o=================================================================
  3651.     A | P1:          1,2           ESID(R=02)
  3652.       |                            F_ABORT_IND(R,AO=L)       WF_NDISC
  3653.       | not P1:      1,2,3         F_START_FILE_IND          OPIP
  3654.    ---+-----------------------------------------------------------------
  3655.     B |              1,2           ESID(R=02)
  3656.       |                            F_ABORT_IND(R,AO=L)       WF_NDISC
  3657.    ---+-----------------------------------------------------------------
  3658.     C |              1,2           F_CD_IND                  IDLESPCD
  3659.    ---+-----------------------------------------------------------------
  3660.     D |              1             F_ABORT_IND(Received
  3661.       |                               ESID Reason,AO=D)
  3662.       |                            N_DISC_RQ                 IDLE
  3663.    ---+-----------------------------------------------------------------
  3664.     E |              4             F_EERP_IND
  3665.       |              8             See Note 2
  3666.       |                            RTR                       IDLELI
  3667.    ---+-----------------------------------------------------------------
  3668.     F |              1             F_RELEASE_IND
  3669.       |                            N_DISC_RQ                 IDLE
  3670.    ---+-----------------------------------------------------------------
  3671.     G |                            F_EERP_IND
  3672.       |              8             See Note 2
  3673.       |                            RTR                       IDLELI
  3674.    ---+-----------------------------------------------------------------
  3675.     H | P4:                        User Error                UE
  3676.       | P2,not P4:   1,2           SFPA                      OPI
  3677.       | not(P2,P4):  1,2           SFNA                      IDLELI
  3678.    ---+-----------------------------------------------------------------
  3679.     I | P5:          1,2           ESID(R=02)
  3680.       |                            F_ABORT_IND(R,A0=L)       WF_NDISC
  3681.       | not(P5,P6):  1,2,5         F_DATA_IND                OPI
  3682.       | not P5,P6:   1,2           F_DATA_IND
  3683.       |              6,7           See Note 1
  3684.       |                            CDT                       OPI
  3685.    ---+-----------------------------------------------------------------
  3686.     J |              1,2           F_CLOSE_FILE_IND          CLIP
  3687.    ---+-----------------------------------------------------------------
  3688.     K | P2,P3:       1,2           EFPA(CD-Req)              WF_CD
  3689.       | P2,not P3:   1,2           EFPA(no CD)               IDLELI
  3690.       | not P2:      1,2           EFNA                      IDLELI
  3691.    ---+-----------------------------------------------------------------
  3692.     U |                            User Error                UE
  3693.    ---------------------------------------------------------------------
  3694.  
  3695.  
  3696.  
  3697.  
  3698. Nash                         Informational                     [Page 66]
  3699.  
  3700. RFC 2204             ODETTE File Transfer Protocol        September 1997
  3701.  
  3702.  
  3703. 8.12.3  Predicates and Actions.
  3704.  
  3705.    Predicate P1:  (I.SFID.Restart-pos > 0) AND (V.Restart = No)
  3706.  
  3707.            Note:  Invalid Start File command
  3708.  
  3709.    Predicate P2:  Positive Response
  3710.  
  3711.    Predicate P3:  I.F_CLOSE_FILE_RS(+).Speaker = Yes
  3712.  
  3713.    Predicate P4:  I.F_START_FILE_RS(+).Restart-pos > V.Restart
  3714.  
  3715.    Predicate P5:  V.Credit_L - 1 < 0
  3716.  
  3717.            Note:  Protocol Error because the Speaker has exceeded it's
  3718.                   available transmission credit.
  3719.  
  3720.    Predicate P6:  V.Credit_L - 1 = 0
  3721.  
  3722.            Note:  The Speaker's credit must be reset before it can send
  3723.                   further Data Exchange buffers.
  3724.  
  3725.        Action 1:  Stop inactivity timer.
  3726.  
  3727.        Action 2:  Start inactivity timer
  3728.  
  3729.        Action 3:  Build F_START_FILE_IND from I.SFID
  3730.                   V.Restart-pos = I.SFID.Restart-pos
  3731.  
  3732.        Action 4:  Build F_EERP_IND from I.EERP
  3733.  
  3734.        Action 5:  V.Credit_L = V.Credit_L - 1
  3735.  
  3736.        Action 6:  Wait for sufficient resources to receive up to
  3737.                   V.Window Data Exchange Buffers.
  3738.  
  3739.        Action 7:  V.Credit_L = V.Window
  3740.  
  3741.        Action 8:  Wait for resources required to process a new EERP.
  3742.  
  3743.          Note 1:  Flow control in case of reception.
  3744.  
  3745.                   The ODETTE-FTP Listener must periodically send new
  3746.                   credit to the Speaker.  The timing of this operation
  3747.                   will depend on:
  3748.  
  3749.                   1. The User Monitor's capacity the receive data.
  3750.                   2. The number of buffers available to ODETTE-FTP.
  3751.  
  3752.  
  3753.  
  3754. Nash                         Informational                     [Page 67]
  3755.  
  3756. RFC 2204             ODETTE File Transfer Protocol        September 1997
  3757.  
  3758.  
  3759.                   3. The Speaker's available credit, which must be
  3760.                      equal to zero.
  3761.  
  3762.          Note 2:  Generally, the ODETTE-FTP Listener will send RTR
  3763.                   immediately after receiving EERP.  If required, it can
  3764.                   delay the RTR until the resources required to process
  3765.                   a new EERP are available.
  3766.  
  3767. 8.13  Example
  3768.  
  3769.    Consider an ODETTE-FTP entity that has sent a Start File (SFID)
  3770.    command and entered the Open Out Pending (OPOP) state.  It's response
  3771.    on receiving a Positive Answer (SFPA) is documented in Speaker State
  3772.    Table 1 which shows that transition 'K' should be applied and is
  3773.    interpreted as follows:
  3774.  
  3775.       if (I.SFPA.Restart-pos > V.Restart-pos) then
  3776.       begin                                       // invalid restart
  3777.          Actions:   Stop inactivity timer,        // reset timer
  3778.                     Start inactivity timer;
  3779.          Output:    ESID(R=02),                   // to peer ODETTE-FTP
  3780.                     F_ABORT_IND(R,AO=L);          // to user monitor
  3781.          New State: WF_NDISC;
  3782.       end
  3783.       else begin
  3784.          Actions:   Stop inactivity timer,        // reset timer
  3785.                     Start inactivity timer;
  3786.                     Build F_START_FILE_CF(+) from I.SFPA
  3787.                     V.Credit_S = V.Window         // initialise credit
  3788.          Output:    F_START_FILE_CF(+);           // to user monitor
  3789.          New State: OPO;
  3790.       end
  3791.  
  3792.    The ODETTE-FTP checks the restart position in the received Start File
  3793.    Positive Answer (SFPA) command.  If it is invalid it aborts the
  3794.    session by sending an End Session (ESID) command to it's peer and an
  3795.    Abort indication (F_ABORT_IND) to it's User Monitor.  If the restart
  3796.    position is valid a Start File confirmation (F_START_FILE_CF) is
  3797.    built and sent to the User Monitor, the credit window is initialised
  3798.    and the Open Out (OPO) state is entered.
  3799.  
  3800. 9.  Security Considerations
  3801.  
  3802.    ODETTE-FTP exchanges user identity and password information in clear
  3803.    text.  It is therefore recommended that a lower layer (session,
  3804.    network or linkage) security protocol is used to protect the session
  3805.    from casual identity collection.
  3806.  
  3807.  
  3808.  
  3809.  
  3810. Nash                         Informational                     [Page 68]
  3811.  
  3812. RFC 2204             ODETTE File Transfer Protocol        September 1997
  3813.  
  3814.  
  3815. Appendix A.  Virtual File Mapping Example
  3816.  
  3817.    This example demonstrates the mapping of a Virtual File into a
  3818.    sequence of ODETTE-FTP Data Exchange Buffers and shows how each
  3819.    Stream Transmission Buffer is built from an ODETTE-FTP Data Exchange
  3820.    Buffer prefixed by a Stream Transmission Header.
  3821.  
  3822.    Each line in this extract from 'The Hunting of the Snark' by Lewis
  3823.    Carroll [SNARK] is considered to be a separate record in a file
  3824.    containing variable length records.  Note that it does not represent
  3825.    a text file and CR/LF record separators are not used.  The blank line
  3826.    is represented by a zero length record.
  3827.  
  3828.       "It's a Snark!" was the sound that first came to their ears,
  3829.            And seemed almost too good to be true.
  3830.       Then followed a torrent of laughter and cheers:
  3831.            Then the ominous words "It's a Boo-"
  3832.  
  3833.       Then, silence.  Some fancied they heard in the air
  3834.            A weary and wandering sigh
  3835.       Then sounded like "-jum!" but the others declare
  3836.            It was only a breeze that went by.
  3837.  
  3838.    Assuming that the minimum exchange buffer length of 128 octets has
  3839.    been negotiated the result of mapping the text into Stream
  3840.    Transmission Buffers may be as follows.
  3841.  
  3842.    Stream Transmission Buffer 1
  3843.  
  3844.       Text  :  ....D."It' s a Snark! " was the  sound that  first cam
  3845.       Hex-H :  10084B2472 7262566762 2276727662 7676627667 2667772666
  3846.       Hex-L :  00044C2947 30103E12B1 2071304850 3F5E404814 069234031D
  3847.       Key   :  ----D!.... .......... .......... .......... ..........
  3848.  
  3849.       Text  :  e to their  ears,. .A nd seemed  almost too  good to b
  3850.       Hex-H :  6276276667 26677242A4 6627666662 6666772766 2666627626
  3851.       Hex-L :  504F048592 05123C5061 E40355D540 1CDF3404FF 07FF404F02
  3852.       Key   :  .......... ......!.!. .......... .......... ..........
  3853.  
  3854.       Text  :  e true..Th en followe d a torren t
  3855.       Hex-H :  6277762156 6626666676 6262767766 72
  3856.       Hex-L :  504255E848 5E06FCCF75 40104F225E 40
  3857.       Key   :  .......!.. .......... .......... ..
  3858.  
  3859.       Text  :  ....D.of l aughter an d cheers:.  .Then the  ominous w
  3860.       Hex-H :  1007496626 6766767266 6266667734 2A56662766 2666667727
  3861.       Hex-L :  000847F60C 157845201E 40385523A5 04485E0485 0FD9EF5307
  3862.       Key   :  ----D!.... .......... .........! .!........ ..........
  3863.  
  3864.  
  3865.  
  3866. Nash                         Informational                     [Page 69]
  3867.  
  3868. RFC 2204             ODETTE File Transfer Protocol        September 1997
  3869.  
  3870.  
  3871.       Text  :  ords "It's  a Boo-".. Then, sile nce.  Some  fancied t
  3872.       Hex-H :  6767224727 262466228B 5666227666 6662225666 2666666627
  3873.       Hex-L :  F243029473 0102FFD202 485EC039C5 E35E003FD5 061E395404
  3874.       Key   :  .......... ........!! .......... .......... ..........
  3875.  
  3876.       Text  :  hey heard  in the air
  3877.       Hex-H :  6672666762 6627662667
  3878.       Hex-L :  8590851240 9E04850192
  3879.       Key   :  .......... ..........
  3880.  
  3881.    Stream Transmission Buffer 3
  3882.  
  3883.       Text  :  ....D. .A  weary and  wandering  sigh.Then  sounded li
  3884.       Hex-H :  1007442942 7667726662 7666676662 7666B56662 7676666266
  3885.       Hex-L :  0008450A10 7512901E40 71E4529E70 39780485E0 3F5E4540C9
  3886.       Key   :  ----D!.!.. .......... .......... ....!..... ..........
  3887.  
  3888.       Text  :  ke "-jum!"  but the o thers decl are. .It w as only a
  3889.       Hex-H :  6622267622 2677276626 7667726666 67642A4727 6726667262
  3890.       Hex-L :  B502DA5D12 025404850F 485230453C 1255029407 130FEC9010
  3891.       Key   :  .......... .......... .......... ...!.!.... ..........
  3892.  
  3893.       Text  :  breeze tha t went by.
  3894.       Hex-H :  6766762766 7276672672
  3895.       Hex-L :  2255A50481 4075E4029E
  3896.       Key   :  .......... ..........
  3897.  
  3898.    Notes:
  3899.       Hex-H       High order bits of octet
  3900.       Hex-L       Low order bits of octet
  3901.       Key:  ----  Stream Transmission Header
  3902.             D     Data Exchange Buffer command code 'D'
  3903.             !     Subrecord header octet
  3904.             .     Place holder
  3905.       All headers are represented with a period in the Text line.
  3906.  
  3907.    Each Data Exchange Buffer is preceded by a Stream Transmission
  3908.    Header.
  3909.  
  3910.    In the above mapping the first Data Exchange Buffer is 128 octets in
  3911.    length.  The last record has been continued in the second buffer.
  3912.  
  3913.    The second Data Exchange Buffer has been truncated at 116 octets to
  3914.    finish at the end of a record.  The following record being completely
  3915.    contained in the third buffer.  This is an alternative to spanning
  3916.    the record as shown between the first and second Data Exchange
  3917.    Buffers.
  3918.  
  3919.  
  3920.  
  3921.  
  3922. Nash                         Informational                     [Page 70]
  3923.  
  3924. RFC 2204             ODETTE File Transfer Protocol        September 1997
  3925.  
  3926.  
  3927.    The blank line has been encoded as a single header octet of '80' hex,
  3928.    indicating a zero length subrecord with the end of record flag set.
  3929.  
  3930.    The indented lines have been compressed.
  3931.  
  3932.  
  3933.  
  3934.  
  3935.  
  3936.  
  3937.  
  3938.  
  3939.  
  3940.  
  3941.  
  3942.  
  3943.  
  3944.  
  3945.  
  3946.  
  3947.  
  3948.  
  3949.  
  3950.  
  3951.  
  3952.  
  3953.  
  3954.  
  3955.  
  3956.  
  3957.  
  3958.  
  3959.  
  3960.  
  3961.  
  3962.  
  3963.  
  3964.  
  3965.  
  3966.  
  3967.  
  3968.  
  3969.  
  3970.  
  3971.  
  3972.  
  3973.  
  3974.  
  3975.  
  3976.  
  3977.  
  3978. Nash                         Informational                     [Page 71]
  3979.  
  3980. RFC 2204             ODETTE File Transfer Protocol        September 1997
  3981.  
  3982.  
  3983. Appendix B.  ISO 646 Character Subset
  3984.  
  3985.    o-----------------------------------------------------------------o
  3986.    |            |   7| 0   | 0   | 0   | 0   | 1   | 1   | 1   | 1   |
  3987.    |            | B -+-----+-----+-----+-----+-----+-----+-----+-----|
  3988.    |            | I 6|  0  |  0  |  1  |  1  |  0  |  0  |  1  |  1  |
  3989.    |            | T -+-----+-----+-----+-----+-----+-----+-----+-----|
  3990.    |            |   5|   0 |   1 |   0 |   1 |   0 |   1 |   0 |   1 |
  3991.    |            |----+-----+-----+-----+-----+-----+-----+-----+-----|
  3992.    |            |    |     |     |     |     |     |     |     |     |
  3993.    |            |    |     |     |     |     |     |     |     |     |
  3994.    |------------|    |  0  |  1  |  2  |  3  |  4  |  5  |  6  |  7  |
  3995.    |    BIT     |    |     |     |     |     |     |     |     |     |
  3996.    | 4  3  2  1 |    |     |     |     |     |     |     |     |     |
  3997.    |============o====o=====+=====+=====+=====+=====+=====+=====+=====|
  3998.    | 0  0  0  0 |  0 |     |     | SP  |  0  |     |  P  |     |     |
  3999.    |------------|----|-----+-----+-----+-----+-----+-----+-----+-----|
  4000.    | 0  0  0  1 |  1 |     |     |     |  1  |  A  |  Q  |     |     |
  4001.    |------------+----|-----+-----+-----+-----+-----+-----+-----+-----|
  4002.    | 0  0  1  0 |  2 |     |     |     |  2  |  B  |  R  |     |     |
  4003.    |------------+----|-----+-----+-----+-----+-----+-----+-----+-----|
  4004.    | 0  0  1  1 |  3 |     |     |     |  3  |  C  |  S  |     |     |
  4005.    |------------+----|-----+-----+-----+-----+-----+-----+-----+-----|
  4006.    | 0  1  0  0 |  4 |     |     |     |  4  |  D  |  T  |     |     |
  4007.    |------------+----|-----+-----+-----+-----+-----+-----+-----+-----|
  4008.    | 0  1  0  1 |  5 |     |     |     |  5  |  E  |  U  |     |     |
  4009.    |------------+----|-----+-----+-----+-----+-----+-----+-----+-----|
  4010.    | 0  1  1  0 |  6 |     |     |  &  |  6  |  F  |  V  |     |     |
  4011.    |------------+----|-----+-----+-----+-----+-----+-----+-----+-----|
  4012.    | 0  1  1  1 |  7 |     |     |     |  7  |  G  |  W  |     |     |
  4013.    |------------+----|-----+-----+-----+-----+-----+-----+-----+-----|
  4014.    | 1  0  0  0 |  8 |     |     |  (  |  8  |  H  |  X  |     |     |
  4015.    |------------+----|-----+-----+-----+-----+-----+-----+-----+-----|
  4016.    | 1  0  0  1 |  9 |     |     |  )  |  9  |  I  |  Y  |     |     |
  4017.    |------------+----|-----+-----+-----+-----+-----+-----+-----+-----|
  4018.    | 1  0  1  0 | 10 |     |     |     |     |  J  |  Z  |     |     |
  4019.    |------------+----|-----+-----+-----+-----+-----+-----+-----+-----|
  4020.    | 1  0  1  1 | 11 |     |     |     |     |  K  |     |     |     |
  4021.    |------------+----|-----+-----+-----+-----+-----+-----+-----+-----|
  4022.    | 1  1  0  0 | 12 |     |     |     |     |  L  |     |     |     |
  4023.    |------------+----|-----+-----+-----+-----+-----+-----+-----+-----|
  4024.    | 1  1  0  1 | 13 |     |     |  -  |     |  M  |     |     |     |
  4025.    |------------+----|-----+-----+-----+-----+-----+-----+-----+-----|
  4026.    | 1  1  1  0 | 14 |     |     |  .  |     |  N  |     |     |     |
  4027.    |------------+----|-----+-----+-----+-----+-----+-----+-----+-----|
  4028.    | 1  1  1  1 | 15 |     |     |  /  |     |  O  |     |     |     |
  4029.    o-----------------------------------------------------------------o
  4030.  
  4031.  
  4032.  
  4033.  
  4034. Nash                         Informational                     [Page 72]
  4035.  
  4036. RFC 2204             ODETTE File Transfer Protocol        September 1997
  4037.  
  4038.  
  4039. Acknowledgements
  4040.  
  4041.    This document draws extensively on revision 1.3 of the ODETTE File
  4042.    Transfer Specification [OFTP].
  4043.  
  4044.    Numerous people have contributed to the development of this protocol
  4045.    and their work is hereby acknowledged.  The extensions required to
  4046.    utilise the Transmission Control Protocol were formulated and agreed
  4047.    by the current members of ODETTE Working Group Four, who also
  4048.    provided helpful reviews and comments on this document.
  4049.  
  4050. References
  4051.  
  4052.    [OFTP]  Organisation for Data Exchange by Tele Transmission in
  4053.    Europe, Odette File Transfer Protocol, Revision 1.3:1993
  4054.  
  4055.    [RFC-739]  Postel, J., Transmission Control Protocol, STD 7, RFC 739,
  4056.    September 1981
  4057.  
  4058.    [ISO-646] International Organisation for Standardisation, ISO
  4059.    Standard 646:1991, "Information technology -- ISO 7-bit coded
  4060.    character set for information interchange", 1991
  4061.  
  4062.    [ISO-6523] International Organisation for Standardisation, ISO
  4063.    Standard 6523:1984, "Data interchange -- Structures for the
  4064.    identification of organisations", 1984
  4065.  
  4066.    [ISO-8601] International Organisation for Standardisation, ISO
  4067.    Standard 8601:1988 "Data elements and interchange formats --
  4068.    Information interchange -- Representation of dates and times", 1988
  4069.  
  4070.    [NIFTP] High Level Protocol Group, "A Network Independent File
  4071.    Transfer Protocol", 1981
  4072.  
  4073.    [SNARK] Carroll, Lewis "The Hunting of the Snark", 1876
  4074.  
  4075.  
  4076.  
  4077.  
  4078.  
  4079.  
  4080.  
  4081.  
  4082.  
  4083.  
  4084.  
  4085.  
  4086.  
  4087.  
  4088.  
  4089.  
  4090. Nash                         Informational                     [Page 73]
  4091.  
  4092. RFC 2204             ODETTE File Transfer Protocol        September 1997
  4093.  
  4094.  
  4095. ODETTE Address
  4096.  
  4097.    The ODETTE File Transfer Protocol is a product of Working Group Four
  4098.    of the Organisation for Data Exchange by Tele Transmission in Europe.
  4099.    The working group can be contacted via the ODETTE Secretariat:
  4100.  
  4101.    ODETTE Secretariat
  4102.    Forbes House
  4103.    Halkin Street
  4104.    London
  4105.    SW1X 7DS
  4106.    United Kingdom
  4107.  
  4108.    Phone: +44 (0)171 344 9227
  4109.    Fax:   +44 (0)171 235 7112
  4110.    EMail  odette@odette.org
  4111.           keith.oxley@odette.org
  4112.           stephanie.bioux@odette.org
  4113.  
  4114.  
  4115. Author's Address
  4116.  
  4117.    The author can be contacted at
  4118.  
  4119.    David Nash
  4120.    Ford Motor Company Limited
  4121.    Room 1/148, Central Office
  4122.    Eagle Way
  4123.    Warley
  4124.    Brentwood
  4125.    Essex
  4126.    CM13 3BW
  4127.    United Kingdom
  4128.  
  4129.    Phone: +44 (0)1277 253043
  4130.    EMail: dnash@ford.com
  4131.  
  4132.  
  4133.  
  4134.  
  4135.  
  4136.  
  4137.  
  4138.  
  4139.  
  4140.  
  4141.  
  4142.  
  4143.  
  4144.  
  4145.  
  4146. Nash                         Informational                     [Page 74]
  4147.  
  4148.