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

Return to Message.h CVS log

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

Diff for /pegasus/src/Pegasus/Common/Message.h between version 1.16 and 1.100

version 1.16, 2002/02/02 01:03:31

version 1.100, 2009/05/27 05:56:25

Line 1

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

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

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

// The Open Group, Tivoli Systems

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

// Permission is hereby granted, free of charge, to any person obtaining a

// of this software and associated documentation files (the "Software"), to

// copy of this software and associated documentation files (the "Software"),

// deal in the Software without restriction, including without limitation the

// to deal in the Software without restriction, including without limitation

// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or

// the rights to use, copy, modify, merge, publish, distribute, sublicense,

// sell copies of the Software, and to permit persons to whom the Software is

// and/or sell copies of the Software, and to permit persons to whom the

// furnished to do so, subject to the following conditions:

// Software is furnished to do so, subject to the following conditions:

// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN

// The above copyright notice and this permission notice shall be included

// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED

// in all copies or substantial portions of the Software.

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

//==============================================================================

// 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 Brasher (mbrasher@bmc.com)

//////////////////////////////////////////////////////////////////////////

// Modified By: Nitin Upasani, Hewlett-Packard Company (Nitin_Upasani@hp.com)

// Modified By: Carol Ann Krug Graves, Hewlett-Packard Company

// (carolann_graves@hp.com)

// Modified By: Mike Day (mdday@us.ibm.com)

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

Line 36

Line 35

#include <Pegasus/Common/Config.h>

#include <iostream>

#include <cstring>

#include <Pegasus/Common/Exception.h>

#include <Pegasus/Common/InternalException.h>

#include <Pegasus/Common/IPC.h>

#include <Pegasus/Common/Linkage.h>

#include <Pegasus/Common/CIMOperationType.h>

#include <Pegasus/Common/Linkable.h>

PEGASUS_NAMESPACE_BEGIN

// REVIEW: could class be renamed to MessageMask (coding standard)?

class PEGASUS_COMMON_LINKAGE MessageMask

class PEGASUS_COMMON_LINKAGE message_mask

{

public:

// Message handling is indicated by the high order 12 bits. For example:

static Uint32 type_legacy;

// Uint32 messageHandling = flags & 0xfff00000;

static Uint32 type_CIMOperation;

static Uint32 type_CIMAsyncOperation;

static Uint32 type_export;

static Uint32 type_lifetime;

static Uint32 type_socket;

static Uint32 type_connection;

static Uint32 type_http;

static Uint32 type_cimom;

static Uint32 type_control;

static Uint32 type_service;

static Uint32 type_broadcast;

static Uint32 ha_no_delete;

static Uint32 ha_request;

static Uint32 ha_reply;

static Uint32 ha_synchronous;

static Uint32 ha_async;

// more for documentation than for use

inline Uint32 get_type(Uint32 flags)

{

return (flags & 0x000fffff);

}

inline Uint32 get_handling(Uint32 flags)

{

return( flags & 0xfff00000);

}

};

class MessageQueue;

enum HttpMethod

/** The Message class and derived classes are used to pass messages between

modules. Messages are passed between modules using the message queues

(see MessageQueue class). Derived classes may add their own fields.

This base class defines two common fields: type, which is the type of

the message, and key which is a key value whose meaning is defined by

the derived class. The MessageQueue class provides methods for finding

messages by both type and key.

The Message class also provides previous and next pointers which are

used to place the messages on a queue by the MessageQueue class.

class PEGASUS_COMMON_LINKAGE Message

{

public:

HTTP_METHOD__POST,

HTTP_METHOD_M_POST

Message(

Uint32 type,

Uint32 key = getNextKey(),

Uint32 routing_code = 0,

Uint32 mask = message_mask::type_legacy)

_type(type),

_key(key),

_routing_code(routing_code),

_mask(mask),

_next(0),

_prev(0)

{

}

virtual ~Message();

Uint32 getType() const { return _type; }

void setType(Uint32 type) { _type = type; }

Uint32 getKey() const { return _key; }

void setKey(Uint32 key) { _key = key; }

Uint32 getRouting() const { return _routing_code; }

void setRouting(Uint32 routing) { _routing_code = routing; }

Uint32 getMask() const { return _mask; }

void setMask(Uint32 mask) { _mask = mask; }

Message* getNext() { return _next; }

const Message* getNext() const { return _next; }

Message* getPrevious() { return _prev; }

const Message* getPrevious() const { return _prev; }

static Uint32 getNextKey()

{

_mut.lock( pegasus_thread_self() ) ;

Uint32 ret = _nextKey++;

_mut.unlock();

return ret;

}

virtual void print(PEGASUS_STD(ostream)& os) const;

// << Thu Dec 27 10:46:04 2001 mdd >> for use with DQueue container

// as used by AsyncOpNode

Boolean operator == (void *msg )

{

if (reinterpret_cast<void *>(this) == msg )

return true;

return false;

}

private:

Uint32 _type;

Uint32 _key;

Uint32 _routing_code;

Uint32 _mask;

Message* _next;

Message* _prev;

MessageQueue* _owner;

static Uint32 _nextKey;

static Mutex _mut;

friend class MessageQueue;

};

enum MessageType

{

DUMMY_MESSAGE,

Line 187

Line 73

CIM_CREATE_INSTANCE_REQUEST_MESSAGE,

CIM_MODIFY_CLASS_REQUEST_MESSAGE,

CIM_MODIFY_INSTANCE_REQUEST_MESSAGE,

CIM_ENUMERATE_CLASSES_REQUEST_MESSAGE,

CIM_ENUMERATE_CLASSES_REQUEST_MESSAGE, //10

CIM_ENUMERATE_CLASS_NAMES_REQUEST_MESSAGE,

CIM_ENUMERATE_INSTANCES_REQUEST_MESSAGE,

CIM_ENUMERATE_INSTANCE_NAMES_REQUEST_MESSAGE,

Line 197

Line 83

CIM_REFERENCES_REQUEST_MESSAGE,

CIM_REFERENCE_NAMES_REQUEST_MESSAGE,

CIM_GET_PROPERTY_REQUEST_MESSAGE,

CIM_SET_PROPERTY_REQUEST_MESSAGE,

CIM_SET_PROPERTY_REQUEST_MESSAGE, //20

CIM_GET_QUALIFIER_REQUEST_MESSAGE,

CIM_SET_QUALIFIER_REQUEST_MESSAGE,

CIM_DELETE_QUALIFIER_REQUEST_MESSAGE,

CIM_ENUMERATE_QUALIFIERS_REQUEST_MESSAGE,

CIM_INVOKE_METHOD_REQUEST_MESSAGE,

CIM_ENABLE_INDICATION_SUBSCRIPTION_REQUEST_MESSAGE,

CIM_MODIFY_INDICATION_SUBSCRIPTION_REQUEST_MESSAGE,

CIM_DISABLE_INDICATION_SUBSCRIPTION_REQUEST_MESSAGE,

CIM_PROCESS_INDICATION_REQUEST_MESSAGE,

CIM_HANDLE_INDICATION_REQUEST_MESSAGE,

CIM_NOTIFY_PROVIDER_REGISTRATION_REQUEST_MESSAGE,

CIM_NOTIFY_PROVIDER_TERMINATION_REQUEST_MESSAGE,

CIM_CREATE_SUBSCRIPTION_REQUEST_MESSAGE, // 30

CIM_MODIFY_SUBSCRIPTION_REQUEST_MESSAGE,

CIM_DELETE_SUBSCRIPTION_REQUEST_MESSAGE,

CIM_DISABLE_MODULE_REQUEST_MESSAGE,

CIM_ENABLE_MODULE_REQUEST_MESSAGE,

CIM_STOP_ALL_PROVIDERS_REQUEST_MESSAGE,

CIM_GET_CLASS_RESPONSE_MESSAGE,

CIM_GET_INSTANCE_RESPONSE_MESSAGE,

CIM_EXPORT_INDICATION_RESPONSE_MESSAGE,

CIM_DELETE_CLASS_RESPONSE_MESSAGE,

CIM_DELETE_INSTANCE_RESPONSE_MESSAGE,

CIM_DELETE_INSTANCE_RESPONSE_MESSAGE, // 40

CIM_CREATE_CLASS_RESPONSE_MESSAGE,

CIM_CREATE_INSTANCE_RESPONSE_MESSAGE,

CIM_MODIFY_CLASS_RESPONSE_MESSAGE,

Line 223

Line 114

CIM_ENUMERATE_INSTANCES_RESPONSE_MESSAGE,

CIM_ENUMERATE_INSTANCE_NAMES_RESPONSE_MESSAGE,

CIM_EXEC_QUERY_RESPONSE_MESSAGE,

CIM_ASSOCIATORS_RESPONSE_MESSAGE,

CIM_ASSOCIATORS_RESPONSE_MESSAGE, // 50

CIM_ASSOCIATOR_NAMES_RESPONSE_MESSAGE,

CIM_REFERENCES_RESPONSE_MESSAGE,

CIM_REFERENCE_NAMES_RESPONSE_MESSAGE,

Line 233

Line 124

CIM_SET_QUALIFIER_RESPONSE_MESSAGE,

CIM_DELETE_QUALIFIER_RESPONSE_MESSAGE,

CIM_ENUMERATE_QUALIFIERS_RESPONSE_MESSAGE,

CIM_INVOKE_METHOD_RESPONSE_MESSAGE,

CIM_INVOKE_METHOD_RESPONSE_MESSAGE, // 60

CIM_ENABLE_INDICATION_SUBSCRIPTION_RESPONSE_MESSAGE,

CIM_MODIFY_INDICATION_SUBSCRIPTION_RESPONSE_MESSAGE,

CIM_DISABLE_INDICATION_SUBSCRIPTION_RESPONSE_MESSAGE,

CIM_PROCESS_INDICATION_RESPONSE_MESSAGE,

CIM_NOTIFY_PROVIDER_REGISTRATION_RESPONSE_MESSAGE,

CIM_NOTIFY_PROVIDER_TERMINATION_RESPONSE_MESSAGE,

CIM_HANDLE_INDICATION_RESPONSE_MESSAGE,

CIM_CREATE_SUBSCRIPTION_RESPONSE_MESSAGE,

CIM_MODIFY_SUBSCRIPTION_RESPONSE_MESSAGE,

CIM_DELETE_SUBSCRIPTION_RESPONSE_MESSAGE,

CIM_DISABLE_MODULE_RESPONSE_MESSAGE,

CIM_ENABLE_MODULE_RESPONSE_MESSAGE,

CIM_STOP_ALL_PROVIDERS_RESPONSE_MESSAGE, // 70

// Monitor-related messages:

Line 252

Line 147

// HTTP messages:

HTTP_MESSAGE,

HTTP_ERROR_MESSAGE,

// Exception messages to be passed to a CIM client application:

CLIENT_EXCEPTION_MESSAGE,

ASYNC_IOCLOSE,

ASYNC_CIMSERVICE_START,

ASYNC_CIMSERVICE_STOP,

ASYNC_ASYNC_OP_START,

ASYNC_ASYNC_OP_RESULT, // 80

ASYNC_ASYNC_LEGACY_OP_START,

ASYNC_ASYNC_LEGACY_OP_RESULT,

ASYNC_ASYNC_MODULE_OP_START,

ASYNC_ASYNC_MODULE_OP_RESULT,

CIM_NOTIFY_PROVIDER_ENABLE_REQUEST_MESSAGE,

CIM_NOTIFY_PROVIDER_ENABLE_RESPONSE_MESSAGE,

CIM_NOTIFY_PROVIDER_FAIL_REQUEST_MESSAGE,

CIM_NOTIFY_PROVIDER_FAIL_RESPONSE_MESSAGE,

CIM_INITIALIZE_PROVIDER_AGENT_REQUEST_MESSAGE,

CIM_INITIALIZE_PROVIDER_AGENT_RESPONSE_MESSAGE, // 90

CIM_NOTIFY_CONFIG_CHANGE_REQUEST_MESSAGE,

CIM_NOTIFY_CONFIG_CHANGE_RESPONSE_MESSAGE,

CIM_SUBSCRIPTION_INIT_COMPLETE_REQUEST_MESSAGE,

CIM_SUBSCRIPTION_INIT_COMPLETE_RESPONSE_MESSAGE,

CIM_INDICATION_SERVICE_DISABLED_REQUEST_MESSAGE,

CIM_INDICATION_SERVICE_DISABLED_RESPONSE_MESSAGE,

NUMBER_OF_MESSAGES

};

PEGASUS_COMMON_LINKAGE const char* MessageTypeToString(Uint32 messageType);

PEGASUS_COMMON_LINKAGE const char* MessageTypeToString(MessageType messageType);

/** This class implements a stack of queue-ids. Many messages must keep a

stack of queue-ids of queues which they must be returned to. This provides

/** The Message class and derived classes are used to pass messages between

a light efficient stack for this purpose.

modules. Messages are passed between modules using the message queues

(see MessageQueue class). Derived classes may add their own fields.

This base class defines a common type field, which is the type of

the message.

class QueueIdStack

class PEGASUS_COMMON_LINKAGE Message : public Linkable

{

public:

QueueIdStack() : _size(0)

Message(

MessageType type,

Uint32 destination = 0,

Uint32 mask = 0)

dest(destination),

_type(type),

_mask(mask),

_httpMethod(HTTP_METHOD__POST),

_httpCloseConnect(false),

_isComplete(true),

_index(0),

_async(0)

{

}

QueueIdStack(const QueueIdStack& x) : _size(x._size)

virtual ~Message();

// NOTE: The compiler default implementation of the copy constructor

// is used for this class.

Boolean getCloseConnect() const { return _httpCloseConnect; }

void setCloseConnect(Boolean httpCloseConnect)

{

memcpy(_items, x._items, sizeof(_items));

_httpCloseConnect = httpCloseConnect;

}

PEGASUS_EXPLICIT QueueIdStack(Uint32 x) : _size(0)

MessageType getType() const { return _type; }

Uint32 getMask() const { return _mask; }

void setMask(Uint32 mask) { _mask = mask; }

HttpMethod getHttpMethod() const { return _httpMethod; }

void setHttpMethod(HttpMethod httpMethod) {_httpMethod = httpMethod;}

static CIMOperationType convertMessageTypetoCIMOpType(MessageType type);

#ifdef PEGASUS_DEBUG

virtual void print(

PEGASUS_STD(ostream)& os,

Boolean printHeader = true) const;

#endif

Message* get_async()

{

push(x);

Message *ret = _async;

_async = 0;

return ret;

}

PEGASUS_EXPLICIT QueueIdStack(Uint32 x1, Uint32 x2) : _size(0)

void put_async(Message* msg)

{

push(x1);

_async = msg;

push(x2);

}

~QueueIdStack()

// set the message index indicating what piece (or sequence) this is

// message indexes start at zero

void setIndex(Uint32 index) { _index = index; }

// get the message index (or sequence number)

Uint32 getIndex() const { return _index; }

// is this the first piece of the message ?

Boolean isFirst() const { return _index == 0; }

// set the complete flag indicating whether this message piece is the last

void setComplete(Boolean isComplete)

{

_isComplete = isComplete;

}

QueueIdStack& operator=(const QueueIdStack& x)

// is this message complete? (i.e the last in a one or more sequence)

Boolean isComplete() const { return _isComplete; }

Uint32 dest;

private:

Message& operator=(const Message& msg);

MessageType _type;

Uint32 _mask;

HttpMethod _httpMethod;

Boolean _httpCloseConnect;

Boolean _isComplete;

Uint32 _index;

Message* _async;

};

/** This class implements a stack of queue-ids. Many messages must keep a

stack of queue-ids of queues which they must be returned to. This provides

a light efficient stack for this purpose.

class PEGASUS_COMMON_LINKAGE QueueIdStack

{

if (this != &x)

public:

QueueIdStack() : _size(0)

{

memcpy(_items, x._items, sizeof(_items));

_size = x._size;

}

return *this;

QueueIdStack(const QueueIdStack& x);

explicit QueueIdStack(Uint32 x);

explicit QueueIdStack(Uint32 x1, Uint32 x2);

~QueueIdStack()

{

}

QueueIdStack& operator=(const QueueIdStack& x);

Uint32 size() const

{

return _size;

Line 312

Line 330

void push(Uint32 x)

{

#ifdef PEGASUS_DEBUG

if (_size == MAX_SIZE)

throw StackOverflow();

#endif

_items[_size++] = x;

}

Uint32& top()

{

#ifdef PEGASUS_DEBUG

if (_size == 0)

throw StackUnderflow();

#endif

return _items[_size-1];

}

Line 333

Line 353

void pop()

{

#ifdef PEGASUS_DEBUG

if (_size == 0)

throw StackUnderflow();

#endif

_size--;

}

/** Make a copy of this stack and then pop the top element. */

QueueIdStack copyAndPop() const

QueueIdStack copyAndPop() const;

{

return QueueIdStack(*this, 0);

Uint32 operator[](Uint32 i) const { return _items[i]; }

}

private:

// Copy the given stack but then pop the top element:

QueueIdStack(const QueueIdStack& x, int) : _size(x._size)

QueueIdStack(const QueueIdStack& x, int);

{

memcpy(_items, x._items, sizeof(_items));

pop();

}

enum { MAX_SIZE = 5 };

Uint32 _items[MAX_SIZE];

Legend:

Removed from v.1.16
changed lines
	Added in v.1.100

No CVS admin address has been configured