/doc/ftsc/fsc-0086.001

https://bitbucket.org/itorres/fidojs · Unknown · 171 lines · 122 code · 49 blank · 0 comment · 0 complexity · 71277540e767f03e522cf3d15edd06a7 MD5 · raw file

  1. | Document: FSC-0086
  2. | Version: 001
  3. | Date: 03 September 1995
  4. |
  5. | Mirko Mucko, 2:2433/920
  6. Information / Description of a new standard
  7. S tandard
  8. R equest
  9. I nformation
  10. F ile
  11. Copyright (c) 1994,95 by Gordian Schuermann & Mirko Mucko
  12. I Overview
  13. Introduction 0
  14. Description in general 1
  15. Required statements 1.1
  16. Optional statements 1.2
  17. Undefined options 1.3
  18. Implementation 2.0
  19. 0. Introduction
  20. In common, more and more mailer are about to implement the ability to
  21. call external request processors. But very soon, we discovered a command
  22. line cannot handle all the information the mailer has and the ERP needs.
  23. To transfer the information in a proper and fast way, we designed and
  24. implemented the S R I F option in the mean it will be a standard soon.
  25. The structure and idea is protected by copyright law, except these
  26. circumstances:
  27. + you may distrubute, use and implement this structure for free
  28. + you have not to pay any value for usage of these methodes
  29. + you should note in your documentation the origin of SRIF
  30. 1. Descritption
  31. The SRIF name is the only parameter given from the Mailer to the External
  32. Request Processor. The file is designated as a so called "plain vanilla ASCII"
  33. file, filled with pre-defined, optional and not-yet defined statemets.
  34. We discussed the possibility of binary files, and of EMSI-like files, but
  35. a plain ASCII control file is more flexible and can be read faster by
  36. various program languages (C, Pascal, Basic, Cobol ect).
  37. In the SRIF, one command plus parameter is allowed per line, the file
  38. is unlimited in length, comments are not allowed.
  39. The SRIF is generated by the Mailer and after the ERP finished its work,
  40. the Mailer is responsible for erasing the SRIF.
  41. 1.1 Required statements
  42. The following statements are required for the ERP:
  43. Sysop <Sysop_Name>
  44. This is the name of the remote sysop
  45. AKA <Zone:Net/Node[.Point][@Domain]>
  46. This is the main aka of the remote system in 4D or
  47. 5D notation. A zero as point number may be ommited,
  48. the domain with "@" is optional
  49. Baud <Current LINE rate>
  50. This is the effective baud rate, not the fixed DTE rate
  51. Time <Time in minutes>
  52. This is the time till next event which does not allow
  53. file requests. Use -1 if no limits
  54. RequestList <File of request list>
  55. This is the filename of the list containing requested
  56. files.
  57. ResponseList <File of response list>
  58. This is the filename of the response list.
  59. It must not be equal to RequestList. One file per line,
  60. including drives/pathes to the file. The first
  61. character defines the way the mailer should act after
  62. sending that file:
  63. = erase file if sent successfully
  64. + do not erase the file after sent
  65. - erase the file in any case after session
  66. RemoteStatus <PROTECTED or UNPROTECTED>
  67. Defines whether the session is protected by password
  68. or not
  69. SystemStatus <LISTED or UNLISTED>
  70. Defines whether the remote system is listed in any
  71. current nodelist of system.
  72. 1.2 Optional statements
  73. These parameters are already known and defined, but a ERP should run also
  74. without them:
  75. SessionProtocoll <e.g. ZAP,ZMO,XMA
  76. AKA <Zone:Net/Node[.Point][@Domain]>
  77. Additional AKAs. One AKA is required (see REQUIRED
  78. section)
  79. Site <Site Info>
  80. The site info as given e.g. in EMSI handshake
  81. Location <Location and/or ZIP>
  82. The location info as given e.g. in EMSI handshake
  83. Phone <Phone Number>
  84. The phone number info as given e.g. in EMSI handshake
  85. Password <Session password>
  86. On protected sessions, the session password. If
  87. no protected session, this parameter must be ommited!
  88. DTE <Current DTE rate>
  89. The PC<->Modem speed (so call DTE rate)
  90. PORT <COM Port from 1 to 8>
  91. The FOSSIL Communication Port. The Mailer should
  92. leave the fossil "hot" for the Request Processor
  93. Mailer <Remote's mailer if EMSI>
  94. The Mailer name as defined by FTC
  95. MailerCode <Remote's FTSC code>
  96. The hex code of the remote mailer as defined by FTC
  97. SerialNumber <Remote's serial number if passed>
  98. The remote mailer's serial number if transfered
  99. Version <Remote's version number if EMSI>
  100. The remote mailer's version number if transfered
  101. Revision <remote's revision number if EMSI>
  102. The remote mailer's revision number if transfered
  103. SessionType <may be EMSI, FTSC0001, WAZOO, JANUS, HYDRA or OTHER>
  104. The session-type, this may be one of the known
  105. session types or "OTHER" if not (yet) defined
  106. OurAKA <AKA which has been called for proper response>
  107. If the mailer does AKA matching, the AKA of the
  108. mailer being called
  109. TRANX <Tranx Line as 8 digit hex string>
  110. The unix-style time stamp (hexadecimal notation
  111. of seconds since 1.1.1980)
  112. 1.3 Undefined options
  113. There may be the need to add new commands / parameters to the SRI file. If
  114. so, they may be added, but inform us to keep the documentation "up to date"
  115. and to share your good ideas with other autors of software for FIDONet.
  116. 2.0 Implementation
  117. SRIF is implemented in these fine products already :
  118. Mailer Request Processor
  119. ------------------------------------------------------
  120. McMail xOR
  121. EasyERP
  122. Other products will follow soon !