home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / fnb101.zip / Lib / site-packages / Fnorb / orb / GIOPClientWorker.py < prev    next >
Text File  |  1999-06-28  |  6KB  |  212 lines
  1. #!/usr/bin/env python
  2. #############################################################################
  3. # Copyright (C) DSTC Pty Ltd (ACN 052 372 577) 1997, 1998, 1999
  4. # All Rights Reserved.
  5. #
  6. # The software contained on this media is the property of the DSTC Pty
  7. # Ltd.  Use of this software is strictly in accordance with the
  8. # license agreement in the accompanying LICENSE.HTML file.  If your
  9. # distribution of this software does not contain a LICENSE.HTML file
  10. # then you have no rights to use this software in any manner and
  11. # should contact DSTC at the address below to determine an appropriate
  12. # licensing arrangement.
  13. # 
  14. #      DSTC Pty Ltd
  15. #      Level 7, GP South
  16. #      Staff House Road
  17. #      University of Queensland
  18. #      St Lucia, 4072
  19. #      Australia
  20. #      Tel: +61 7 3365 4310
  21. #      Fax: +61 7 3365 4311
  22. #      Email: enquiries@dstc.edu.au
  23. # 
  24. # This software is being provided "AS IS" without warranty of any
  25. # kind.  In no event shall DSTC Pty Ltd be liable for damage of any
  26. # kind arising out of or in connection with the use or performance of
  27. # this software.
  28. #
  29. # Project:      Fnorb
  30. # File:         $Source: /units/arch/src/Fnorb/orb/RCS/GIOPClientWorker.py,v $
  31. # Version:      @(#)$RCSfile: GIOPClientWorker.py,v $ $Revision: 1.4 $
  32. #
  33. #############################################################################
  34. """ GIOPClientWorker classes. """
  35.  
  36.  
  37. # Fnorb modules.
  38. import CORBA, GIOP, OctetStream, Util
  39.  
  40.  
  41. #############################################################################
  42. # GIOPClientWorker factory.
  43. #############################################################################
  44.  
  45. def GIOPClientWorkerFactory_init():
  46.     """ Return the GIOPClientWorker factory. 
  47.  
  48.     This is a factory function for the GIOPClientWorkerFactory class
  49.     (the GIOPClientWorker factory is a singleton (ie. there can only be one
  50.     instance per process)).
  51.  
  52.     """
  53.     try:
  54.     factory = GIOPClientWorkerFactory()
  55.  
  56.     except GIOPClientWorkerFactory, factory:
  57.     pass
  58.  
  59.     return factory
  60.  
  61.  
  62. class GIOPClientWorkerFactory:
  63.     """ Factory for GIOPClientWorker instances. 
  64.  
  65.     The factory is a singleton (ie. there can only be one instance per
  66.     process).
  67.  
  68.     """
  69.     __instance = None
  70.  
  71.     def __init__(self):
  72.     """ Constructor. """
  73.  
  74.     # The factory is a singleton (ie. there can only be one instance per
  75.     # process).
  76.     if GIOPClientWorkerFactory.__instance is not None:
  77.         raise GIOPClientWorkerFactory.__instance
  78.  
  79.     GIOPClientWorkerFactory.__instance = self
  80.  
  81.     return
  82.  
  83.     #########################################################################
  84.     # GIOPClientWorkerFactory interface.
  85.     #########################################################################
  86.  
  87.     def create_worker(self, protocol, address):
  88.     """ Create a new GIOP client worker. """
  89.  
  90.     # Find out what threading-model we are using.
  91.     model = CORBA.ORB_init()._fnorb_threading_model()
  92.  
  93.     # Reactive.
  94.     if model == Util.REACTIVE:
  95.         from GIOPClientWorkerReactive import GIOPClientWorkerReactive
  96.         worker = GIOPClientWorkerReactive(protocol,    address)
  97.  
  98.     # Multi-threaded.
  99.         else:
  100.         from GIOPClientWorkerThreaded import GIOPClientWorkerThreaded
  101.         worker = GIOPClientWorkerThreaded(protocol, address)
  102.  
  103.     return worker
  104.  
  105.  
  106. class GIOPClientWorker:
  107.     """  Abstract base class for GIOPClient workers. """
  108.  
  109.     def send(self, request_id, message):
  110.     """ Send an operation request to the remote object. """
  111.  
  112.     pass
  113.  
  114.     def recv(self, request_id):
  115.     """ Wait for a specific reply. """
  116.  
  117.     pass
  118.  
  119.     def poll(self, request_id):
  120.     """ Poll for a reply to a specific request. """
  121.  
  122.     pass
  123.  
  124.     def peek(self, request_id):
  125.     """ Peek at the reply for the specified request.
  126.  
  127.     This method does *not* delete the reply from the client's queue.
  128.  
  129.     """
  130.     pass
  131.  
  132.     def delete_reply(self, request_id):
  133.     """ Delete the reply with the specified request id. """
  134.  
  135.     pass
  136.  
  137.     def next_request_id(self):
  138.     """ Return the next request id. """
  139.  
  140.     pass
  141.  
  142.     def is_closed(self):
  143.     """ Has the worker received a close event? """
  144.  
  145.     pass
  146.  
  147.     def close_connection(self):
  148.     """ Close down the connection. """
  149.  
  150.     pass
  151.  
  152.     #########################################################################
  153.     # Protected interface (this is purely for code re-use between the
  154.     # reactive and threaded workers).
  155.     #########################################################################
  156.  
  157.     def _message_received(self, message):
  158.     """ Called when a complete GIOP message has been received. """
  159.  
  160.     # Get a cursor for the message.
  161.     cursor = message.cursor()
  162.  
  163.     # Get the GIOP message header.
  164.     giop_header = message.header()
  165.  
  166.     # Make sure that the header has the right magic and that we are talking
  167.     # the same version of GIOP.
  168.     if giop_header.magic != Util.MAGIC \
  169.        or giop_header.GIOP_version.major != Util.GIOP_VERSION_MAJOR \
  170.        or giop_header.GIOP_version.minor != Util.GIOP_VERSION_MINOR:
  171.         # Send a 'MessageError' to the server.
  172.         self._message_error()
  173.         
  174.     # Handle each GIOP message type.
  175.     #
  176.     # Reply.
  177.     if giop_header.message_type == GIOP.Reply.value():
  178.         # Unmarshal the reply header.
  179.         tc = CORBA.typecode('IDL:omg.org/GIOP/ReplyHeader:1.0')
  180.         reply_header = tc._fnorb_unmarshal_value(cursor)
  181.  
  182.         # Reply received.
  183.         self._reply_received(reply_header, cursor)
  184.  
  185.     # CloseConnection.
  186.     elif giop_header.message_type == GIOP.CloseConnection.value():
  187.         self.close_connection()
  188.  
  189.     # MessageError.
  190.     elif giop_header.message_type == GIOP.MessageError.value():
  191.         raise CORBA.COMM_FAILURE() # System exception.
  192.  
  193.     # Some unknown message type.
  194.     else:
  195.         # Send a 'MessageError' to the server.
  196.         self._message_error()
  197.  
  198.     return
  199.  
  200.     def _message_error(self):
  201.     """ Send a 'MessageError' message to the remote object. """
  202.  
  203.     # Create the 'MessageError' message.
  204.     message = OctetStream.GIOPMessage(type=GIOP.MessageError)
  205.  
  206.     # Send it!
  207.     self.send(self.next_request_id(), message)
  208.  
  209.     return
  210.  
  211. #############################################################################
  212.