fipa::acl::ConversationObservable Class Reference

#include <conversation.h>

Inherited by fipa::acl::Conversation.

Public Member Functions
	ConversationObservable ()
	ConversationObservable (const ConversationObservable &other)
	ConversationObservable (const fipa::acl::ConversationID &conversationId)
virtual	~ConversationObservable ()
void	setConversationId (const fipa::acl::ConversationID &conversationId)
fipa::acl::ConversationID	getConversationId () const
void	addObserver (const ConversationObserverPtr &observer)
void	removeObserver (const ConversationObserverPtr &observer)
void	notify (const fipa::acl::ACLMessage &msg, conversation::EventType eventType)
conversation::Status	getStatus () const
ConversationObserverList	getObservers () const
void	detachObservers ()
bool	hasObservers () const

Protected Attributes
fipa::acl::ConversationID	mConversationId

Detailed Description

Base class for a conversation which can be observed by a ConversationObserver

Definition at line 159 of file conversation.h.

Constructor & Destructor Documentation

ConversationObservable() [1/3]

fipa::acl::ConversationObservable::ConversationObservable

(

)

Default constructor

Definition at line 327 of file conversation.cpp.

    : mStatus(conversation::UNINITIALIZED)
{}

ConversationObservable() [2/3]

fipa::acl::ConversationObservable::ConversationObservable

(

const ConversationObservable &

other

)

Definition at line 331 of file conversation.cpp.

    : mConversationId(other.mConversationId)
    , mStatus(other.mStatus)
    , mObservers(other.mObservers)
{}

ConversationObservable() [3/3]

fipa::acl::ConversationObservable::ConversationObservable

(

const fipa::acl::ConversationID &

conversationId

)

Construct conversation observable with a given id

Definition at line 337 of file conversation.cpp.

    : mConversationId(conversationId)
    , mStatus(conversation::UNINITIALIZED)
{}

~ConversationObservable()

virtual fipa::acl::ConversationObservable::~ConversationObservable ( )

inlinevirtual

Desconstructor marked virtual to create polymorphic class

Definition at line 177 of file conversation.h.

{}

Member Function Documentation

addObserver()

void fipa::acl::ConversationObservable::addObserver

(

const ConversationObserverPtr &

observer

)

Add a conversation observer

Definition at line 353 of file conversation.cpp.

{
    boost::unique_lock<boost::mutex> lock(mObserverMutex);
    ConversationObserverList::const_iterator it = std::find(mObservers.begin(), mObservers.end(), observer);
    if(it == mObservers.end())
    {
        mObservers.push_back(observer);
        observer->registerObservable(ConversationObservablePtr(this, NullDeleter()));
    }
}

detachObservers()

void fipa::acl::ConversationObservable::detachObservers

(

)

Remove all attached observers, e.g. to break cyclic dependencies when working with shared pointers

Definition at line 410 of file conversation.cpp.

{
    mObservers.clear();
}

getConversationId()

fipa::acl::ConversationID fipa::acl::ConversationObservable::getConversationId

(

)

const

Get the conversation id

Returns

Conversation id

Definition at line 342 of file conversation.cpp.

{
    return mConversationId;
}

getObservers()

ConversationObserverList fipa::acl::ConversationObservable::getObservers

(

)

const

Retrieve the observers of this conversation

Definition at line 415 of file conversation.cpp.

{
    boost::unique_lock<boost::mutex> lock(mObserverMutex);
    return mObservers;
}

getStatus()

conversation::Status fipa::acl::ConversationObservable::getStatus

(

)

const

Get the current status of the conversation

Definition at line 405 of file conversation.cpp.

{
    return mStatus;
}

hasObservers()

bool fipa::acl::ConversationObservable::hasObservers

(

)

const

Test whether there are observers

Returns

true if there are observers attached to this observable, false otherwise

Definition at line 347 of file conversation.cpp.

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

notify()

void fipa::acl::ConversationObservable::notify	(	const fipa::acl::ACLMessage &	msg,
		conversation::EventType	eventType
	)

Notify all attached observers

Definition at line 374 of file conversation.cpp.

{
    boost::unique_lock<boost::mutex> lock(mObserverMutex);
    LOG_INFO("notify: message event: '%s', message content: '%s'", conversation::EventTypeTxt[eventType].c_str(), msg.getContent().c_str());
    ConversationObserverList::iterator it = mObservers.begin();
    for(; it != mObservers.end(); ++it)
    {
        (*it)->update( conversation::Event(msg, eventType) );
    }

    switch(eventType)
    {
        case conversation::START_OF_CONVERSATION:
            assert(mStatus == conversation::UNINITIALIZED);
            mStatus = conversation::RUNNING;
            break;
        case conversation::END_OF_CONVERSATION:
            mStatus = conversation::ENDED;
            break;
        case conversation::INTERMEDIATE_UPDATE:
            mStatus = conversation::RUNNING;
            break;
        case conversation::FAILURE:
            mStatus = conversation::FAILED;
            break;
        default:
            break;
    }

}

removeObserver()

void fipa::acl::ConversationObservable::removeObserver

(

const ConversationObserverPtr &

observer

)

Remove a conversation observer

Definition at line 364 of file conversation.cpp.

{
    boost::unique_lock<boost::mutex> lock(mObserverMutex);
    ConversationObserverList::iterator it = std::find(mObservers.begin(), mObservers.end(), observer);
    if(it != mObservers.end())
    {
        mObservers.erase(it);
    }
}

setConversationId()

void fipa::acl::ConversationObservable::setConversationId ( const fipa::acl::ConversationID &  conversationId )

inline

Set conversation id

Definition at line 182 of file conversation.h.

{ mConversationId = conversationId; }

Member Data Documentation

mConversationId

fipa::acl::ConversationID fipa::acl::ConversationObservable::mConversationId

protected

(Conversation) identifier of the conversation observable

Definition at line 231 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