Oracle Coherence for C++ API


Event Class Reference

#include <coherence/util/Event.hpp>

Inherits Object.

Inherited by MemberEvent, and ServiceEvent.

List of all members.

Detailed Description

The root class from which all event state classes shall be derived.

All Events are constructed with a reference to the object, the "source", that is logically deemed to be the object upon which the Event in question initially occurred.

jh 2007.12.12

Public Types

typedef spec::Handle Handle
 Event Handle definition.
typedef spec::View View
 Event View definition.
typedef spec::Holder Holder
 Event Holder definition.

Public Member Functions

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);

out the stream used to output the description

virtual Object::View getSource () const
 Return the object on which the Event initially occurred.

Protected Member Functions

 Event (Object::View vSource)
 Create a new Event instance.

Protected Attributes

FinalView< Objectm_vSource
 The object on which the Event initially occurred.

Constructor & Destructor Documentation

Event ( Object::View  vSource  )  [protected]

Create a new Event instance.

vSource the source associated with the new Event
a new Event

Member Function Documentation

virtual Object::View getSource (  )  const [virtual]

Return the object on which the Event initially occurred.

the object on which the Event initially occurred

The documentation for this class was generated from the following file:
Copyright © 2000, 2011, Oracle and/or its affiliates. All rights reserved.