hazelcast::client::iexecutor_service Class Reference

Distributed implementation of java.util.concurrent.ExecutorService. More...

#include <iexecutor_service.h>

Inheritance diagram for hazelcast::client::iexecutor_service:

Classes
class	executor_promise

Public Member Functions
template<typename HazelcastSerializable>
void	execute (const HazelcastSerializable &command)
	Executes the given command at some time in the future.
template<typename HazelcastSerializable>
void	execute (const HazelcastSerializable &command, const member_selector &member_selector)
	Executes a task on a randomly selected member.
template<typename HazelcastSerializable, typename K>
void	execute_on_key_owner (const HazelcastSerializable &command, const K &key)
	Executes a task on the owner of the specified key.
template<typename HazelcastSerializable>
void	execute_on_member (const HazelcastSerializable &command, const member &member)
	Executes a task on the specified member.
template<typename HazelcastSerializable>
void	execute_on_members (const HazelcastSerializable &command, const std::vector< member > &members)
	Executes a task on each of the specified members.
template<typename HazelcastSerializable>
void	execute_on_members (const HazelcastSerializable &command, const member_selector &member_selector)
	Executes a task on each of the selected members.
template<typename HazelcastSerializable>
void	execute_on_all_members (const HazelcastSerializable &command)
	Executes a task on all of the known cluster members.
template<typename HazelcastSerializable, typename T, typename K>
executor_promise< T >	submit_to_key_owner (const HazelcastSerializable &task, const K &key)
	Submits a task to the owner of the specified key and returns a executor_promise representing that task.
template<typename HazelcastSerializable, typename T>
executor_promise< T >	submit_to_member (const HazelcastSerializable &task, const member &member)
	Submits a task to the specified member and returns a executor_promise representing that task.
template<typename HazelcastSerializable, typename T>
std::unordered_map< member, executor_promise< T > >	submit_to_members (const HazelcastSerializable &task, const std::vector< member > &members)
	Submits a task to given members and returns map of Member-executor_promise pairs representing pending completion of the task on each member.
template<typename HazelcastSerializable, typename T>
std::unordered_map< member, executor_promise< T > >	submit_to_members (const HazelcastSerializable &task, const member_selector &member_selector)
	Submits a task to selected members and returns a map of Member-executor_promise pairs representing pending completion of the task on each member.
template<typename HazelcastSerializable, typename T>
std::unordered_map< member, executor_promise< T > >	submit_to_all_members (const HazelcastSerializable &task)
	Submits task to all cluster members and returns a map of Member-executor_promise pairs representing pending completion of the task on each member.
template<typename HazelcastSerializable, typename T>
executor_promise< T >	submit (const HazelcastSerializable &task)
	Submits a task for execution and returns a executor_promise representing that task.
template<typename HazelcastSerializable, typename T>
executor_promise< T >	submit (const HazelcastSerializable &task, const member_selector &member_selector)
	Submits a task to a randomly selected member and returns a executor_promise representing that task.
void	shutdown ()
	Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted.
boost::future< bool >	is_shutdown ()
	Returns true if this executor has been shut down.
boost::future< bool >	is_terminated ()
	Returns true if all tasks have completed following shut down.

Static Public Attributes
static constexpr const char *	SERVICE_NAME = "hz:impl:executorService"

Friends
class	spi::ProxyManager

Detailed Description

Distributed implementation of java.util.concurrent.ExecutorService.

IExecutorService provides additional methods like executing tasks on a specific member, on a member who is owner of a specific key, executing a tasks on multiple members.

Definition at line 50 of file iexecutor_service.h.

Member Function Documentation

execute() [1/2]

template<typename HazelcastSerializable>

void hazelcast::client::iexecutor_service::execute ( const HazelcastSerializable & command )

inline

Executes the given command at some time in the future.

The command may execute in a new thread, in a pooled thread, or in the calling thread, at the discretion of the Executor implementation.

Parameters

command

the runnable task

Exceptions

rejected_execution

if this task cannot be accepted for execution

Definition at line 151 of file iexecutor_service.h.

    {
        submit<HazelcastSerializable, executor_marker>(command);
    }

execute() [2/2]

template<typename HazelcastSerializable>

void hazelcast::client::iexecutor_service::execute ( const HazelcastSerializable & command, const member_selector & member_selector )

inline

Executes a task on a randomly selected member.

Parameters

command	the task that is executed on a randomly selected member
memberSelector	memberSelector

Exceptions

rejected_execution

if no member is selected

Definition at line 165 of file iexecutor_service.h.

    {
        std::vector<member> members = select_members(member_selector);
        int selectedMember = rand() % (int)members.size();
        execute_on_member<HazelcastSerializable>(command,
                                                 members[selectedMember]);
    }

execute_on_all_members()

template<typename HazelcastSerializable>

void hazelcast::client::iexecutor_service::execute_on_all_members ( const HazelcastSerializable & command )

inline

Executes a task on all of the known cluster members.

Parameters

command

a task executed on all of the known cluster members

Definition at line 240 of file iexecutor_service.h.

    {
        std::vector<member> memberList =
          get_context().get_client_cluster_service().get_member_list();
        for (std::vector<member>::const_iterator it = memberList.begin();
             it != memberList.end();
             ++it) {
            submit_to_member<HazelcastSerializable, executor_marker>(command,
                                                                     *it);
        }
    }

execute_on_key_owner()

template<typename HazelcastSerializable, typename K>

void hazelcast::client::iexecutor_service::execute_on_key_owner ( const HazelcastSerializable & command, const K & key )

inline

Executes a task on the owner of the specified key.

Parameters

command	a task executed on the owner of the specified key
key	the specified key

Definition at line 181 of file iexecutor_service.h.

    {
        submit_to_key_owner<HazelcastSerializable, K>(command, key);
    }

execute_on_member()

template<typename HazelcastSerializable>

void hazelcast::client::iexecutor_service::execute_on_member ( const HazelcastSerializable & command, const member & member )

inline

Executes a task on the specified member.

Parameters

command	the task executed on the specified member
member	the specified member

Definition at line 194 of file iexecutor_service.h.

    {
        submit_to_member<HazelcastSerializable, executor_marker>(command,
                                                                 member);
    }

execute_on_members() [1/2]

template<typename HazelcastSerializable>

void hazelcast::client::iexecutor_service::execute_on_members ( const HazelcastSerializable & command, const member_selector & member_selector )

inline

Executes a task on each of the selected members.

Parameters

command	a task executed on each of the selected members
memberSelector	memberSelector

Exceptions

rejected_execution

if no member is selected

Definition at line 227 of file iexecutor_service.h.

    {
        std::vector<member> members = select_members(member_selector);
        execute_on_members<HazelcastSerializable>(command, members);
    }

execute_on_members() [2/2]

template<typename HazelcastSerializable>

void hazelcast::client::iexecutor_service::execute_on_members ( const HazelcastSerializable & command, const std::vector< member > & members )

inline

Executes a task on each of the specified members.

Parameters

command	the task executed on the specified members
members	the specified members

Definition at line 208 of file iexecutor_service.h.

    {
        for (std::vector<member>::const_iterator it = members.begin();
             it != members.end();
             ++it) {
            submit_to_member<HazelcastSerializable, executor_marker>(command,
                                                                     *it);
        }
    }

is_shutdown()

boost::future< bool > hazelcast::client::iexecutor_service::is_shutdown

(

)

Returns true if this executor has been shut down.

Returns

true if this executor has been shut down

Definition at line 941 of file client_impl.cpp.

{
    auto request =
      protocol::codec::executorservice_isshutdown_encode(get_name());
    return invoke_and_get_future<bool>(request);
}

is_terminated()

boost::future< bool > hazelcast::client::iexecutor_service::is_terminated

(

)

Returns true if all tasks have completed following shut down.

Note that isTerminated is never true unless either shutdown.

Returns

true if all tasks have completed following shut down

Definition at line 949 of file client_impl.cpp.

{
    return is_shutdown();
}

shutdown()

void hazelcast::client::iexecutor_service::shutdown

(

)

Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted.

Invocation has no additional effect if already shut down.

This method does not wait for previously submitted tasks to complete execution.

Definition at line 934 of file client_impl.cpp.

{
    auto request = protocol::codec::executorservice_shutdown_encode(get_name());
    invoke(request);
}

submit() [1/2]

template<typename HazelcastSerializable, typename T>

executor_promise< T > hazelcast::client::iexecutor_service::submit ( const HazelcastSerializable & task )

inline

Submits a task for execution and returns a executor_promise representing that task.

The executor_promise's
executor_promise::get method will return the given result upon successful completion.

Parameters

task	the task to submit
result	the result to return
<T>	the type of the result

Returns

a executor_promise representing pending completion of the task

Exceptions

rejected_execution	if the task cannot be scheduled for execution
null_pointer	if the task is null

Definition at line 373 of file iexecutor_service.h.

    {
        serialization::pimpl::data task_data =
          to_data<HazelcastSerializable>(task);
 
        if (task_data.has_partition_hash()) {
            int partitionId = get_partition_id(task_data);
 
            return submit_to_partition_internal<T>(
              task_data, false, partitionId);
        } else {
            return submit_to_random_internal<T>(task_data, false);
        }
    }

submit() [2/2]

template<typename HazelcastSerializable, typename T>

executor_promise< T > hazelcast::client::iexecutor_service::submit ( const HazelcastSerializable & task, const member_selector & member_selector )

inline

Submits a task to a randomly selected member and returns a executor_promise representing that task.

Parameters

task	task submitted to a randomly selected member
memberSelector	memberSelector
<T>	the result type of callable

Returns

a executor_promise representing pending completion of the task

Exceptions

rejected_execution

if no member is selected

Definition at line 399 of file iexecutor_service.h.

    {
        std::vector<member> members = select_members(member_selector);
        int selectedMember = rand() % (int)members.size();
        return submit_to_member<HazelcastSerializable, T>(
          task, members[selectedMember]);
    }

submit_to_all_members()

template<typename HazelcastSerializable, typename T>

std::unordered_map< member, executor_promise< T > > hazelcast::client::iexecutor_service::submit_to_all_members ( const HazelcastSerializable & task )

inline

Submits task to all cluster members and returns a map of Member-executor_promise pairs representing pending completion of the task on each member.

Parameters

task	the task submitted to all cluster members
<T>	the result type of callable

Returns

map of Member-executor_promise pairs representing pending completion of the task on each member

Definition at line 344 of file iexecutor_service.h.

    {
        std::unordered_map<member, executor_promise<T>> futureMap;
        for (const auto& m :
             get_context().get_client_cluster_service().get_member_list()) {
            auto f = submit_to_target_internal<HazelcastSerializable, T>(
              task, m, true);
            // no need to check if emplace is success since member is unique
            futureMap.emplace(m, std::move(f));
        }
        return futureMap;
    }

submit_to_key_owner()

template<typename HazelcastSerializable, typename T, typename K>

executor_promise< T > hazelcast::client::iexecutor_service::submit_to_key_owner ( const HazelcastSerializable & task, const K & key )

inline

Submits a task to the owner of the specified key and returns a executor_promise representing that task.

Parameters

task	task submitted to the owner of the specified key
key	the specified key
<T>	the result type of callable

Returns

a executor_promise representing pending completion of the task

Definition at line 262 of file iexecutor_service.h.

    {
        return submit_to_key_owner_internal<HazelcastSerializable, T, K>(
          task, key, false);
    }

submit_to_member()

template<typename HazelcastSerializable, typename T>

executor_promise< T > hazelcast::client::iexecutor_service::submit_to_member ( const HazelcastSerializable & task, const member & member )

inline

Submits a task to the specified member and returns a executor_promise representing that task.

Parameters

task	the task submitted to the specified member
member	the specified member
<T>	the result type of callable

Returns

a executor_promise representing pending completion of the task

Definition at line 279 of file iexecutor_service.h.

    {
        return submit_to_target_internal<HazelcastSerializable, T>(
          task, member, false);
    }

submit_to_members() [1/2]

template<typename HazelcastSerializable, typename T>

std::unordered_map< member, executor_promise< T > > hazelcast::client::iexecutor_service::submit_to_members ( const HazelcastSerializable & task, const member_selector & member_selector )

inline

Submits a task to selected members and returns a map of Member-executor_promise pairs representing pending completion of the task on each member.

Parameters

task	the task submitted to selected members
memberSelector	memberSelector
<T>	the result type of callable

Returns

map of Member-executor_promise pairs representing pending completion of the task on each member

Exceptions

rejected_execution

if no member is selected

Definition at line 325 of file iexecutor_service.h.

    {
        std::vector<member> members = select_members(member_selector);
        return submit_to_members<HazelcastSerializable, T>(task, members);
    }

submit_to_members() [2/2]

template<typename HazelcastSerializable, typename T>

std::unordered_map< member, executor_promise< T > > hazelcast::client::iexecutor_service::submit_to_members ( const HazelcastSerializable & task, const std::vector< member > & members )

inline

Submits a task to given members and returns map of Member-executor_promise pairs representing pending completion of the task on each member.

Parameters

task	the task submitted to given members
members	the given members
<T>	the result type of callable

Returns

map of Member-executor_promise pairs representing pending completion of the task on each member

Definition at line 298 of file iexecutor_service.h.

    {
        std::unordered_map<member, executor_promise<T>> futureMap;
        for (auto& member : members) {
            auto f = submit_to_target_internal<HazelcastSerializable, T>(
              task, member, true);
            // no need to check if emplace is success since member is unique
            futureMap.emplace(member, std::move(f));
        }
        return futureMap;
    }

Friends And Related Symbol Documentation

spi::ProxyManager

friend class spi::ProxyManager

friend

Definition at line 52 of file iexecutor_service.h.

Member Data Documentation

SERVICE_NAME

const char* hazelcast::client::iexecutor_service::SERVICE_NAME = "hz:impl:executorService"

staticconstexpr

Definition at line 55 of file iexecutor_service.h.

---

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

• hazelcast/include/hazelcast/client/iexecutor_service.h
• hazelcast/src/hazelcast/client/client_impl.cpp