fipa::acl::ConversationObserver Class Reference

#include <conversation.h>

Public Member Functions
	ConversationObserver ()
virtual	~ConversationObserver ()
bool	hasEvents () const
conversation::Event	waitForNextEvent ()
bool	getNextEvent (conversation::Event &msg)
std::vector< fipa::acl::ConversationID >	getConversationIdsOfObservables () const

Friends
class	ConversationObservable

Detailed Description

Observer of a conversation The observer can either operate in a non-blocking fashion relying on hasEvents and getNextEvent or block using waitForNextEvent

Definition at line 95 of file conversation.h.

Constructor & Destructor Documentation

ConversationObserver()

fipa::acl::ConversationObserver::ConversationObserver

(

)

Definition at line 27 of file conversation.cpp.

{}

~ConversationObserver()

virtual fipa::acl::ConversationObserver::~ConversationObserver ( )

inlinevirtual

Desconstructor marked virtual to create polymorphic class At least one virtual method required to allow compile to take care of polymorphism

Definition at line 106 of file conversation.h.

{}

Member Function Documentation

getConversationIdsOfObservables()

std::vector< fipa::acl::ConversationID > fipa::acl::ConversationObserver::getConversationIdsOfObservables

(

)

const

Get the conversation ids of observables

Definition at line 75 of file conversation.cpp.

{
    std::vector<fipa::acl::ConversationID> conversationIds;

    boost::unique_lock<boost::mutex> lock(mObservablesMutex);
    std::vector<ConversationObservablePtr>::const_iterator it = mObservables.begin();
    for(; it != mObservables.end(); ++it)
    {
        conversationIds.push_back((*it)->getConversationId());
    }

    return conversationIds;
}

getNextEvent()

bool fipa::acl::ConversationObserver::getNextEvent

(

conversation::Event &

msg

)

Retrieve next event

Definition at line 60 of file conversation.cpp.

{
    boost::unique_lock<boost::mutex> lock(mEventsMutex);
    if(mEvents.empty())
    {
        return false;
    }

    event = mEvents.front();
    mEvents.erase(mEvents.begin());

    LOG_INFO("Retrieve event: type: '%s', msg content: '%s'", conversation::EventTypeTxt[event.type].c_str(), event.msg.getContent().c_str());
    return true;
}

hasEvents()

bool fipa::acl::ConversationObserver::hasEvents

(

)

const

Check if there is a next message

Definition at line 30 of file conversation.cpp.

{
    boost::unique_lock<boost::mutex> lock(mEventsMutex);
    return !mEvents.empty();
}

waitForNextEvent()

conversation::Event fipa::acl::ConversationObserver::waitForNextEvent

(

)

Block this thread until a new message arrives

Returns

Next message as soon as it arrives

Definition at line 43 of file conversation.cpp.

{
    boost::mutex mutex;
    {
        boost::unique_lock<boost::mutex>  lock(mutex);
        while(!hasEvents())
        {
            mCondition.wait(lock);
        }
    }

    conversation::Event event;
    assert(getNextEvent(event));

    return event;
}

Friends And Related Function Documentation

ConversationObservable

friend class ConversationObservable

friend

Definition at line 97 of file conversation.h.

---

The documentation for this class was generated from the following files:

• /build/rock-master-18.09-multiagent-fipa-acl-0.20180914/src/conversation_monitor/conversation.h
• /build/rock-master-18.09-multiagent-fipa-acl-0.20180914/src/conversation_monitor/conversation.cpp