hazelcast::client::entry_listener Class Reference

Map entry listener to get notified when a map entry is added, removed, updated, evicted, or expired. More...

#include <entry_listener.h>

Public Member Functions
template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>
entry_listener &	on_added (Handler &&h) &
	Set an handler function to be invoked when an entry is added. More...
template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>
entry_listener &&	on_added (Handler &&h) &&
	Set an handler function to be invoked when an entry is added. More...
template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>
entry_listener &	on_removed (Handler &&h) &
	Set an handler function to be invoked when an entry is removed. More...
template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>
entry_listener &&	on_removed (Handler &&h) &&
	Set an handler function to be invoked when an entry is removed. More...
template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>
entry_listener &	on_updated (Handler &&h) &
	Set an handler function to be invoked when an entry is updated. More...
template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>
entry_listener &&	on_updated (Handler &&h) &&
	Set an handler function to be invoked when an entry is updated. More...
template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>
entry_listener &	on_evicted (Handler &&h) &
	Set an handler function to be invoked when an entry is evicted. More...
template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>
entry_listener &&	on_evicted (Handler &&h) &&
	Set an handler function to be invoked when an entry is evicted. More...
template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>
entry_listener &	on_expired (Handler &&h) &
	Set an handler function to be invoked when an entry is expired. More...
template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>
entry_listener &&	on_expired (Handler &&h) &&
	Set an handler function to be invoked when an entry is expired. More...
template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>
entry_listener &	on_merged (Handler &&h) &
	Set an handler function to be invoked after a WAN replicated entry is merged. More...
template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>
entry_listener &&	on_merged (Handler &&h) &&
	Set an handler function to be invoked after a WAN replicated entry is merged. More...
template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>
entry_listener &	on_map_evicted (Handler &&h) &
	Set an handler function to be invoked when all entries are evicted by imap::evict_all. More...
template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>
entry_listener &&	on_map_evicted (Handler &&h) &&
	Set an handler function to be invoked when all entries are evicted by imap::evict_all. More...
template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>
entry_listener &	on_map_cleared (Handler &&h) &
	Set an handler function to be invoked when all entries are removed by imap::clear. More...
template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>
entry_listener &&	on_map_cleared (Handler &&h) &&
	Set an handler function to be invoked when all entries are removed by imap::clear. More...

Friends
template<typename >
class	impl::EntryEventHandler
class	replicated_map
class	imap

Detailed Description

Map entry listener to get notified when a map entry is added, removed, updated, evicted, or expired.

Events will fire as a result of operations carried out via the IMap.

Warning

1 - If listener should do a time consuming operation, off-load the operation to another thread. otherwise it will slow down the system.

2 - Do not make a call to hazelcast. It can cause deadlock.

See also

imap::add_entry_listener

Member Function Documentation

on_added() [1/2]

template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>

entry_listener& hazelcast::client::entry_listener::on_added ( Handler &&  h ) &

inline

Set an handler function to be invoked when an entry is added.

Parameters

h	a void function object that is callable with a single parameter of type EntryEvent &&

Returns

*this

on_added() [2/2]

template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>

entry_listener&& hazelcast::client::entry_listener::on_added ( Handler &&  h ) &&

inline

Set an handler function to be invoked when an entry is added.

Parameters

h	a void function object that is callable with a single parameter of type EntryEvent &&

Returns

*this

on_evicted() [1/2]

template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>

entry_listener& hazelcast::client::entry_listener::on_evicted ( Handler &&  h ) &

inline

Set an handler function to be invoked when an entry is evicted.

Parameters

h	a void function object that is callable with a single parameter of type EntryEvent &&

Returns

*this

on_evicted() [2/2]

template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>

entry_listener&& hazelcast::client::entry_listener::on_evicted ( Handler &&  h ) &&

inline

Set an handler function to be invoked when an entry is evicted.

Parameters

h	a void function object that is callable with a single parameter of type EntryEvent &&

Returns

*this

on_expired() [1/2]

template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>

entry_listener& hazelcast::client::entry_listener::on_expired ( Handler &&  h ) &

inline

Set an handler function to be invoked when an entry is expired.

Parameters

h	a void function object that is callable with a single parameter of type EntryEvent &&

Returns

*this

on_expired() [2/2]

template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>

entry_listener&& hazelcast::client::entry_listener::on_expired ( Handler &&  h ) &&

inline

Set an handler function to be invoked when an entry is expired.

Parameters

h	a void function object that is callable with a single parameter of type EntryEvent &&

Returns

*this

on_map_cleared() [1/2]

template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>

entry_listener& hazelcast::client::entry_listener::on_map_cleared ( Handler &&  h ) &

inline

Set an handler function to be invoked when all entries are removed by imap::clear.

Parameters

h	a void function object that is callable with a single parameter of type map_event &&

Returns

*this

on_map_cleared() [2/2]

template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>

entry_listener&& hazelcast::client::entry_listener::on_map_cleared ( Handler &&  h ) &&

inline

Set an handler function to be invoked when all entries are removed by imap::clear.

Parameters

h	a void function object that is callable with a single parameter of type map_event &&

Returns

*this

on_map_evicted() [1/2]

template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>

entry_listener& hazelcast::client::entry_listener::on_map_evicted ( Handler &&  h ) &

inline

Set an handler function to be invoked when all entries are evicted by imap::evict_all.

Parameters

h	a void function object that is callable with a single parameter of type MapEvent &&

Returns

*this

on_map_evicted() [2/2]

template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>

entry_listener&& hazelcast::client::entry_listener::on_map_evicted ( Handler &&  h ) &&

inline

Set an handler function to be invoked when all entries are evicted by imap::evict_all.

Parameters

h	a void function object that is callable with a single parameter of type MapEvent &&

Returns

*this

on_merged() [1/2]

template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>

entry_listener& hazelcast::client::entry_listener::on_merged ( Handler &&  h ) &

inline

Set an handler function to be invoked after a WAN replicated entry is merged.

Parameters

h	a void function object that is callable with a single parameter of type EntryEvent &&

Returns

*this

on_merged() [2/2]

template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>

entry_listener&& hazelcast::client::entry_listener::on_merged ( Handler &&  h ) &&

inline

Set an handler function to be invoked after a WAN replicated entry is merged.

Parameters

h	a void function object that is callable with a single parameter of type EntryEvent &&

Returns

*this

on_removed() [1/2]

template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>

entry_listener& hazelcast::client::entry_listener::on_removed ( Handler &&  h ) &

inline

Set an handler function to be invoked when an entry is removed.

Parameters

h	a void function object that is callable with a single parameter of type EntryEvent &&

Returns

*this

on_removed() [2/2]

template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>

entry_listener&& hazelcast::client::entry_listener::on_removed ( Handler &&  h ) &&

inline

Set an handler function to be invoked when an entry is removed.

Parameters

h	a void function object that is callable with a single parameter of type EntryEvent &&

Returns

*this

on_updated() [1/2]

template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>

entry_listener& hazelcast::client::entry_listener::on_updated ( Handler &&  h ) &

inline

Set an handler function to be invoked when an entry is updated.

Parameters

h	a void function object that is callable with a single parameter of type EntryEvent &&

Returns

*this

on_updated() [2/2]

template<typename Handler , typename = util::enable_if_rvalue_ref_t<Handler &&>>

entry_listener&& hazelcast::client::entry_listener::on_updated ( Handler &&  h ) &&

inline

Set an handler function to be invoked when an entry is updated.

Parameters

h	a void function object that is callable with a single parameter of type EntryEvent &&

Returns

*this

---

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

• hazelcast/include/hazelcast/client/entry_listener.h