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.5.2.12 and 1.85.14.3

version 1.5.2.12, 2001/12/10 13:04:34

version 1.85.14.3, 2007/01/24 04:40:09

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)

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

// (carolann_graves@hp.com)

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

#ifndef Pegasus_Message_h

Line 35

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

#include <Pegasus/Common/CIMOperationType.h>

#include <Pegasus/Common/Threads.h>

#include <Pegasus/Common/Linkable.h>

PEGASUS_NAMESPACE_BEGIN

class PEGASUS_EXPORT message_mask

class PEGASUS_COMMON_LINKAGE MessageMask

{

public:

// Message type is indicated by the low order 20 bits. For example:

// Uint32 messageType = flags & 0x000fffff;

static Uint32 type_legacy;

static Uint32 type_CIMClass;

static Uint32 type_CIMInstance;

static Uint32 type_CIMIndication;

static Uint32 type_CIMQualifier;

static Uint32 type_CIMSubscription;

static Uint32 type_socket;

static Uint32 type_connection;

static Uint32 type_http;

static Uint32 type_cimom;

static Uint32 type_service;

static Uint32 type_request;

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

static Uint32 type_reply;

// Uint32 messageHandling = flags & 0xfff00000;

static Uint32 type_control;

static Uint32 ha_request;

static Uint32 ha_reply;

static Uint32 ha_async;

};

class MessageQueue;

enum HttpMethod

{

HTTP_METHOD__POST,

HTTP_METHOD_M_POST

};

/** 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 key = getNextKey(), Uint32 mask = message_mask::type_legacy)

Message(

: _type(type), _key(key), _mask(mask), _next(0), _prev(0) { }

Uint32 type,

Uint32 destination = 0,

Uint32 mask = MessageMask::type_legacy)

_type(type),

_mask(mask),

_httpMethod (HTTP_METHOD__POST),

_serverStartTimeMicroseconds(0),

_providerTimeMicroseconds(0),

_totalServerTimeMicroseconds(0),

_close_connect(false),

_last_thread_id(Threads::self()),

_async(0),

dest(destination),

_isComplete(true),

_index(0)

{

}

virtual ~Message();

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

// is used for this class.

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

Uint32 getMask() const { return _mask; }

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

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

Message* getNext() { return _next; }

HttpMethod getHttpMethod() const { return _httpMethod; }

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

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

Message* getPrevious() { return _prev; }

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

#ifndef PEGASUS_DISABLE_PERFINST

// Needed for performance measurement

Uint64 getServerStartTime() const

{

return _serverStartTimeMicroseconds;

}

static Uint32 getNextKey()

void setServerStartTime(Uint64 serverStartTimeMicroseconds)

{

_serverStartTimeMicroseconds = serverStartTimeMicroseconds;

}

_mut.lock( pegasus_thread_self() ) ;

void endServer();

Uint32 ret = _nextKey++;

_mut.unlock();

Uint64 getProviderTime() const

{

return _providerTimeMicroseconds;

}

void setProviderTime(Uint64 providerTimeMicroseconds)

{

_providerTimeMicroseconds = providerTimeMicroseconds;

}

Uint64 getTotalServerTime() const

{

return _totalServerTimeMicroseconds;

}

void setTotalServerTime(Uint64 totalServerTimeMicroseconds)

{

_totalServerTimeMicroseconds = totalServerTimeMicroseconds;

}

#endif

static CIMOperationType convertMessageTypetoCIMOpType(Uint32 type);

#ifdef PEGASUS_DEBUG

virtual void print(

PEGASUS_STD(ostream)& os,

Boolean printHeader = true) const;

#endif

Message *get_async(void)

{

Message *ret = _async;

_async = 0;

return ret;

}

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

void put_async(Message * msg)

{

_async = msg;

}

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

Boolean thread_changed(void)

{

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

{

_last_thread_id = Threads::self();

return true;

}

return false;

}

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

// message indexes start at zero

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

// increment the message index

void incrementIndex() { _index++; }

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

// last or not

void setComplete(Boolean isComplete)

{ _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 _mask;

Message* _next;

HttpMethod _httpMethod;

Message* _prev;

MessageQueue* _owner;

static Uint32 _nextKey;

static Mutex _mut;

friend class MessageQueue;

};

// Needed for performance measurement

Uint64 _serverStartTimeMicroseconds;

Uint64 _providerTimeMicroseconds;

Uint64 _totalServerTimeMicroseconds;

// each component needs to support a set of these messgaes and pass that array

Boolean _close_connect;

// to the dispatcher so the dispatcher can route messages at the first level

// i.e., client will not accept request messages.

// every message should have a response

// dispatcher supports full cim api set (as below)

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

// repository needs to be a peer to the provider manager

ThreadType _last_thread_id;

public:

Message *_async;

Uint32 dest;

private:

Message& operator=(const Message& msg);

Boolean _isComplete;

Uint32 _index;

};

// mkdir _dispatcher

// mkdir _providermanager

// mkdir _server (http incoming, front end)

// mkdir _repositorymanager

// _subscriptionprocessor

// _indicationprocessor

// _configurationmanager

// _cimom (loads and links everyone, hooks up queues)

// fundamental messages:

// start, stop, pause, resume

// handshaking: interrogate (as in windows service api)

// message class support

// message namespace support ???

enum MessageType

{

Line 162

Line 256

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 172

Line 266

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

CIM_MODIFY_INDICATION_SUBSCRIPTION_REQUEST_MESSAGE,

CIM_HANDLE_INDICATION_REQUEST_MESSAGE,

CIM_DISABLE_INDICATION_SUBSCRIPTION_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 195

Line 297

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 205

Line 307

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

CIM_MODIFY_INDICATION_SUBSCRIPTION_RESPONSE_MESSAGE,

CIM_NOTIFY_PROVIDER_REGISTRATION_RESPONSE_MESSAGE,

CIM_DISABLE_INDICATION_SUBSCRIPTION_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 221

Line 330

// HTTP messages:

HTTP_MESSAGE,

HTTP_ERROR_MESSAGE,

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

CLIENT_EXCEPTION_MESSAGE,

ASYNC_REGISTER_CIM_SERVICE,

ASYNC_DEREGISTER_CIM_SERVICE,

ASYNC_UPDATE_CIM_SERVICE,

ASYNC_IOCTL,

ASYNC_CIMSERVICE_START, // 80

ASYNC_CIMSERVICE_STOP,

ASYNC_CIMSERVICE_PAUSE,

ASYNC_CIMSERVICE_RESUME,

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

ASYNC_ENUMERATE_SERVICE_RESULT,

ASYNC_REGISTERED_MODULE,

ASYNC_DEREGISTERED_MODULE,

ASYNC_FIND_MODULE_IN_SERVICE,

ASYNC_FIND_MODULE_IN_SERVICE_RESPONSE,

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,

// Added for NamedPipe implementation for windows

#if defined (PEGASUS_OS_TYPE_WINDOWS) &&\

!defined(PEGASUS_DISABLE_LOCAL_DOMAIN_SOCKET)

// Monitor-related messages:

NAMEDPIPE_MESSAGE,

#endif

NUMBER_OF_MESSAGES

};

Line 231

Line 396

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 239

Line 404

{

}

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

QueueIdStack(const QueueIdStack& x);

{

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

}

PEGASUS_EXPLICIT QueueIdStack(Uint32 x) : _size(0)

PEGASUS_EXPLICIT QueueIdStack(Uint32 x);

{

push(x);

}

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

PEGASUS_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 281

Line 428

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 302

Line 451

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.5.2.12
changed lines
	Added in v.1.85.14.3

No CVS admin address has been configured