home *** CD-ROM | disk | FTP | other *** search
/ Meeting Pearls 3 / Meeting_Pearls_III.iso / Pearls / dev / AmigaE / ArisModules / MsgPort / msgport.readme < prev    next >
Text File  |  1995-06-22  |  2KB  |  78 lines
  1. FILENAME          : msgport.e
  2. DESTINATION DRIVER: EMODULES:oomodules/
  3. DESCRIPTION       : msgportclass for AmigaE 3.1a+
  4. CLASSNAME         : msgport
  5. METHODS           :
  6.  - create
  7.  
  8.    mp:=create(name=NIL:PTR TO LONG,pri=0) ;
  9.        [mp:=]msgport.create('TEST_PORT') ; [mp:=]msgport.create()
  10.  
  11.    Creats an Public Msg Port if name<>NIL with prioriti pri
  12.    if name=NIL then will be opened an private msg port like with CreateMsgPort()
  13.  
  14.  - delete
  15.  
  16.    delete() ; msgport.delete()
  17.  
  18.    Removes Port from Port List.
  19.  
  20.  - end
  21.  
  22.    end() ; END msgport
  23.  
  24.    *See <delete>*
  25.  
  26.  - sigbit
  27.  
  28.    port_signal:=msgport.sigbit()
  29.  
  30.    Givs sigbit from Public Port
  31.    this sigbit must be shifted to left for use usigbit:=Shl(1,msgport.sigbit())
  32.    (Not very usable with Private Ports)
  33.  
  34.  - sigbitA
  35.  
  36.    port_signal:=msgport.sigbitA()
  37.  
  38.    Givs sigbit Ready for Wait. Wait(msgport.sigbitA()) is valid.
  39.    Returned signal must not be Shifted to left !!
  40.  
  41.  - getmsg
  42.  
  43.    msg:=msgport.getmsg()
  44.  
  45.    Takes an incoming Msg from Port
  46.    Msg Must be replyed !!         
  47.  
  48.  - putmsg
  49.  
  50.    succes:=msgport.putmsg(port:PTR TO mp,m:PTR TO mn) ; msgport.putmsg('GOLDED.1',msg)
  51.  
  52.    Sends an Msg "m" to Port "port"
  53.  
  54.  - wait
  55.  
  56.    msgport.wait()
  57.  
  58.    Waits for msg on port.
  59.  
  60.  - putrxcmd
  61.  
  62.    rc,rs:=msgport.putrxcmd(type,cmd,port=NIL)
  63.  
  64.    Send an Arexx CMD String To an Arexx port port or To ARexx Interpreter
  65.    if port=NIL
  66.    type can be: CMD - only rc is given back rs=NIL
  67.                 FUNC - rc and rs are given back
  68.    Check for rc to see if is command failed.
  69.  
  70. This CLass Raises an Exception "mp" if somthing is wrong
  71. exceptioninfo can have this values :
  72.  
  73. (-1) - Port Could not be opened
  74. (-2) - There is an Port with Same Name avaliable
  75. (-3) - Rexx Msg Could not be created
  76. (-255) - There is no such Arexx Port
  77.  
  78.