pegasus/src/Pegasus/Common/ModuleController.h - diff

Return to ModuleController.h CVS log

Up to [Pegasus] / pegasus / src / Pegasus / Common

Diff for /pegasus/src/Pegasus/Common/ModuleController.h between version 1.10 and 1.58.8.1

version 1.10, 2002/03/27 20:42:07

version 1.58.8.1, 2011/10/11 18:18:08

Line 1

//%////-*-c++-*-////////////////////////////////////////////////////////////////

//%LICENSE////////////////////////////////////////////////////////////////

// Licensed to The Open Group (TOG) under one or more contributor license

// agreements. Refer to the OpenPegasusNOTICE.txt file distributed with

// this work for additional information regarding copyright ownership.

// Each contributor licenses this file to you under the OpenPegasus Open

// Source License; you may not use this file except in compliance with the

// License.

// 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.

// 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:

//%/////////////////////////////////////////////////////////////////////////////

#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/Linkage.h>

#include <Pegasus/Common/Constants.h>

#include <Pegasus/Common/List.h>

#include <Pegasus/Common/Message.h>

#include <Pegasus/Common/Exception.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>

PEGASUS_NAMESPACE_BEGIN

#include <Pegasus/Common/AsyncOpNode.h>

#include <Pegasus/Common/AutoPtr.h>

class ModuleController;

#include <Pegasus/Common/CIMMessage.h>

PEGASUS_NAMESPACE_BEGIN

class PEGASUS_COMMON_LINKAGE pegasus_module

class PEGASUS_COMMON_LINKAGE RegisteredModuleHandle : public Linkable

{

private:

class PEGASUS_COMMON_LINKAGE module_rep

{

public:

module_rep(ModuleController *controller,

RegisteredModuleHandle(

const String & name,

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(void) ;

Boolean operator == (const module_rep *rep) const

{ if (rep == this ) return true; return false; }

Boolean operator == (const module_rep &rep) const

{ if (rep == *this) return true; return false; }

Boolean operator == (void *rep) const

virtual ~RegisteredModuleHandle();

{ if ( (void *)this == rep ) return true; return false; }

void reference(void) { _reference_count++; }

const String& get_name() const;

void dereference(void) { _reference_count--; }

Uint32 reference_count(void) { return _reference_count.value(); }

const String & get_name(void) const { return _name; }

void *get_module_address(void) const { return _module_address; }

Message * module_receive_message(Message *msg);

void _send_async_callback(Uint32 msg_handle, Message *msg);

void _send_shutdown_notify(void);

void lock(void) { _thread_safety.lock(pegasus_thread_self()); }

void unlock(void) { _thread_safety.unlock(); }

private:

module_rep(void);

module_rep(const module_rep & );

module_rep& operator= (const module_rep & );

Mutex _thread_safety;

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");}

static void default_async_callback(Uint32 handle, Message *msg, void *inst)

RegisteredModuleHandle();

{ throw NotImplemented("Module Async Receive"); }

RegisteredModuleHandle(const RegisteredModuleHandle&);

RegisteredModuleHandle& operator=(const RegisteredModuleHandle&);

static void default_shutdown_notify(Uint32 code, void *inst)

{ return; }

static Message * closed_receive_message(Message *msg, void *inst)

{ throw ModuleClosed();}

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(void);

pegasus_module & operator= (const pegasus_module & mod);

Boolean operator == (const pegasus_module *mod) const;

Boolean operator == (const pegasus_module & mod) const ;

Boolean operator == (const String & mod) const;

Boolean operator == (const void *mod) const;

const String & get_name(void) const;

// introspection interface

Boolean query_interface(const String & class_id, void **object_ptr) const;

private:

module_rep *_rep;

pegasus_module(void);

pegasus_module(const pegasus_module & mod);

Boolean _rcv_msg(Message *) ;

Message * _receive_message(Message *msg);

void _send_async_callback(Uint32 msg_handle, Message *msg) ;

String _name;

void _send_shutdown_notify(void);

void* _module_address;

Boolean _shutdown(void);

Message* (*_module_receive_message)(Message *, void *);

void reference(void) { _rep->reference(); }

void dereference(void) { _rep->dereference(); }

friend class ModuleController;

};

class PEGASUS_COMMON_LINKAGE ModuleController : public MessageQueueService

{

public:

typedef MessageQueueService Base;

ModuleController(const char *name);

ModuleController(const char *name,

Sint16 min_threads,

Sint16 max_threads,

struct timeval & create_thread,

struct timeval & destroy_thread,

struct timeval & deadlock);

~ModuleController();

~ModuleController(void);

void register_module(

// module api

static ModuleController & register_module(const String & controller_name,

const String & module_name,

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)

throw(AlreadyExists, IncompatibleTypes);

Boolean deregister_module(const String & module_name);

Uint32 find_service(pegasus_module & handle, const String & name) throw(Permission);

Uint32 find_module_in_service(pegasus_module & handle,

static ModuleController* getModuleController();

const String & module_name)

throw(Permission, IPCException);

static void indicationCallback(

pegasus_module * get_module_reference(pegasus_module & my_handle,

CIMProcessIndicationRequestMessage* request);

const String & module_name)

throw(Permission);

// send a message to another service

AsyncReply *ModuleSendWait(pegasus_module & handle,

AsyncReply* ClientSendWait(

Uint32 destination_q,

AsyncRequest *request) throw(Permission, IPCException);

// send a message to another module via another service

AsyncReply *ModuleSendWait(pegasus_module & handle,

Uint32 destination_q,

String & destination_module,

AsyncRequest* request);

AsyncRequest *message) throw(Permission, Deadlock, IPCException);

// send a message to another service

Boolean ClientSendForget(

Boolean ModuleSendAsync(pegasus_module & handle,

Uint32 msg_handle,

Uint32 destination_q,

AsyncRequest *message) throw(Permission, IPCException);

AsyncRequest* message);

// send a message to another module via another service

Boolean ModuleSendAsync(pegasus_module & handle,

Uint32 msg_handle,

Uint32 destination_q,

String & destination_module,

AsyncRequest *message) throw(Permission, IPCException);

void blocking_thread_exec(pegasus_module & handle,

PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *thread_func)(void *),

void *parm) throw(Permission, Deadlock, IPCException);

void async_thread_exec(pegasus_module & handle,

PEGASUS_THREAD_RETURN (PEGASUS_THREAD_CDECL *thread_func)(void *),

void *parm) throw(Permission, Deadlock, IPCException);

Boolean verify_handle(pegasus_module *);

protected:

// ATTN-RK-P2-20010322: These methods are pure virtual in superclass

virtual void handleEnqueue(void) {}

virtual void handleEnqueue() {}

virtual void handleEnqueue(Message *) {}

virtual void handleEnqueue(Message *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);

static void _indicationDeliveryRoutine(

DQueue<pegasus_module> _modules;

CIMProcessIndicationRequestMessage* request);

ThreadPool _thread_pool;

typedef List<RegisteredModuleHandle, Mutex> RegisteredModulesList;

RegisteredModulesList _modules;

};

PEGASUS_NAMESPACE_END

#endif // Pegasus_ModuleController_h

#endif // Pegasus_Module_Controller_H

Legend:

Removed from v.1.10
changed lines
	Added in v.1.58.8.1

No CVS admin address has been configured