(file) Return to ModuleController.h CVS log (file) (dir) Up to [Pegasus] / pegasus / src / Pegasus / Common

Diff for /pegasus/src/Pegasus/Common/ModuleController.h between version 1.7 and 1.34.2.2

version 1.7, 2002/03/22 19:51:37 version 1.34.2.2, 2002/10/28 15:43:24
Line 1 
Line 1 
 //%////-*-c++-*-////////////////////////////////////////////////////////////////  //%///////////-*-c++-*-/////////////////////////////////////////////////////////
 // //
 // Copyright (c) 2000, 2001 The Open group, BMC Software, Tivoli Systems, IBM  // Copyright (c) 2000, 2001, 2002 BMC Software, Hewlett-Packard Company, IBM,
   // The Open Group, Tivoli Systems
 // //
 // Permission is hereby granted, free of charge, to any person obtaining a copy // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to // of this software and associated documentation files (the "Software"), to
Line 30 
Line 31 
 #define Pegasus_Module_Controller_h #define Pegasus_Module_Controller_h
  
 #include <Pegasus/Common/Config.h> #include <Pegasus/Common/Config.h>
   #include <Pegasus/Common/Constants.h>
 #include <Pegasus/Common/Message.h> #include <Pegasus/Common/Message.h>
 #include <Pegasus/Common/Exception.h> #include <Pegasus/Common/Exception.h>
 #include <Pegasus/Common/IPC.h> #include <Pegasus/Common/IPC.h>
Line 38 
Line 40 
 #include <Pegasus/Common/Cimom.h> #include <Pegasus/Common/Cimom.h>
 #include <Pegasus/Common/CimomMessage.h> #include <Pegasus/Common/CimomMessage.h>
 #include <Pegasus/Common/MessageQueueService.h> #include <Pegasus/Common/MessageQueueService.h>
   #include <Pegasus/Common/peg_authorization.h>
   #include <Pegasus/Common/Linkage.h>
   
   
 PEGASUS_NAMESPACE_BEGIN PEGASUS_NAMESPACE_BEGIN
  
 class ModuleController; class ModuleController;
  
       class PEGASUS_COMMON_LINKAGE module_rep  
   class PEGASUS_COMMON_LINKAGE pegasus_module
   {
      private:
         class module_rep : public pegasus_auth_handle
       {       {
          public:          public:
               typedef pegasus_auth_handle Base;
   
             module_rep(ModuleController *controller,             module_rep(ModuleController *controller,
                        const String & name,                        const String & name,
                        void *module_address,                        void *module_address,
                        Message * (*receive_message)(Message *),                         Message * (*receive_message)(Message *, void *),
                        void (*async_callback)(Uint32, Message *),                         void (*async_callback)(Uint32, Message *, void *),
                        void (*shutdown_notify)(Uint32 code))                         void (*shutdown_notify)(Uint32 code, void *));
                : _thread_safety(),  
                  _controller(controller),  
                  _name(name),  
                  _reference_count(1),  
                  _shutting_down(0),  
                  _module_address(module_address)  
   
             {  
                if(receive_message != NULL)  
                   _receive_message = receive_message;  
                else  
                   _receive_message = default_receive_message;  
                if(async_callback != NULL)  
                   _async_callback = async_callback;  
                else  
                   _async_callback = default_async_callback;  
                if(shutdown_notify != NULL)  
                   _shutdown_notify = shutdown_notify;  
                else  
                   _shutdown_notify = default_shutdown_notify;  
             }  
   
             ~module_rep(void)  
             {  
  
             }              ~module_rep(void) ;
  
             Boolean operator == (const module_rep *rep) const             Boolean operator == (const module_rep *rep) const
             {              { if (rep == this ) return true; return false; }
                if (rep == this )  
                   return true;  
                return false;  
             }  
  
             Boolean operator == (const module_rep &rep) const             Boolean operator == (const module_rep &rep) const
             {              { if (rep == *this) return true; return false; }
                if (rep == *this)  
                   return true;  
                return false;  
             }  
  
             Boolean operator == (void *rep) const             Boolean operator == (void *rep) const
             {              { if ( (void *)this == rep ) return true; return false; }
                if ( (void *)this == rep )  
                   return true;  
                return false;  
             }  
  
             void reference(void) { _reference_count++; }             void reference(void) { _reference_count++; }
             void dereference(void) { _reference_count--; }             void dereference(void) { _reference_count--; }
             Uint32 reference_count(void)  { return _reference_count.value(); }             Uint32 reference_count(void)  { return _reference_count.value(); }
             const String & get_name(void) const { return _name; }             const String & get_name(void) const { return _name; }
             void *get_module_address(void) const { return _module_address; }             void *get_module_address(void) const { return _module_address; }
             Message * module_receive_message(Message *msg)  
             {  
                Message * ret;  
                _thread_safety.lock(pegasus_thread_self());  
                try {  ret = _receive_message(msg); }  
                catch(...) { _thread_safety.unlock(); throw; }  
                _thread_safety.unlock();  
                return ret;  
             }  
  
             void _send_async_callback(Uint32 msg_handle, Message *msg)              Message * module_receive_message(Message *msg);
             {  
                _thread_safety.lock(pegasus_thread_self());  
                try  { _async_callback(msg_handle, msg); }  
                catch(...) { _thread_safety.unlock(); throw; }  
  
             }              void _send_async_callback(Uint32 msg_handle, Message *msg, void *parm);
             void _send_shutdown_notify(Uint32 code)  
             {  
                _thread_safety.lock(pegasus_thread_self());  
                if( _shutting_down == 0 )  
                {  
                   _shutting_down++;  
                   _shutdown_notify(code);  
                }  
                _thread_safety.unlock();  
             }  
             void lock(void)  
             {  
                _thread_safety.lock(pegasus_thread_self());  
             }  
  
             void unlock(void)              void _send_shutdown_notify(void);
             {              void lock(void) { _thread_safety.lock(pegasus_thread_self()); }
                _thread_safety.unlock();              void unlock(void) { _thread_safety.unlock(); }
             }  
               Boolean authorized(void) ;
               Boolean authorized(Uint32);
               Boolean authorized(Uint32, Uint32);
  
          private:          private:
             module_rep(void);             module_rep(void);
             module_rep(const module_rep & );             module_rep(const module_rep & );
             module_rep& operator= (const module_rep & );              module_rep & operator= (const module_rep & rep);
   
  
             Mutex _thread_safety;             Mutex _thread_safety;
             ModuleController *_controller;             ModuleController *_controller;
             String _name;             String _name;
             AtomicInt _reference_count;             AtomicInt _reference_count;
             Uint32 _shutting_down;              AtomicInt _shutting_down;
  
             void *_module_address;             void *_module_address;
             Message * (*_receive_message)(Message *);              Message * (*_receive_message)(Message *, void *);
             void (*_async_callback)(Uint32, Message *);              void (*_async_callback)(Uint32, Message *, void *);
             void (*_shutdown_notify)(Uint32 code);              void (*_shutdown_notify)(Uint32 code, void *);
  
             static Message * default_receive_message(Message *msg)              static Message * default_receive_message(Message *msg, void *inst)
             {              { throw NotImplemented("Module Receive"); return 0; }
                throw NotImplemented("Module Receive");  
             }  
  
             static void default_async_callback(Uint32 handle, Message *msg)              static void default_async_callback(Uint32 handle, Message *msg, void *inst)
             {              { throw NotImplemented("Module Async Receive"); }
                throw NotImplemented("Module Async Receive");  
             }  
  
             static void default_shutdown_notify(Uint32 code)              static void default_shutdown_notify(Uint32 code, void *inst)
             {              { return; }
                return;  
             }  
  
             friend class ModuleController;              static Message * closed_receive_message(Message *msg, void *inst)
       };              { throw ModuleClosed(); return 0; }
  
               static void closed_async_callback(Uint32 handle, Message *msg, void *inst)
               { throw ModuleClosed(); }
  
 class PEGASUS_COMMON_LINKAGE pegasus_module              friend class ModuleController;
 {        };
  
    public:    public:
   
       pegasus_module(ModuleController *controller,       pegasus_module(ModuleController *controller,
                      const String &id,                      const String &id,
                      void *module_address,                      void *module_address,
                      Message * (*receive_message)(Message *),                       Message * (*receive_message)(Message *, void *),
                      void (*async_callback)(Uint32, Message *),                       void (*async_callback)(Uint32, Message *, void *),
                      void (*shutdown_notify)(Uint32 code)) ;                       void (*shutdown_notify)(Uint32 code, void *)) ;
   
       ~pegasus_module(void)  
       {  
          _rep->dereference();  
          if( 0 == _rep->reference_count())  
             delete _rep;  
       }  
  
         pegasus_module(const pegasus_module & mod);
       pegasus_module & operator= (const pegasus_module & mod);       pegasus_module & operator= (const pegasus_module & mod);
       Boolean operator == (const pegasus_module *mod) const;  
         virtual ~pegasus_module(void);
   
         virtual Boolean authorized(Uint32 operation);
         virtual Boolean authorized(void);
   
       Boolean operator == (const pegasus_module & mod) const ;       Boolean operator == (const pegasus_module & mod) const ;
       Boolean operator == (const String &  mod) const;       Boolean operator == (const String &  mod) const;
       Boolean operator == (const void *mod) const;       Boolean operator == (const void *mod) const;
Line 206 
Line 153 
       // introspection interface       // introspection interface
       Boolean query_interface(const String & class_id, void **object_ptr) const;       Boolean query_interface(const String & class_id, void **object_ptr) const;
  
   
    private:    private:
  
       module_rep *_rep;       module_rep *_rep;
       pegasus_module(void);  
       pegasus_module(const pegasus_module & mod);        pegasus_module(void)
         {
         }
   
       Boolean _rcv_msg(Message *) ;       Boolean _rcv_msg(Message *) ;
       Message * _receive_message(Message *msg)        Message * _receive_message(Message *msg);
         void _send_async_callback(Uint32 msg_handle, Message *msg, void *) ;
         void _send_shutdown_notify(void);
         Boolean _shutdown(void);
         PEGASUS_STD(bitset<32>) _allowed_operations;
   
         void reference(void) { _rep->reference(); }
         void dereference(void)  { _rep->dereference(); }
         friend class ModuleController;
   };
   
   
   class PEGASUS_COMMON_LINKAGE ModuleController : public MessageQueueService
   {
   
   
      public:
         typedef MessageQueueService Base;
   
         static const Uint32 GET_CLIENT_HANDLE;
         static const Uint32 REGISTER_MODULE;
         static const Uint32 DEREGISTER_MODULE;
         static const Uint32 FIND_SERVICE;
         static const Uint32 FIND_MODULE_IN_SERVICE;
         static const Uint32 GET_MODULE_REFERENCE;
         static const Uint32 MODULE_SEND_WAIT;
         static const Uint32 MODULE_SEND_WAIT_MODULE;
         static const Uint32 MODULE_SEND_ASYNC;
         static const Uint32 MODULE_SEND_ASYNC_MODULE;
         static const Uint32 BLOCKING_THREAD_EXEC;
         static const Uint32 ASYNC_THREAD_EXEC;
         static const Uint32 CLIENT_SEND_WAIT;
         static const Uint32 CLIENT_SEND_WAIT_MODULE;
         static const Uint32 CLIENT_SEND_ASYNC;
         static const Uint32 CLIENT_SEND_ASYNC_MODULE;
         static const Uint32 CLIENT_BLOCKING_THREAD_EXEC;
         static const Uint32 CLIENT_ASYNC_THREAD_EXEC;
         static const Uint32 CLIENT_SEND_FORGET;
         static const Uint32 CLIENT_SEND_FORGET_MODULE;
         static const Uint32 MODULE_SEND_FORGET;
         static const Uint32 MODULE_SEND_FORGET_MODULE;
   
   // ATTN-DME-P2-20020406 Removed private declaration.  client_handle is
   //          currently used in Pegasus/Provider/CIMOMHandle.cpp
   
   //   private:
         class client_handle : public pegasus_auth_handle
         {
            public:
               typedef pegasus_auth_handle Base;
   
               client_handle(const pegasus_identity & id)
                  :Base(id) ,
                   allowed_operations( GET_CLIENT_HANDLE |
                                       FIND_SERVICE |
                                       FIND_MODULE_IN_SERVICE |
                                       GET_MODULE_REFERENCE |
                                       CLIENT_SEND_WAIT |
                                       CLIENT_SEND_WAIT_MODULE |
                                       CLIENT_SEND_ASYNC |
                                       CLIENT_SEND_ASYNC_MODULE |
                                       CLIENT_BLOCKING_THREAD_EXEC |
                                       CLIENT_ASYNC_THREAD_EXEC),
                   reference_count(1)
       {       {
          return _rep->module_receive_message(msg);  
       }       }
  
       void _send_async_callback(Uint32 msg_handle, Message *msg)              ~client_handle(void)
       {       {
          _rep->_send_async_callback(msg_handle, msg);  
       }       }
       void _send_shutdown_notify(Uint32 code)  
               client_handle & operator=(const client_handle & handle)
       {       {
          _rep->_send_shutdown_notify(code);                 if(this == &handle)
                     return *this;
                  reference_count++;
                  return *this;
       }       }
  
       Boolean _shutdown(Uint32 code) { _send_shutdown_notify(code); return true; }  
  
       void reference(void) { _rep->reference(); }              virtual Boolean authorized(Uint32, Uint32);
       void dereference(void)  { _rep->dereference(); }              virtual Boolean authorized(Uint32 operation);
               virtual Boolean authorized(void);
               PEGASUS_STD(bitset<32>) allowed_operations;
               AtomicInt reference_count;
  
       friend class ModuleController;  
 }; };
  
         class callback_handle
         {
            public:
               static void * operator new(size_t );
               static void operator delete(void *, size_t);
            private:
               static callback_handle *_head;
               static const int BLOCK_SIZE;
               static Mutex _alloc_mut;
   
            public:
               callback_handle(pegasus_module * module, void *parm)
                  : _module(module), _parm(parm)
               {
               }
  
 class PEGASUS_COMMON_LINKAGE ModuleController : public MessageQueueService              ~callback_handle()
 { {
                  if( _module->get_name() == String(PEGASUS_MODULENAME_TEMP) )
                     delete _module;
               }
   
               pegasus_module * _module;
               void *_parm;
         };
   
  
    public:    public:
       typedef MessageQueueService Base;  
  
       ModuleController(const char *name);       ModuleController(const char *name);
       ModuleController(const char *name,  /*       ModuleController(const char *name,  */
                        Sint16 min_threads,  /*                     Sint16 min_threads,  */
                        Sint16 max_threads,  /*                     Sint16 max_threads, */
                        struct timeval & create_thread,  /*                     struct timeval & create_thread, */
                        struct timeval & destroy_thread,  /*                     struct timeval & destroy_thread, */
                        struct timeval & deadlock);  /*                     struct timeval & deadlock); */
  
  
       ~ModuleController(void);       ~ModuleController(void);
  
   
   
   
       // module api       // module api
       ModuleController & register_module(const String & module_name,        static ModuleController & register_module(const String & controller_name,
                                                   const String & module_name,
                                          void *module_address,                                          void *module_address,
                                          Message * (*receive_message)(Message *),                                                  Message * (*receive_message)(Message *, void *),
                                          void (*async_callback)(Uint32, Message *),                                                  void (*async_callback)(Uint32, Message *, void *),
                                          void (*shutdown_notify)(Uint32)) throw(AlreadyExists);                                                  void (*shutdown_notify)(Uint32, void *),
                                                   pegasus_module **instance = NULL)
  
       Boolean deregister_module(const String & module_name);           throw(AlreadyExists, IncompatibleTypes);
  
       Uint32 find_service(pegasus_module & handle, const String & name) throw(Permission);        Boolean deregister_module(const String & module_name)
            throw(Permission);
   
         Uint32 find_service(const pegasus_module & handle, const String & name) throw(Permission);
  
       Uint32 find_module_in_service(pegasus_module & handle,        Uint32 find_module_in_service(const pegasus_module & handle,
                                     const String & module_name)                                     const String & module_name)
          throw(Permission, IPCException);          throw(Permission, IPCException);
  
  
       pegasus_module * get_module_reference(pegasus_module & my_handle,        pegasus_module * get_module_reference(const pegasus_module & my_handle,
                                             const String & module_name)                                             const String & module_name)
          throw(Permission);          throw(Permission);
  
       // send a message to another service       // send a message to another service
       AsyncReply *ModuleSendWait(pegasus_module & handle,        AsyncReply *ModuleSendWait(const pegasus_module & handle,
                               Uint32 destination_q,                               Uint32 destination_q,
                               AsyncRequest *request) throw(Permission, IPCException);                               AsyncRequest *request) throw(Permission, IPCException);
  
       // send a message to another module via another service       // send a message to another module via another service
       AsyncReply *ModuleSendWait(pegasus_module & handle,        AsyncReply *ModuleSendWait(const pegasus_module & handle,
                               Uint32 destination_q,                               Uint32 destination_q,
                               String & destination_module,                                   const String & destination_module,
                               AsyncRequest *message) throw(Permission, Deadlock, IPCException);                               AsyncRequest *message) throw(Permission, Deadlock, IPCException);
  
       // send a message to another service        // send an async message to another service
       Boolean ModuleSendAsync(pegasus_module & handle,        Boolean ModuleSendAsync(const pegasus_module & handle,
                               Uint32 msg_handle,                               Uint32 msg_handle,
                               Uint32 destination_q,                               Uint32 destination_q,
                               AsyncMessage *message) throw(Permission, IPCException);                                AsyncRequest *message,
                                 void *callback_parm) throw(Permission, IPCException);
  
       // send a message to another module via another service        // send an async message to another module via another service
       Boolean ModuleSendAsync(pegasus_module & handle,        Boolean ModuleSendAsync(const pegasus_module & handle,
                               Uint32 msg_handle,                               Uint32 msg_handle,
                               Uint32 destination_q,                               Uint32 destination_q,
                               String & destination_module,                                const String & destination_module,
                               AsyncMessage *message) throw(Permission, IPCException);                                AsyncRequest *message,
                                 void *callback_parm) throw(Permission, IPCException);
   
         Boolean ModuleSendForget(const pegasus_module & handle,
                                  Uint32 destination_q,
                                  AsyncRequest *message)
            throw(Permission, IPCException);
  
       void blocking_thread_exec(pegasus_module & handle,        Boolean ModuleSendForget(const pegasus_module & handle,
                                  Uint32 destination_q,
                                  const String & destination_module,
                                  AsyncRequest *message)
            throw(Permission, IPCException);
   
         void blocking_thread_exec(const pegasus_module & handle,
                                 PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *thread_func)(void *),                                 PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *thread_func)(void *),
                                 void *parm) throw(Permission, Deadlock, IPCException);                                 void *parm) throw(Permission, Deadlock, IPCException);
       void async_thread_exec(pegasus_module & handle,        void async_thread_exec(const pegasus_module & handle,
                              PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *thread_func)(void *),                              PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *thread_func)(void *),
                              void *parm) throw(Permission, Deadlock, IPCException);                              void *parm) throw(Permission, Deadlock, IPCException);
   
       Boolean verify_handle(pegasus_module *);       Boolean verify_handle(pegasus_module *);
    protected:  
  
    private:        static ModuleController & get_client_handle(const pegasus_identity & id,
                                                     client_handle **handle)
            throw(IncompatibleTypes);
  
         static ModuleController & get_client_handle(const char *controller,
                                                     const pegasus_identity & id,
                                                     client_handle **handle)
            throw(IncompatibleTypes);
  
       static void _async_handleEnqueue(AsyncOpNode *h, MessageQueue *q, void *parm);  
  
         void return_client_handle(client_handle *handle);
   
         // send a message to another service
         AsyncReply *ClientSendWait(const client_handle & handle,
                                    Uint32 destination_q,
                                    AsyncRequest *request)
            throw(Permission, IPCException);
   
         // send a message to another module via another service
         AsyncReply *ClientSendWait(const client_handle & handle,
                                    Uint32 destination_q,
                                    String & destination_module,
                                    AsyncRequest *message)
            throw(Permission, Deadlock, IPCException);
   
         // send an async message to another service
         Boolean ClientSendAsync(const client_handle & handle,
                                 Uint32 msg_handle,
                                 Uint32 destination_q,
                                 AsyncRequest *message,
                                 void (*async_callback)(Uint32, Message *, void *) ,
                                 void *callback_parm)
            throw(Permission, IPCException);
   
         // send an async message to another module via another service
         Boolean ClientSendAsync(const client_handle & handle,
                                 Uint32 msg_handle,
                                 Uint32 destination_q,
                                 const String & destination_module,
                                 AsyncRequest *message,
                                 void (*async_callback)(Uint32, Message *, void *),
                                 void *callback_parm )
            throw(Permission, IPCException);
   
         Boolean ClientSendForget(const client_handle & handle,
                                  Uint32 destination_q,
                                  AsyncRequest *message)
            throw(Permission, IPCException);
   
         Boolean ClientSendForget(const client_handle & handle,
                                  Uint32 destination_q,
                                  const String & destination_module,
                                  AsyncRequest *message)
            throw(Permission, IPCException);
   
         void client_blocking_thread_exec(const client_handle & handle,
                                          PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *thread_func)(void *),
                                          void *parm)
            throw(Permission, Deadlock, IPCException);
         void client_async_thread_exec(const client_handle & handle,
                                       PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *thread_func)(void *),
                                       void *parm)
            throw(Permission, Deadlock, IPCException);
   
      protected:
         // ATTN-RK-P2-20010322:  These methods are pure virtual in superclass
         virtual void handleEnqueue(void) {}
         virtual void handleEnqueue(Message *) {}
         virtual void _handle_async_request(AsyncRequest *rq);
         virtual void _handle_async_callback(AsyncOpNode *op);
   
      private:
         static void _async_handleEnqueue(AsyncOpNode *h, MessageQueue *q, void *parm);
       DQueue<pegasus_module> _modules;       DQueue<pegasus_module> _modules;
       ThreadPool _thread_pool;        pegasus_module _internal_module;
         AsyncReply *_send_wait(Uint32, AsyncRequest *);
         AsyncReply *_send_wait(Uint32, const String &, AsyncRequest *);
         Boolean _send_forget(Uint32, AsyncRequest *) throw(IPCException);
         Boolean _send_forget(Uint32, const String &, AsyncRequest *) throw(IPCException);
   
         void _blocking_thread_exec(
            PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *thread_func)(void *),
            void *parm) ;
         void _async_thread_exec(
            PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *thread_func)(void *),
            void *parm) ;
 }; };
  
  

Legend:
Removed from v.1.7  
changed lines
  Added in v.1.34.2.2
No CVS admin address has been configured
 Powered by
ViewCVS 0.9.2