haiku/headers/os/app/MessageQueue.h
John Scipione be902ac4db App Kit: style changes.
No functional change intended.

Focused on documented classes only.

* Update copyright information.
* whitespace fixes.
* pointer style
* Rename some variables, msg => message, form => what
* Need consistent variable names to make documentation easier,
  allows us to use \copydoc or \copydetails instead of repeating
  ourselves over and over again.
2014-06-11 16:24:02 -04:00

59 lines
1.3 KiB
C++

/*
* Copyright 2001-2014 Haiku, Inc. All rights reserved.
* Distributed under the terms of the MIT License.
*/
#ifndef _MESSAGE_QUEUE_H
#define _MESSAGE_QUEUE_H
#include <Locker.h>
#include <Message.h>
// For convenience
class BMessageQueue {
public:
BMessageQueue();
virtual ~BMessageQueue();
void AddMessage(BMessage* message);
void RemoveMessage(BMessage* message);
int32 CountMessages() const;
bool IsEmpty() const;
BMessage* FindMessage(int32 index) const;
BMessage* FindMessage(uint32 what, int32 index = 0) const;
bool Lock();
void Unlock();
bool IsLocked() const;
BMessage* NextMessage();
bool IsNextMessage(const BMessage* message) const;
private:
// Reserved space in the vtable for future changes to BMessageQueue
virtual void _ReservedMessageQueue1();
virtual void _ReservedMessageQueue2();
virtual void _ReservedMessageQueue3();
BMessageQueue(const BMessageQueue &);
BMessageQueue& operator=(const BMessageQueue &);
bool IsLocked();
// this needs to be exported for R5 compatibility and should
// be dropped as soon as possible
private:
BMessage* fHead;
BMessage* fTail;
int32 fMessageCount;
mutable BLocker fLock;
uint32 _reserved[3];
};
#endif // _MESSAGE_QUEUE_H