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.34 and 1.89

version 1.34, 2002/05/16 19:38:27

version 1.89, 2007/06/06 05:24:49

Line 1

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

//%2006////////////////////////////////////////////////////////////////////////

// The Open Group, Tivoli Systems

// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.

// IBM Corp.; EMC Corporation, The Open Group.

// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.

// EMC Corporation; VERITAS Software Corporation; The Open Group.

// EMC Corporation; Symantec Corporation; The Open Group.

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

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

Line 21

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)

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

#ifndef Pegasus_Message_h

Line 38

Line 37

#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/StatisticalData.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 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_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;

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)

enum HttpMethod

{

return( flags & 0xfff00000);

HTTP_METHOD__POST,

}

HTTP_METHOD_M_POST

};

class cimom;

class MessageQueue;

class MessageQueueService;

class AsyncLegacyOperationStart;

class AsyncLegacyOperationResult;

/** 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 = 0)

Uint32 routing_code = 0,

Uint32 mask = message_mask::type_legacy )

_type(type),

_key(key),

_routing_code(routing_code),

_mask(mask),

_next(0),

_httpMethod (HTTP_METHOD__POST),

_prev(0),

#ifndef PEGASUS_DISABLE_PERFINST

_serverStartTimeMicroseconds(0),

_providerTimeMicroseconds(0),

_totalServerTimeMicroseconds(0),

#endif

_close_connect(false),

_last_thread_id(Threads::self()),

_async(0),

dest(destination)

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;

_next = _prev = _async = 0;

dest = msg.dest;

}

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)

{

_close_connect = close_connect;

}

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

#ifdef PEGASUS_HAS_PERFINST

HttpMethod getHttpMethod() const { return _httpMethod; }

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

#ifndef PEGASUS_DISABLE_PERFINST

// Needed for performance measurement

void startServer();

Uint64 getServerStartTime() const

{

void endServer();

return _serverStartTimeMicroseconds;

}

void startProvider();

void endProvider();

timeval getStartServerTime() const { return _timeServerStart; }

void setStartServerTime(timeval timeServerStart)

void setServerStartTime(Uint64 serverStartTimeMicroseconds)

{

_timeServerStart = timeServerStart;

_serverStartTimeMicroseconds = serverStartTimeMicroseconds;

}

timeval getStartProviderTime() const { return _timeProviderStart; }

void endServer();

void setStartProviderTime(timeval timeProviderStart)

Uint64 getProviderTime() const

{

_timeProviderStart = timeProviderStart;

return _providerTimeMicroseconds;

}

timeval getEndServerTime() const { return _timeServerEnd; }

void setProviderTime(Uint64 providerTimeMicroseconds)

void setEndServerTime (timeval timeServerEnd)

{

_timeServerEnd = timeServerEnd;

_providerTimeMicroseconds = providerTimeMicroseconds;

}

timeval getEndProviderTime() const { return _timeProviderEnd; }

Uint64 getTotalServerTime() const

{

return _totalServerTimeMicroseconds;

}

void setEndProviderTime(timeval timeProviderEnd)

void setTotalServerTime(Uint64 totalServerTimeMicroseconds)

{

_timeProviderEnd = timeProviderEnd;

_totalServerTimeMicroseconds = totalServerTimeMicroseconds;

}

Uint32 getTotalTime() { return _totalTime; }

#endif

Message* getNext() { return _next; }

static CIMOperationType convertMessageTypetoCIMOpType(Uint32 type);

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

Message* getPrevious() { return _prev; }

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

#ifdef PEGASUS_DEBUG

virtual void print(

PEGASUS_STD(ostream)& os,

Boolean printHeader = true) const;

#endif

static Uint32 getNextKey()

Message* get_async()

{

Message *ret = _async;

_mut.lock( pegasus_thread_self() ) ;

_async = 0;

Uint32 ret = _nextKey++;

_mut.unlock();

return ret;

}

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

void put_async(Message* msg)

{

_async = msg;

}

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

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

// as used by AsyncOpNode

Boolean thread_changed()

Boolean operator == (const void *msg )

{

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

{

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

_last_thread_id = Threads::self();

return true;

}

return false;

}

Message *get_async(void)

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

{

// message indexes start at zero

Message *ret = _async;

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

_async = 0;

return ret;

}

// increment the message index

void incrementIndex() { _index++; }

void put_async(Message * msg)

// set the complete flag indicating if this message piece is the

// last or not

void setComplete(Boolean isComplete)

{

_async = msg;

_isComplete = isComplete ? true:false;

}

// 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 ? true : false; }

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

Boolean isComplete() const { return _isComplete; }

private:

Uint32 _type;

Uint32 _key;

Uint32 _routing_code;

Uint32 _mask;

HttpMethod _httpMethod;

#ifndef PEGASUS_DISABLE_PERFINST

// Needed for performance measurement

timeval _timeServerStart;

Uint64 _serverStartTimeMicroseconds;

timeval _timeServerEnd;

Uint64 _providerTimeMicroseconds;

timeval _timeProviderStart;

Uint64 _totalServerTimeMicroseconds;

timeval _timeProviderEnd;

#endif

Uint64 _totalTime;

Boolean _close_connect;

Message* _next;

Message* _prev;

protected:

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

ThreadType _last_thread_id;

public:

Message *_async;

Uint32 dest;

private:

MessageQueue* _owner;

Message& operator=(const Message& msg);

static Uint32 _nextKey;

static Mutex _mut;

friend class cimom;

friend class MessageQueue;

friend class MessageQueueService;

friend class AsyncLegacyOperationStart;

friend class AsyncLegacyOperationResult;

Boolean _isComplete;

Uint32 _index;

};

Line 309

Line 270

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_ENABLE_INDICATIONS_REQUEST_MESSAGE,

CIM_DISABLE_INDICATIONS_REQUEST_MESSAGE,

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

CIM_GET_CLASS_RESPONSE_MESSAGE,

CIM_GET_INSTANCE_RESPONSE_MESSAGE,

CIM_EXPORT_INDICATION_RESPONSE_MESSAGE, // 42

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 342

Line 295

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 352

Line 305

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,

// new

CIM_ENABLE_INDICATIONS_RESPONSE_MESSAGE,

CIM_DISABLE_INDICATIONS_RESPONSE_MESSAGE,

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

// Monitor-related messages:

Line 393

Line 338

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,

Line 405

Line 350

ASYNC_FIND_SERVICE_Q,

ASYNC_FIND_SERVICE_Q_RESULT,

ASYNC_ENUMERATE_SERVICE,

ASYNC_ENUMERATE_SERVICE, // 90

ASYNC_ENUMERATE_SERVICE_RESULT,

ASYNC_REGISTERED_MODULE,

Line 416

Line 361

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

CIM_NOTIFY_PROVIDER_FAIL_RESPONSE_MESSAGE,

CIM_INITIALIZE_PROVIDER_REQUEST_MESSAGE,

CIM_INITIALIZE_PROVIDER_RESPONSE_MESSAGE,

CIM_INITIALIZE_PROVIDER_AGENT_REQUEST_MESSAGE,

CIM_INITIALIZE_PROVIDER_AGENT_RESPONSE_MESSAGE,

CIM_NOTIFY_CONFIG_CHANGE_REQUEST_MESSAGE,

CIM_NOTIFY_CONFIG_CHANGE_RESPONSE_MESSAGE,

CIM_SUBSCRIPTION_INIT_COMPLETE_REQUEST_MESSAGE,

CIM_SUBSCRIPTION_INIT_COMPLETE_RESPONSE_MESSAGE,

NUMBER_OF_MESSAGES

};

Line 425

Line 388

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

a light efficient stack for this purpose.

class QueueIdStack

class PEGASUS_COMMON_LINKAGE QueueIdStack

{

public:

Line 433

Line 396

{

}

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

QueueIdStack(const QueueIdStack& x);

{

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

}

PEGASUS_EXPLICIT QueueIdStack(Uint32 x) : _size(0)

explicit QueueIdStack(Uint32 x);

{

push(x);

}

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

explicit QueueIdStack(Uint32 x1, Uint32 x2);

{

push(x1);

push(x2);

}

~QueueIdStack()

{

}

QueueIdStack& operator=(const QueueIdStack& x)

QueueIdStack& operator=(const QueueIdStack& x);

{

if (this != &x)

{

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

_size = x._size;

}

return *this;

}

Uint32 size() const

{

Line 475

Line 420

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 496

Line 443

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

}

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.34
changed lines
	Added in v.1.89

No CVS admin address has been configured