version 1.48, 2006/07/25 19:11:15
|
version 1.58.8.1, 2011/10/11 18:18:08
|
|
|
//%2006//////////////////////////////////////////////////////////////////////// |
//%LICENSE//////////////////////////////////////////////////////////////// |
// | // |
// Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development |
// Licensed to The Open Group (TOG) under one or more contributor license |
// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems. |
// agreements. Refer to the OpenPegasusNOTICE.txt file distributed with |
// Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.; |
// this work for additional information regarding copyright ownership. |
// IBM Corp.; EMC Corporation, The Open Group. |
// Each contributor licenses this file to you under the OpenPegasus Open |
// Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.; |
// Source License; you may not use this file except in compliance with the |
// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group. |
// License. |
// Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
// |
// EMC Corporation; VERITAS Software Corporation; The Open Group. |
// Permission is hereby granted, free of charge, to any person obtaining a |
// Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
// copy of this software and associated documentation files (the "Software"), |
// EMC Corporation; Symantec Corporation; The Open Group. |
// to deal in the Software without restriction, including without limitation |
|
// the rights to use, copy, modify, merge, publish, distribute, sublicense, |
|
// and/or sell copies of the Software, and to permit persons to whom the |
|
// Software is furnished to do so, subject to the following conditions: |
|
// |
|
// The above copyright notice and this permission notice shall be included |
|
// in all copies or substantial portions of the Software. |
|
// |
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
|
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
|
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
|
// IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY |
|
// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, |
|
// TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
|
// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
// | // |
// Permission is hereby granted, free of charge, to any person obtaining a copy |
////////////////////////////////////////////////////////////////////////// |
// of this software and associated documentation files (the "Software"), to |
|
// deal in the Software without restriction, including without limitation the |
|
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
|
// sell copies of the Software, and to permit persons to whom the Software is |
|
// furnished to do so, subject to the following conditions: |
|
// |
|
// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN |
|
// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED |
|
// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT |
|
// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR |
|
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT |
|
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN |
|
// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION |
|
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
|
// |
|
//============================================================================== |
|
// |
|
// Author: Mike Day (mdday@us.ibm.com) <<< Wed Mar 13 20:49:40 2002 mdd >>> |
|
// |
|
// Modified By: Amit K Arora, IBM (amita@in.ibm.com) |
|
// David Dillard, VERITAS Software Corp. |
|
// (david.dillard@veritas.com) |
|
// | // |
//%///////////////////////////////////////////////////////////////////////////// | //%///////////////////////////////////////////////////////////////////////////// |
| |
#ifndef Pegasus_Module_Controller_h |
#ifndef Pegasus_ModuleController_h |
#define Pegasus_Module_Controller_h |
#define Pegasus_ModuleController_h |
| |
#include <Pegasus/Common/Config.h> | #include <Pegasus/Common/Config.h> |
|
#include <Pegasus/Common/Linkage.h> |
#include <Pegasus/Common/Constants.h> | #include <Pegasus/Common/Constants.h> |
|
#include <Pegasus/Common/List.h> |
#include <Pegasus/Common/Message.h> | #include <Pegasus/Common/Message.h> |
#include <Pegasus/Common/InternalException.h> |
#include <Pegasus/Common/CIMMessage.h> |
#include <Pegasus/Common/IPC.h> |
|
#include <Pegasus/Common/Thread.h> |
|
#include <Pegasus/Common/AsyncOpNode.h> |
|
#include <Pegasus/Common/Cimom.h> |
|
#include <Pegasus/Common/CimomMessage.h> |
|
#include <Pegasus/Common/MessageQueueService.h> | #include <Pegasus/Common/MessageQueueService.h> |
#include <Pegasus/Common/Linkage.h> |
#include <Pegasus/Common/AsyncOpNode.h> |
#include <Pegasus/Common/AutoPtr.h> | #include <Pegasus/Common/AutoPtr.h> |
#include <Pegasus/Common/List.h> |
#include <Pegasus/Common/CIMMessage.h> |
|
|
| |
PEGASUS_NAMESPACE_BEGIN | PEGASUS_NAMESPACE_BEGIN |
| |
class ModuleController; |
class PEGASUS_COMMON_LINKAGE RegisteredModuleHandle : public Linkable |
|
|
|
|
class PEGASUS_COMMON_LINKAGE pegasus_module : public Linkable |
|
{ |
|
private: |
|
class module_rep |
|
{ | { |
public: | public: |
module_rep(ModuleController *controller, |
RegisteredModuleHandle( |
const String & name, | const String & name, |
void *module_address, | void *module_address, |
Message * (*receive_message)(Message *, void *), |
Message* (*receive_message)(Message *, void *)); |
void (*async_callback)(Uint32, Message *, void *), |
|
void (*shutdown_notify)(Uint32 code, void *)); |
|
| |
~module_rep(); |
virtual ~RegisteredModuleHandle(); |
|
|
void reference() |
|
{ |
|
_reference_count++; |
|
} |
|
|
|
void dereference() |
|
{ |
|
_reference_count--; |
|
} |
|
|
|
Uint32 reference_count() const |
|
{ |
|
return _reference_count.get(); |
|
} |
|
|
|
const String& get_name() const throw() |
|
{ |
|
return _name; |
|
} |
|
|
|
void *get_module_address() const |
|
{ |
|
return _module_address; |
|
} |
|
|
|
Message * module_receive_message(Message *msg); |
|
|
|
void _send_async_callback(Uint32 msg_handle, Message *msg, void *parm); |
|
|
|
void _send_shutdown_notify(); |
|
|
|
void lock() |
|
{ |
|
_thread_safety.lock(pegasus_thread_self()); |
|
} |
|
|
|
void unlock() |
|
{ |
|
_thread_safety.unlock(); |
|
} |
|
|
|
private: |
|
module_rep(); |
|
module_rep(const module_rep&); |
|
module_rep & operator=(const module_rep & rep); |
|
|
|
Mutex _thread_safety; |
|
// Don't make this an AutoPtr. Refer to bug 3502 |
|
ModuleController* _controller; |
|
String _name; |
|
AtomicInt _reference_count; |
|
AtomicInt _shutting_down; |
|
|
|
void *_module_address; |
|
Message * (*_receive_message)(Message *, void *); |
|
void (*_async_callback)(Uint32, Message *, void *); |
|
void (*_shutdown_notify)(Uint32 code, void *); |
|
|
|
static Message * default_receive_message(Message *msg, void *inst) |
|
{ |
|
throw NotImplemented("Module Receive"); |
|
return 0; |
|
} |
|
|
|
static void default_async_callback(Uint32 handle, Message *msg, void *inst) |
|
{ |
|
throw NotImplemented("Module Async Receive"); |
|
} |
|
|
|
static void default_shutdown_notify(Uint32 code, void *inst) |
|
{ |
|
// Intentionally left blank |
|
} |
|
|
|
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(); |
|
} |
|
|
|
friend class ModuleController; |
|
}; |
|
|
|
public: |
|
pegasus_module(ModuleController *controller, |
|
const String &id, |
|
void *module_address, |
|
Message * (*receive_message)(Message *, void *), |
|
void (*async_callback)(Uint32, Message *, void *), |
|
void (*shutdown_notify)(Uint32 code, void *)); |
|
|
|
pegasus_module(const pegasus_module & mod); |
|
pegasus_module & operator= (const pegasus_module & mod); |
|
|
|
virtual ~pegasus_module(); |
|
|
|
Boolean operator == (const String & mod) const; |
|
| |
const String & get_name() const; | const String & get_name() const; |
| |
// introspection interface |
|
Boolean query_interface(const String & class_id, void **object_ptr) const; |
|
|
|
private: | private: |
| |
AutoPtr<module_rep> _rep;//PEP101 |
RegisteredModuleHandle(); |
|
RegisteredModuleHandle(const RegisteredModuleHandle&); |
pegasus_module() |
RegisteredModuleHandle& operator=(const RegisteredModuleHandle&); |
{ |
|
} |
|
| |
Boolean _rcv_msg(Message *); |
|
Message * _receive_message(Message *msg); | Message * _receive_message(Message *msg); |
void _send_async_callback(Uint32 msg_handle, Message *msg, void *); |
String _name; |
void _send_shutdown_notify(); |
void* _module_address; |
Boolean _shutdown(); |
Message* (*_module_receive_message)(Message *, void *); |
|
|
void reference() |
|
{ |
|
_rep->reference(); |
|
} |
|
|
|
void dereference() |
|
{ |
|
_rep->dereference(); |
|
} |
|
| |
friend class ModuleController; | friend class ModuleController; |
}; | }; |
|
|
{ | { |
public: | public: |
typedef MessageQueueService Base; | typedef MessageQueueService Base; |
|
|
class callback_handle |
|
{ |
|
public: |
|
callback_handle(pegasus_module * module, void *parm) |
|
: _module(module), _parm(parm) |
|
{ |
|
} |
|
|
|
~callback_handle() |
|
{ |
|
if( _module->get_name() == String(PEGASUS_MODULENAME_TEMP) ) |
|
// delete _module; |
|
_module.reset(); |
|
} |
|
|
|
AutoPtr<pegasus_module> _module;//PEP101 |
|
void *_parm; |
|
}; |
|
|
|
public: |
|
ModuleController(const char *name); | ModuleController(const char *name); |
/* ModuleController(const char *name, */ |
|
/* Sint16 min_threads, */ |
|
/* Sint16 max_threads, */ |
|
/* struct timeval & create_thread, */ |
|
/* struct timeval & destroy_thread); */ |
|
| |
~ModuleController(); | ~ModuleController(); |
| |
// module api |
void register_module( |
// @exception AlreadyExistsException |
|
// @exception IncompatibleTypesException |
|
static ModuleController & register_module(const String & controller_name, |
|
const String & module_name, | const String & module_name, |
void *module_address, | void *module_address, |
Message * (*receive_message)(Message *, void *), |
Message* (*receive_message)(Message *, void *)); |
void (*async_callback)(Uint32, Message *, void *), |
|
void (*shutdown_notify)(Uint32, void *), |
|
pegasus_module **instance = NULL); |
|
|
|
// @exception Permission |
|
Boolean deregister_module(const String & module_name); |
|
|
|
// @exception Permission |
|
Uint32 find_service(const pegasus_module & handle, const String & name); |
|
|
|
// @exception Permission |
|
// @exception IPCException |
|
Uint32 find_module_in_service(const pegasus_module & handle, |
|
const String & module_name); |
|
|
|
// @exception Permission |
|
pegasus_module * get_module_reference(const pegasus_module & my_handle, |
|
const String & module_name); |
|
|
|
// send a message to another service |
|
// @exception Permission |
|
// @exception IPCException |
|
AsyncReply *ModuleSendWait(const pegasus_module & handle, |
|
Uint32 destination_q, |
|
AsyncRequest *request); |
|
|
|
// send a message to another module via another service |
|
// @exception Permission |
|
// @exception DeadLock |
|
// @exception IPCException |
|
AsyncReply *ModuleSendWait(const pegasus_module & handle, |
|
Uint32 destination_q, |
|
const String & destination_module, |
|
AsyncRequest *message); |
|
|
|
// send an async message to another service |
|
// @exception Permission |
|
// @exception DeadLock |
|
// @exception IPCException |
|
Boolean ModuleSendAsync(const pegasus_module & handle, |
|
Uint32 msg_handle, |
|
Uint32 destination_q, |
|
AsyncRequest *message, |
|
void *callback_parm); |
|
|
|
// send an async message to another module via another service |
|
// @exception Permission |
|
// @exception IPCException |
|
Boolean ModuleSendAsync(const pegasus_module & handle, |
|
Uint32 msg_handle, |
|
Uint32 destination_q, |
|
const String & destination_module, |
|
AsyncRequest *message, |
|
void *callback_parm); |
|
|
|
// @exception Permission |
|
// @exception IPCException |
|
Boolean ModuleSendForget(const pegasus_module & handle, |
|
Uint32 destination_q, |
|
AsyncRequest *message); |
|
|
|
// @exception Permission |
|
// @exception IPCException |
|
Boolean ModuleSendForget(const pegasus_module & handle, |
|
Uint32 destination_q, |
|
const String & destination_module, |
|
AsyncRequest *message); |
|
|
|
Boolean verify_handle(pegasus_module *); |
|
| |
static ModuleController* getModuleController(); | static ModuleController* getModuleController(); |
| |
// send a message to another service |
static void indicationCallback( |
// @exception Permission |
CIMProcessIndicationRequestMessage* request); |
// @exception IPCException |
|
AsyncReply *ClientSendWait( |
|
Uint32 destination_q, AsyncRequest *request); |
|
| |
// send a message to another module via another service |
// send a message to another service |
// @exception Permission |
|
// @exception Deadlock |
|
// @exception IPCException |
|
AsyncReply *ClientSendWait( | AsyncReply *ClientSendWait( |
Uint32 destination_q, | Uint32 destination_q, |
String & destination_module, |
AsyncRequest* request); |
AsyncRequest *message); |
|
|
|
// send an async message to another service |
|
// @exception Permission |
|
// @exception IPCException |
|
Boolean ClientSendAsync( |
|
Uint32 msg_handle, |
|
Uint32 destination_q, |
|
AsyncRequest *message, |
|
void (*async_callback)(Uint32, Message *, void *) , |
|
void *callback_parm); |
|
|
|
// send an async message to another module via another service |
|
// @exception Permission |
|
// @exception IPCException |
|
Boolean ClientSendAsync( |
|
Uint32 msg_handle, |
|
Uint32 destination_q, |
|
const String & destination_module, |
|
AsyncRequest *message, |
|
void (*async_callback)(Uint32, Message *, void *), |
|
void *callback_parm); |
|
|
|
// @exception Permission |
|
// @exception IPCException |
|
Boolean ClientSendForget( |
|
Uint32 destination_q, |
|
AsyncRequest *message); |
|
| |
// @exception Permission |
|
// @exception IPCException |
|
Boolean ClientSendForget( | Boolean ClientSendForget( |
Uint32 destination_q, | Uint32 destination_q, |
const String & destination_module, |
|
AsyncRequest *message); | AsyncRequest *message); |
| |
protected: | protected: |
// ATTN-RK-P2-20010322: These methods are pure virtual in superclass | // ATTN-RK-P2-20010322: These methods are pure virtual in superclass |
virtual void handleEnqueue() {} | virtual void handleEnqueue() {} |
virtual void handleEnqueue(Message *) {} |
virtual void handleEnqueue(Message *message); |
virtual void _handle_async_request(AsyncRequest *rq); | virtual void _handle_async_request(AsyncRequest *rq); |
virtual void _handle_async_callback(AsyncOpNode *op); | virtual void _handle_async_callback(AsyncOpNode *op); |
| |
private: | private: |
class _module_lock |
static void _indicationDeliveryRoutine( |
{ |
CIMProcessIndicationRequestMessage* request); |
public: |
typedef List<RegisteredModuleHandle, Mutex> RegisteredModulesList; |
_module_lock(List<pegasus_module, RecursiveMutex> * list) |
RegisteredModulesList _modules; |
:_list(list) |
|
{ |
|
_list->lock(); |
|
} |
|
|
|
~_module_lock() |
|
{ |
|
_list->unlock(); |
|
} |
|
|
|
private: |
|
_module_lock(); |
|
List<pegasus_module, RecursiveMutex> * _list; |
|
}; |
|
|
|
|
|
|
|
static void _async_handleEnqueue(AsyncOpNode *h, MessageQueue *q, void *parm); |
|
List<pegasus_module, RecursiveMutex> _modules; |
|
AsyncReply *_send_wait(Uint32, AsyncRequest *); |
|
AsyncReply *_send_wait(Uint32, const String &, AsyncRequest *); |
|
|
|
// @exception IPCException |
|
Boolean _send_forget(Uint32, AsyncRequest *); |
|
|
|
// @exception IPCException |
|
Boolean _send_forget(Uint32, const String &, AsyncRequest *); |
|
}; | }; |
| |
PEGASUS_NAMESPACE_END | PEGASUS_NAMESPACE_END |
| |
#endif // Pegasus_Module_Controller_H |
#endif // Pegasus_ModuleController_h |