home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / perl502b.zip / ext / DPI / DOC / README < prev    next >
Internet Message Format  |  1994-02-17  |  6KB
  1. Date: Wednesday 16 February 1994, 12:09:09 CET
  2. From: "Bert Wijnen" <wijnen@vnet.ibm.com>
  3. To:   SNMP DPI developers
  4. Subject: DPI version 2.0 - Freely Available SNMP DPI 2.0 API
  5. Version: 0.01
  6.  
  7. /*********************************************************************/
  8. /*                                                                   */
  9. /* Copyright    - (C) International Business Machines Corp. 1994     */
  10. /*                                                                   */
  11. /*   Permission to use, copy, modify, and distribute this software   */
  12. /*   and its documentation for any lawful purpose and without fee is */
  13. /*   hereby granted, provided that this notice be retained unaltered,*/
  14. /*   and that the names of IBM and all other contributors shall not  */
  15. /*   be used in advertising or publicity pertaining to distribution  */
  16. /*   of the software without specific written prior permission.      */
  17. /*   No contributor makes any representations about the suitability  */
  18. /*   of this software for any purpose.  It is provided "as is"       */
  19. /*   without express or implied warranty.                            */
  20. /*                                                                   */
  21. /*   IBM AND ALL OTHER CONTRIBUTORS DISCLAIM ALL WARRANTIES WITH     */
  22. /*   REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF    */
  23. /*   MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, TITLE,    */
  24. /*   AND NON-INFRINGEMENT.                                           */
  25. /*                                                                   */
  26. /*   IN NO EVENT SHALL IBM OR ANY OTHER CONTRIBUTOR BE LIABLE FOR    */
  27. /*   ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES, WHETHER IN      */
  28. /*   CONTRACT, TORT, OR OTHER FORM OF ACTION, ARISING OUT OF OR IN   */
  29. /*   CONNECTION WITH, THE USE OR PERFORMANCE OF THIS SOFTWARE.       */
  30. /*                                                                   */
  31. /*********************************************************************/
  32.  
  33.    This directory contains a developers toolkit for DPI sub-agent
  34.    developers and or prgrammers who want to include the DPI 2.0
  35.    protocol in their SNMP agent.
  36.  
  37.    You have the choice to obtain a regular tar file or a compressed
  38.    tar file. The files (at software.watson.ibm.com) are:
  39.  
  40.           README          - this file
  41.           dpi20api.tar    - plain tar file
  42.           dpi20api.tar.Z  - compressed tar file
  43.     
  44.    I have compiled the code with the following compilers:
  45.  
  46.           IBM C-Set++ compiler on OS/2 2.1
  47.           IBM XL C compiler on AIX 3.2
  48.           Metaware High C compiler on AIX/ESA V2 R2
  49.  
  50.    To install, you must FTP the (compressed) tar file to from the
  51.    server (software.watson.ibm.com - /pub/dpi) and untar the files
  52.    into a directory.
  53.  
  54.        ftp obtain the dpi20api.tar file from software.watson.com
  55.        mkdir dpi20api  
  56.        cd    dpi20api
  57.        tar -xvf ../dpi20api.tar
  58.  
  59.    The following files should now be in the dpi20api directory:
  60.  
  61.    dpi20rfc.txt    - The draft DPI version 2.0 RFC as it is being
  62.                      submitted for publication.
  63.    dpi20ref.txt    - The DPI version 2.0 Programmers Reference in
  64.                      ASCII format (same page layout as RFC)
  65.    snmp_mDPI.c     - The base code that encodes/decodes DPI packets
  66.                      system independent
  67.    snmp_qDPI.c     - The system independent code for query_DPI_port
  68.    snmp_lDPI.c     - The somewhat system dependent code for transport
  69.                      related DPI API functions. You may need to adapt
  70.                      this file to your needs.
  71.    snmp_lDPI.h     - Include file used within the above 3 snmp_.DPI.c
  72.                      files. It is not needed by the DPI sub-agent 
  73.                      programmer.
  74.    dpi_version.h   - DPI version include file
  75.    snmp_dpi.h      - The DPI version 2.0 include file.
  76.                      This is the file that exposes the SNMP DPI API.
  77.    snmp_dpi1.h     - The DPI version 1.1 compatibility include file
  78.                      Will be included by snmp_dpi.h file if the
  79.                      programmers asks for 1.1 compatibilty.
  80.    Makefile        - Makefile to build the dpisample sub-agent
  81.                      (this is the AIX 3.2 sample, should work on most
  82.                      systems or need very little change).
  83.    Make.aix32        Makefile for AIX 3.2 system
  84.    Make.os21         Makefile for OS/2 2.1 system
  85.    dpi_sample.c    - A simple sample DPI 2.0 sub-agent.
  86.                      An explanation of the code is included in 
  87.                      the DPI 2.0 Programmers Reference.
  88.    dpiSimple.mib   - The dpiSimpleMib as implemented by the
  89.                      dpi_sample.c program.
  90.    README          - This readme file.
  91.  
  92.    To generate the dpisample sub-agent, issue:
  93.        make 
  94.    Then to run it issue:
  95.        dpisample
  96.    Or if you want to see trace info:
  97.        dpisample -d 2
  98.    Now.. it tries to obtain the dpiPort from the agent at the so
  99.    called "localhost". Your agent may not have DPI support yet, so
  100.    you will not see much happen. For instance, you may not have 
  101.    "localhost" defined, in which case you may need to change the
  102.    dpi_sample.c file. If you do have a "localhost", and an SNMP
  103.    agent is active, then you may see a timeout message if it does
  104.    not have DPI support. So then, the next step is to implement a
  105.    DPI capable SNMP agent or find one that you can use.
  106.    See the dpi20ref.txt file (DPI Programmers Reference) for more
  107.    information.
  108.  
  109.    Your comments will be appreciated. If you need to make any fixes
  110.    to the code, please inform the author also.
  111.  
  112.    Notes:
  113.    1.The mkDPIbulk function has not yet been implemented.
  114.    2.There is a SNMPDPI mailing list. You can send you email to:
  115.  
  116.           snmpdpi@watson.ibm.com
  117.  
  118.    3.To subscribe/unsubscribe send e-mail with the subject line
  119.      containing SUBSCRIBE (or UNSUBSCRIBE) to:
  120.  
  121.           snmpdpi-request@watson.ibm.com
  122.  
  123.    4.You can also contact the author directly at the e-mail address
  124.      listed below.
  125.  
  126. Bert Wijnen
  127. IBM VNET:  wijnen at uitvm1
  128. Internet:  wijnen@vnet.ibm.com
  129.