#include <coherence/net/MemberEvent.hpp>
Inherits Event.
A MemberEvent object is sent as an argument to the MemberListener interface methods.
Public Types | |
typedef spec::Handle | Handle |
MemberEvent Handle definition. | |
typedef spec::View | View |
MemberEvent View definition. | |
typedef spec::Holder | Holder |
MemberEvent Holder definition. | |
typedef TypedHandle < Service > | ServiceHandle |
Service Handle definition. | |
typedef TypedHandle < const Service > | ServiceView |
Service View definition. | |
Public Member Functions | |
virtual void | dispatch (Listeners::View vListeners) const |
Dispatch this event to the specified listeners collection. | |
virtual bool | isLocal () const |
Check whether a Member object for this event represents the local member of the cluster. | |
virtual TypedHandle < const String > | toString () const |
Output a human-readable description of this Object to the given stream. Note that when overriding this method the return type must be TypedHandle<const String> rather then String::View. These two types are assignment compatible but not equivalent and declaring the override with String::View will not be a compatible override. coherence::lang::operator<<(std::ostream, Object::View) is defined and will call into the toString method, to output Objects. If a managed String object is desired, the COH_TO_STRING macro can be used to build up a String from streamable contents and is generally how toString() will be implemented.
Object::View vKey = ... Object::View vValue = ... std::cout << vKey << " = " << vValue << std::endl; String::View vs = COH_TO_STRING(vKey << " = " << vValue); The COH_TO_STRING macro is also the most common way to implement the toString method. For example:
virtual TypedHandle<const String> Person::toString() const { return COH_TO_STRING("Name: " << f_sName << " SSN: " << f_nSSN); }
| |
virtual Id | getId () const |
Return this event's ID. | |
virtual ServiceView | getService () const |
Return the Service that fired the event. | |
virtual Member::View | getMember () const |
Return the Member associated with this event. | |
Protected Member Functions | |
MemberEvent (ServiceView vService, Id identity, Member::View vMember) | |
Create a new MemberEvent instance. | |
Protected Attributes | |
Id | m_id |
The event's ID. | |
FinalView< Member > | f_vMember |
The Member associated with this event. |
MemberEvent | ( | ServiceView | vService, | |
Id | identity, | |||
Member::View | vMember | |||
) | [protected] |
Create a new MemberEvent instance.
vService | the Service that fired the event | |
identity | the event's ID, one of the Id enum values | |
vMember | the Member associated with the new MemberEvent |
virtual void dispatch | ( | Listeners::View | vListeners | ) | const [virtual] |
Dispatch this event to the specified listeners collection.
vListeners | the listeners collection |
ClassCastException | if any of the targets is not an instance of the MemberListener interface |
virtual bool isLocal | ( | ) | const [virtual] |
virtual Id getId | ( | ) | const [virtual] |
Return this event's ID.
virtual ServiceView getService | ( | ) | const [virtual] |
virtual Member::View getMember | ( | ) | const [virtual] |