home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / mag7demo.zip / PIPES.ZIP / MAGPIPE.DOC next >
Text File  |  1993-08-25  |  13KB  |  283 lines
  1.  
  2.                          Magnum Pipe Module v1.00C
  3.         (C)Copyright 1991, Gilmore Systems - All Rights Reserved
  4.  
  5. NOTICE:
  6. ------
  7.  
  8.    This document covers the use of both the OS/2 pipe module (MAGPIPE2.EXE)
  9.    and the DOS pipe module (MAGPIPE.EXE) although each is a separate product
  10.    sold separately.
  11.  
  12.                               ============
  13.                               Introduction
  14.                               ============
  15.  
  16.    Until the intdroduction of our Pipe Modules, the following methods were
  17.    available to actually "log on" to a Magnum BBS system:
  18.  
  19.       - Modem
  20.       - Keyboard/Console (at the machine the BBS is running on)
  21.       - Dumb Terminal (via null modem cable)
  22.  
  23.    Up until now, users of Magnum running on a LAN had the option of logging
  24.    on via "local logon modules" (LOCALBBS.EXE). However, the "local logon
  25.    modules" were merely an 'interface' to Magnum's databases. The user of
  26.    a "local logon module" was virtually running their own copy of Magnum in
  27.    order to log onto the databases, so to speak.
  28.  
  29.    Although there's advantages and disadvantages to the "local logon
  30.    modules", clearly the one major disadvantage was enough to sway many
  31.    LAN environments away from "local logon modules". This disadvantage was
  32.    the fact that the "local logon module" required the workstation to have
  33.    READ/WRITE access to EVERY directory used by Magnum on the server.
  34.    Although this was not a problem for everyone, it was nonetheless a
  35.    security risk. To others, the advantage of this method was tremendous...
  36.    unlimited numbers of users could be "logged on to the 'databases'"
  37.    concurrently.
  38.  
  39.    The solution to this problem has arrived with version 5.xx of Magnum: the
  40.    ability to support what's known as "Named Pipes". Most LAN software
  41.    such as IBM's Lan Server and Microsoft's Lan Manager support "Named
  42.    Pipes". This allows those with Magnum's "Pipe Module" to log onto Magnum
  43.    BBS itself - just as though they were calling in with a modem. As with a
  44.    modem, users logged on via "named pipe" have no direct access to anything
  45.    on the BBS machine (server) other than what the BBS lets them have access
  46.    to. The BBS (not the user or workstation) has access to the files and
  47.    directories, which, by many corporate standards, is the way it should be.
  48.  
  49.    Up until now, there was no possible way for the user of a DOS workstation
  50.    to be able to log onto Magnum (the "localbbs.exe" program was OS/2 only).
  51.    With the advent of "named pipe" support for DOS 5 workstations, now users
  52.    on DOS workstations can also log onto Magnum!
  53.  
  54.    With the advent of our "pipe modules", the old "localbbs.exe" method was
  55.    discontinued at the close of Magnum v4.00.
  56.  
  57.    NOTICE: Magnum BBS (MBBS.EXE) must be running on a SERVER (or PEER SERVER)
  58.            in order for your pipe module(s) to access the BBS.
  59.  
  60.    There are two pipe modules (sold separately):
  61.  
  62.          MAGPIPE.EXE - For  DOS Workstations on a LAN
  63.         MAGPIPE2.EXE - For OS/2 Workstations on a LAN
  64.  
  65.    Each module is sold as a one-time license fee for use on your LAN. You
  66.    may make as many copies of your Pipe Module as you wish and distribute
  67.    them to as many workstations on your LAN as you wish. Each Pipe Module
  68.    has been serialized to match the serial number of your BBS. If you're
  69.    running more than one copy of Magnum on your LAN, you'll need to purchase
  70.    additional copies of the Pipe Module(s). Each Pipe Module will only work
  71.    with the Serial Number of the Magnum BBS it is encoded for.
  72.  
  73.    The operation of both programs are identical. However, because of the
  74.    way DOS is designed, the following restrictions are imposed by Magnum
  75.    to the user logged on via MAGPIPE.EXE from a DOS Workstation:
  76.  
  77.          - Cannot Stop Displays with <Ctrl-X> or Spacebar.
  78.          - Cannot use 'Chat' functions (not even between Sysop and User).
  79.          - Cannot execute any interactive Child (door) programs. Programs
  80.            which are non-interactive are fine, and RJE programs are fine.
  81.  
  82.    There are NO restrictions for users of MAGPIPE2.EXE (for OS/2
  83.    workstations). Anything a caller via modem can do, so can a user of
  84.    the OS/2 pipe module. With the exception of the above limitations, the
  85.    same can be said of a DOS workstation user.
  86.  
  87.                         ===========================
  88.                         Installing the Pipe Modules
  89.                         ===========================
  90.  
  91.    Once you've installed Magnum version 5.02 or higher and have it "up and
  92.    running" successfully, you will be ready to set up your BBS for use with
  93.    the pipe modules.
  94.  
  95.    Currently there are 10 configurations for Magnum:
  96.  
  97.          DEMO ( 1 dialup + console)
  98.        2-node ( 1 dialup + console)
  99.        3-node ( 2 dialup + console)
  100.        4-node ( 3 dialup + console)
  101.        5-node ( 4 dialup + console)
  102.        9-node ( 8 dialup + console)
  103.       13-node (12 dialup + console)
  104.       17-node (16 dialup + console)
  105.       25-node (24 dialup + console)
  106.       33-node (32 dialup + console)
  107.  
  108.    ANY of your "dialup" nodes can be configured for "modem use" (as has
  109.    always been the case until now), or "pipe use". Thus, if you're using the
  110.    4-node version (3 dialup) with 3 modems, you'll have to give up one of
  111.    your modems to convert that node to "pipe" use.
  112.  
  113.    To set up ANY dialup node(s) for pipe use, perform the following steps:
  114.  
  115.       1) Shut down the BBS (or deactivate the node you'll be working with
  116.          with the 'x inactive' command).
  117.  
  118.       2) Remake the STARTUP.x file for that node:
  119.  
  120.            MAKEMBBS -x >STARTUP.x
  121.  
  122.          where 'x' is the node number.
  123.  
  124.       3) Bring the STARTUP.x file into your text editor and change the
  125.          DEVICENAME: parameter to:
  126.  
  127.             DEVICENAME: \PIPE\MAGNODEx
  128.  
  129.          where 'x' is the node number. NOTE: This is an example only, you
  130.          can give the DEVICENAME any name you wish as long as the following
  131.          is observed:
  132.  
  133.              - The name MUST start with:   \PIPE\
  134.                (it MUST be preceded and succeeded with the \ character).
  135.  
  136.              - The part after \PIPE\ must conform to the naming conventions
  137.                of an OS/2 filename (or DOS if you want DOS workstations to
  138.                be able to log onto this node). Note that DOS observes the
  139.                8.3 naming conventions, so if you're using the 17-node node
  140.                version of Magnum, a pipe name such as \PIPE\MAGNODE12 will
  141.                not be accessible to DOS workstations because the MAGNODE12
  142.                part of the name is 9 characters in length as opposed to the
  143.                limitation of 8 under DOS.
  144.  
  145.              - There must be NO imbedded spaces or blanks.
  146.  
  147.              - Magnum will accept up to 30 characters for the name,
  148.                including the \PIPE\ part.
  149.  
  150.          For most LAN systems, the priority class and levels should also
  151.          be changed. We've had the best experience with priority class 2,
  152.          priority level 5.
  153.  
  154.       4) Save your changes and "re-compile" with:
  155.  
  156.              MAKEMBBS x
  157.  
  158.          where 'x' is the node number.
  159.  
  160.       5) Repeat the above steps for each node you wish to convert to
  161.          a "pipe", giving each node a unique pipe name for the DEVICENAME
  162.          parameter.
  163.  
  164.       6) ReStart your BBS (or ACTIVATE the nodes you deactivated).
  165.  
  166.    Note that the MBBS.EXE display screen will read ACTIVE PORT for modem
  167.    nodes or ACTIVE PIPE for pipe nodes.
  168.  
  169.                        ==============================
  170.                        Logging on Via the Pipe Module
  171.                        ==============================
  172.  
  173.    Logging on from an OS/2 workstation or a DOS workstation is identical
  174.    except for the name of the program (MAGPIPE2.EXE for OS/2 or MAGPIPE.EXE
  175.    for DOS). We'll assume OS/2 workstations in the remainder of this
  176.    document.
  177.  
  178.    To log on via the pipe module, the user at the remote workstation needs
  179.    to know two things:
  180.  
  181.        1) The name of the Server that Magnum is running on.
  182.        2) The name of the Pipe for the node s/he wants to log on to.
  183.  
  184.    This can be paralleled to a modem user - they have to know 2 things as
  185.    well: AreaCode and Telephone Number.
  186.  
  187.    Once these two things are known, the remote workstation is ready for
  188.    logon. Assuming the Sever Name is MAGSRVR and the Pipe Name is
  189.    \PIPE\MAGNODE3, the user would log on as follows:
  190.  
  191.          MAGPIPE2  \\MAGSRVR\PIPE\MAGNODE3
  192.  
  193.    Note the syntax of the pipe name. It's identical to that of the pipe
  194.    name specified in the DEVICENAME statement for that node, except that
  195.    it's ALWAYS preceded with two backslashes (\\) and the server name.
  196.  
  197.    Just for informational purposes, you can log on to your BBS via pipe
  198.    module from the same physical machine that the BBS is running on
  199.    (no network) by eliminating the \\SERVERNAME part of the name:
  200.    (ie: MAGPIPE2 \PIPE\MAGNODE3).
  201.  
  202.    In a moment, you'll see the exact same thing you'd see as though you'd
  203.    dialed up via modem. Everything from this point on is self-explanatory.
  204.  
  205.                                  =========
  206.                                  File Xfer
  207.                                  =========
  208.  
  209.    The file transfers work differently for pipes than they do for modems.
  210.    Although the interface is the same [choose a protocol, name your file(s),
  211.    and start your download/upload], the actual file transfer protocol is
  212.    a proprietary error-correcting "pipe xfer protocol" that both Magnum and
  213.    the Pipe Module understand. You'll notice that downloads also prompt for
  214.    the target filename for your workstation, and uploads prompt for the
  215.    source filename for your workstation. So even though you've chosen one
  216.    of the 6 modem protocols (xmodem, xmodem-crc, xmodem-1k, ymodem, ymodem-g
  217.    or zmodem), that's as far as it goes - those protocols are never
  218.    activated, but internally replaced with the pipe xfer protocol). You can
  219.    still choose a batch protocol such as Ymodem to download with, but you'll
  220.    be prompted for a target filename for your workstation prior to each file
  221.    sent.
  222.  
  223.                                    ======
  224.                                    Ctrl-C
  225.                                    ======
  226.  
  227.    Note that <Ctrl-C> is NOT trapped in these versions of the Pipe Modules.
  228.    You can accidentally (or intentionally) press <Ctrl-C> and the program
  229.    will terminate (Magnum will treat this the same way it treats a dropped
  230.    carrier and will reset the node). Be careful not to accidentally hit
  231.    <Ctrl-C> when using the ANSI message editor.
  232.  
  233.            =====================================================
  234.            Simulating a "Rotary" or "Hunt Group" with Pipe Nodes
  235.            =====================================================
  236.  
  237.    Many multi-node dial-up BBS's have one main telephone (modem) number
  238.    which, if busy when called, is automatically routed to the first
  239.    available free line (if available). This is known as a "Rotary" or
  240.    "Hunt Group" and is performed at the telephone company.
  241.  
  242.    You can simulate this with .CMD files for OS/2 or .BAT files for DOS.
  243.    MAGPIPE2 and MAGPIPE were designed with this in mind. If a connection
  244.    is made to a node, then when the program ends (regardless of the reason
  245.    for termination), it will end with the errorlevel of 0. However, if a
  246.    connection is not made, it will end with the errorlevel of 1.
  247.  
  248.    To demonstrate this via example, lets suppose you're using the 9-node
  249.    version of Magnum with Nodes 1, 2, and 3 set up as modem lines. Nodes
  250.    4 thru 8 are Pipe nodes with names of \pipe\magnode4 thru \pipe\magnode8.
  251.    Assume Magnum is running on a server known as \\magsrvr. The following
  252.    .CMD file would connect you to the first available node:
  253.  
  254.      magpipe2 \\magsrvr\pipe\magnode4
  255.      if errorlevel 1 goto try5
  256.      goto done
  257.      :try5
  258.      magpipe2 \\magsrvr\pipe\magnode5
  259.      if errorlevel 1 goto try6
  260.      goto done
  261.      :try6
  262.      magpipe2 \\magsrvr\pipe\magnode6
  263.      if errorlevel 1 goto try7
  264.      goto done
  265.      :try7
  266.      magpipe2 \\magsrvr\pipe\magnode7
  267.      if errorlevel 1 goto try8
  268.      goto done
  269.      :try8
  270.      magpipe2 \\magsrvr\pipe\magnode8
  271.      if errorlevel 1 goto allbusy
  272.      goto done
  273.      :allbusy
  274.      echo All Nodes Busy or BBS is Down. Try again later...
  275.      :done
  276.  
  277.    If you were to name the above .CMD file MP.CMD, then all the user would
  278.    have to do to log onto the first available node would be to run MP.
  279.    Note that the equivalent DOS .BAT file would be identical except that
  280.    the program name would be magpipe instead of magpipe2.
  281.  
  282. End.
  283.