Oracle Coherence for C++ API
Release 3.7.1.0

E22845-01

MemberEvent Class Reference

#include <coherence/net/MemberEvent.hpp>

Inherits Event.

List of all members.


Detailed Description

An event which indicates that membership has changed:.

A MemberEvent object is sent as an argument to the MemberListener interface methods.

See also:
MemberListener
Author:
jh 2007.12.20
 

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 void  toStream (std::ostream &out) const
  Output a human-readable description of this Object to the given stream.

coherence::lang::operator<<(std::ostream, Object::View) is defined and will call into the toStream 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.

 Object::View vKey   = ...
 Object::View vValue = ...
 std::cout << vKey << " = " << vValue << std::endl;

 String::Handle hs = COH_TO_STRING(vKey << " = " << vValue);
Parameters:
  out  the stream used to output the description
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 m_vMember
  The Member associated with this event.

Constructor & Destructor Documentation

MemberEvent ( ServiceView  vService,
    Id  identity,
    Member::View  vMember  
  )     [protected]

Create a new MemberEvent instance.

Parameters:
  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

Member Function Documentation

virtual void dispatch ( Listeners::View  vListeners  )  const [virtual]

Dispatch this event to the specified listeners collection.

Parameters:
  vListeners  the listeners collection
Exceptions:
  ClassCastException  if any of the targets is not an instance of the MemberListener interface

virtual bool isLocal (    )  const [virtual]

Check whether a Member object for this event represents the local member of the cluster.

Returns:
true iff the event's Member object represents the local cluster member

virtual Id getId (    )  const [virtual]

Return this event's ID.

Returns:
the event ID, one of the Id enum values

virtual ServiceView getService (    )  const [virtual]

Return the Service that fired the event.

Returns:
the Service

virtual Member::View getMember (    )  const [virtual]

Return the Member associated with this event.

Returns:
the Member

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

Copyright © 2000, 2011, Oracle and/or its affiliates. All rights reserved.