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.72 and 1.85

version 1.72, 2006/01/30 16:17:05

version 1.85, 2006/09/12 17:20:14

Line 29

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

// Author: Mike Brasher (mbrasher@bmc.com)

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

// Carol Ann Krug Graves, Hewlett-Packard Company

// (carolann_graves@hp.com)

// Mike Day (mdday@us.ibm.com)

// Roger Kumpf, Hewlett-Packard Company (roger_kumpf@hp.com)

// Arthur Pichlkostner (via Markus: sedgewick_de@yahoo.de)

// Willis White (whiwill@us.ibm.com) PEP 127 and 128

// Brian G. Campbell, EMC (campbell_brian@emc.com) - PEP140/phase1

// Amit K Arora, IBM (amita@in.ibm.com) for Bug#1090

// John Alex, IBM (johnalex@us.ibm.com) - Bug#2290

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

#ifndef Pegasus_Message_h

Line 52

Line 38

#include <iostream>

#include <cstring>

#include <Pegasus/Common/InternalException.h>

#include <Pegasus/Common/IPC.h>

#include <Pegasus/Common/StatisticalData.h>

#include <Pegasus/Common/Linkage.h>

#include <Pegasus/Common/TimeValue.h>

#include <Pegasus/Common/CIMOperationType.h>

#include <Pegasus/Common/Threads.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 type is indicated by the low order 20 bits. For example:

// Uint32 messageType = flags & 0x000fffff;

static Uint32 type_legacy;

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_http_error;

static Uint32 type_cimom;

static Uint32 type_control;

static Uint32 type_service;

static Uint32 type_broadcast;

static Uint32 type_client_exception;

static Uint32 ha_no_delete;

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

// Uint32 messageHandling = flags & 0xfff00000;

static Uint32 ha_request;

static Uint32 ha_reply;

static Uint32 ha_synchronous;

static Uint32 ha_async;

static Uint32 ha_wait;

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

class MessageQueue;

class MessageQueueService;

class AsyncLegacyOperationStart;

class AsyncLegacyOperationResult;

enum HttpMethod

{

HTTP_METHOD__POST,

Line 117

Line 71

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

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

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

the message.

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

class PEGASUS_COMMON_LINKAGE Message : public Linkable

{

public:

Message(

Uint32 type,

Uint32 destination = 0,

Uint32 key = getNextKey(),

Uint32 mask = MessageMask::type_legacy)

Uint32 routing_code = 0,

Uint32 mask = message_mask::type_legacy)

_type(type),

_key(key),

_routing_code(routing_code),

_mask(mask),

_httpMethod (HTTP_METHOD__POST),

_serverStartTimeMicroseconds(0),

_providerTimeMicroseconds(0),

_totalServerTimeMicroseconds(0),

_close_connect(false),

_last_thread_id(pegasus_thread_self()),

_last_thread_id(Threads::self()),

_next(0),

_prev(0),

_async(0),

dest(destination),

_isComplete(true),

_index(0)

{

}

Message & operator = ( const Message & msg)

virtual ~Message();

{

if (this != &msg)

{

_type = msg._type;

_key = msg._key;

_routing_code = msg._routing_code;

_mask = msg._mask;

_last_thread_id = msg._last_thread_id;

_next = _prev = _async = 0;

dest = msg.dest;

_httpMethod = msg._httpMethod;

_index = msg._index;

_isComplete = msg._isComplete;

}

return *this;

}

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

// is used for this class.

virtual ~Message();

Boolean getCloseConnect() const { return _close_connect; }

void setCloseConnect(Boolean close_connect)

{

Line 184

Line 113

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

Line 205

Line 127

// Needed for performance measurement

void startServer();

Uint64 getServerStartTime() const

void endServer();

void startProvider();

void endProvider();

TimeValue getStartServerTime() const { return _timeServerStart; }

void setStartServerTime(TimeValue timeServerStart)

{

_timeServerStart = timeServerStart;

return _serverStartTimeMicroseconds;

}

TimeValue getStartProviderTime() const { return _timeProviderStart; }

void setServerStartTime(Uint64 serverStartTimeMicroseconds)

void setStartProviderTime(TimeValue timeProviderStart)

{

_timeProviderStart = timeProviderStart;

_serverStartTimeMicroseconds = serverStartTimeMicroseconds;

}

TimeValue getEndServerTime() const { return _timeServerEnd; }

void endServer();

void setEndServerTime (TimeValue timeServerEnd)

Uint64 getProviderTime() const

{

_timeServerEnd = timeServerEnd;

return _providerTimeMicroseconds;

}

TimeValue getEndProviderTime() const { return _timeProviderEnd; }

void setProviderTime(Uint64 providerTimeMicroseconds)

void setEndProviderTime(TimeValue timeProviderEnd)

{

_timeProviderEnd = timeProviderEnd;

_providerTimeMicroseconds = providerTimeMicroseconds;

}

TimeValue getServerTime() { return _serverTime; }

Uint64 getTotalServerTime() const

{

#endif

return _totalServerTimeMicroseconds;

}

Message* getNext() { return _next; }

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

Message* getPrevious() { return _prev; }

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

static Uint32 getNextKey()

void setTotalServerTime(Uint64 totalServerTimeMicroseconds)

{

AutoMutex autoMut(_mut);

_totalServerTimeMicroseconds = totalServerTimeMicroseconds;

Uint32 ret = _nextKey++;

return ret;

}

#endif

static CIMOperationType convertMessageTypetoCIMOpType(Uint32 type);

#ifdef PEGASUS_DEBUG

Line 268

Line 169

Boolean printHeader = true) const;

#endif

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

// as used by AsyncOpNode

Boolean operator == (const void *msg )

{

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

return true;

return false;

}

Message *get_async(void)

{

Message *ret = _async;

_async = 0;

return ret;

}

void put_async(Message * msg)

Line 293

Line 184

// << Tue Jul 1 11:02:49 2003 mdd >> pep_88 and helper for i18n and l10n

Boolean thread_changed(void)

{

if(_last_thread_id != pegasus_thread_self())

if (!Threads::equal(_last_thread_id, Threads::self()))

{

_last_thread_id = pegasus_thread_self();

_last_thread_id = Threads::self();

return true;

}

return false;

}

// << Tue Jul 1 13:41:02 2003 mdd >> pep_88 -

// assist in synchronizing responses with requests

void synch_response(Message *req)

{

_key = req->_key;

_routing_code = req->_routing_code;

}

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

// message indexes start at zero

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

Line 334

Line 216

private:

Uint32 _type;

Uint32 _key;

Uint32 _routing_code;

Uint32 _mask;

HttpMethod _httpMethod;

// Needed for performance measurement

TimeValue _timeServerStart;

Uint64 _serverStartTimeMicroseconds;

TimeValue _timeServerEnd;

Uint64 _providerTimeMicroseconds;

TimeValue _timeProviderStart;

Uint64 _totalServerTimeMicroseconds;

TimeValue _timeProviderEnd;

TimeValue _serverTime;

Boolean _close_connect;

// << Tue Jul 1 11:02:35 2003 mdd >> pep_88 and helper for i18n and l10n

PEGASUS_THREAD_TYPE _last_thread_id;

ThreadType _last_thread_id;

Message* _next;

Message* _prev;

protected:

public:

Message *_async;

Uint32 dest;

//needed for PEP 128 - transmitting Server Response Time to Client

Uint64 totServerTime;

private:

MessageQueue* _owner;

Message& operator=(const Message& msg);

Boolean _isComplete;

Uint32 _index;

static Uint32 _nextKey;

static Mutex _mut;

friend class cimom;

friend class MessageQueue;

friend class MessageQueueService;

friend class AsyncLegacyOperationStart;

friend class AsyncLegacyOperationResult;

};

Line 411

Line 272

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

CIM_HANDLE_INDICATION_REQUEST_MESSAGE,

CIM_NOTIFY_PROVIDER_REGISTRATION_REQUEST_MESSAGE,

CIM_NOTIFY_PROVIDER_TERMINATION_REQUEST_MESSAGE,

CIM_CREATE_SUBSCRIPTION_REQUEST_MESSAGE, // 30

// new

CIM_CREATE_SUBSCRIPTION_REQUEST_MESSAGE,

CIM_MODIFY_SUBSCRIPTION_REQUEST_MESSAGE,

CIM_DELETE_SUBSCRIPTION_REQUEST_MESSAGE,

// new

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

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,

CIM_MODIFY_INSTANCE_RESPONSE_MESSAGE,

CIM_ENUMERATE_CLASSES_RESPONSE_MESSAGE,

CIM_ENUMERATE_CLASS_NAMES_RESPONSE_MESSAGE,

CIM_ENUMERATE_INSTANCES_RESPONSE_MESSAGE, // 50

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,

CIM_GET_PROPERTY_RESPONSE_MESSAGE,

CIM_SET_PROPERTY_RESPONSE_MESSAGE,

CIM_GET_QUALIFIER_RESPONSE_MESSAGE,

CIM_SET_QUALIFIER_RESPONSE_MESSAGE, // 60

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

CIM_HANDLE_INDICATION_RESPONSE_MESSAGE,

// new

CIM_CREATE_SUBSCRIPTION_RESPONSE_MESSAGE,

CIM_MODIFY_SUBSCRIPTION_RESPONSE_MESSAGE,

CIM_DELETE_SUBSCRIPTION_RESPONSE_MESSAGE,

// new

CIM_DISABLE_MODULE_RESPONSE_MESSAGE,

CIM_ENABLE_MODULE_RESPONSE_MESSAGE,

CIM_STOP_ALL_PROVIDERS_RESPONSE_MESSAGE, // 70

CIM_STOP_ALL_PROVIDERS_RESPONSE_MESSAGE,

// Monitor-related messages:

Line 485

Line 330

// HTTP messages:

HTTP_MESSAGE,

HTTP_ERROR_MESSAGE, // 80

HTTP_ERROR_MESSAGE,

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

Line 495

Line 340

ASYNC_DEREGISTER_CIM_SERVICE,

ASYNC_UPDATE_CIM_SERVICE,

ASYNC_IOCTL,

ASYNC_CIMSERVICE_START,

ASYNC_CIMSERVICE_START, // 80

ASYNC_CIMSERVICE_STOP,

ASYNC_CIMSERVICE_PAUSE,

ASYNC_CIMSERVICE_RESUME,

ASYNC_ASYNC_OP_START, // 90

ASYNC_ASYNC_OP_START,

ASYNC_ASYNC_OP_RESULT,

ASYNC_ASYNC_LEGACY_OP_START,

ASYNC_ASYNC_LEGACY_OP_RESULT,

ASYNC_FIND_SERVICE_Q,

ASYNC_FIND_SERVICE_Q_RESULT,

ASYNC_ENUMERATE_SERVICE,

ASYNC_ENUMERATE_SERVICE, // 90

ASYNC_ENUMERATE_SERVICE_RESULT,

ASYNC_REGISTERED_MODULE,

ASYNC_DEREGISTERED_MODULE,

ASYNC_FIND_MODULE_IN_SERVICE, // 100

ASYNC_FIND_MODULE_IN_SERVICE,

ASYNC_FIND_MODULE_IN_SERVICE_RESPONSE,

ASYNC_ASYNC_MODULE_OP_START,

Line 521

Line 366

CIM_NOTIFY_PROVIDER_ENABLE_REQUEST_MESSAGE,

CIM_NOTIFY_PROVIDER_ENABLE_RESPONSE_MESSAGE,

CIM_NOTIFY_PROVIDER_FAIL_REQUEST_MESSAGE, // 100

CIM_NOTIFY_PROVIDER_FAIL_RESPONSE_MESSAGE,

CIM_INITIALIZE_PROVIDER_REQUEST_MESSAGE,

CIM_INITIALIZE_PROVIDER_RESPONSE_MESSAGE,

Legend:

Removed from v.1.72
changed lines
	Added in v.1.85

No CVS admin address has been configured