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