io.scalecube.cluster

Interface Cluster

public interface Cluster

Facade cluster interface which provides API to interact with cluster members.

Method Summary

Modifier and Type	Method and Description
io.scalecube.net.Address	address() Returns Address of this cluster instance.
boolean	isShutdown() Check if cluster instance has been shut down.
Member	member() Returns local cluster member which corresponds to this cluster instance.
Optional<Member>	member(io.scalecube.net.Address address) Returns cluster member by given address or null if no member with such address exists at joined cluster.
Optional<Member>	member(String id) Returns cluster member with given id or null if no member with such id exists at joined cluster.
Collection<Member>	members() Returns list of all members of the joined cluster.
<T> Optional<T>	metadata() Returns local cluster member metadata.
<T> Optional<T>	metadata(Member member) Returns cluster member metadata by given member.
reactor.core.publisher.Mono<Void>	onShutdown() Returns promise which is completed when cluster instance has been shut down.
Collection<Member>	otherMembers() Returns list of all cluster members of the joined cluster excluding local member.
reactor.core.publisher.Mono<Message>	requestResponse(io.scalecube.net.Address address, Message request) Sends message to the given address.
reactor.core.publisher.Mono<Message>	requestResponse(Member member, Message request) Sends message to the given address.
reactor.core.publisher.Mono<Void>	send(io.scalecube.net.Address address, Message message) Send a msg from this member (src) to target member (specified in parameters).
reactor.core.publisher.Mono<Void>	send(Member member, Message message) Send a msg from this member (src) to target member (specified in parameters).
void	shutdown() Member notifies other members of the cluster about leaving and gracefully shutdown and free occupied resources.
reactor.core.publisher.Mono<String>	spreadGossip(Message message) Spreads given message between cluster members using gossiping protocol.
<T> reactor.core.publisher.Mono<Void>	updateMetadata(T metadata) Updates local member metadata with the given metadata map.

Method Detail

address

io.scalecube.net.Address address()

Returns Address of this cluster instance.

Returns:

cluster address

send

reactor.core.publisher.Mono<Void> send(Member member,
                                       Message message)

Send a msg from this member (src) to target member (specified in parameters).

Parameters:

member - target member

message - msg

Returns:

promise telling success or failure

send

reactor.core.publisher.Mono<Void> send(io.scalecube.net.Address address,
                                       Message message)

Send a msg from this member (src) to target member (specified in parameters).

Parameters:

address - target address

message - msg

Returns:

promise telling success or failure

requestResponse

reactor.core.publisher.Mono<Message> requestResponse(io.scalecube.net.Address address,
                                                     Message request)

Sends message to the given address. It will issue connect in case if no transport channel by given transport address exists already. Send is an async operation and expecting a response by a provided correlationId and sender address of the caller.

Parameters:

address - address where message will be sent

request - to send message must contain correlctionId and sender to handle reply.

Returns:

promise which will be completed with result of sending (message or exception)

Throws:

IllegalArgumentException - if message or address is null

requestResponse

reactor.core.publisher.Mono<Message> requestResponse(Member member,
                                                     Message request)

Sends message to the given address. It will issue connect in case if no transport channel by given transport address exists already. Send is an async operation and expecting a response by a provided correlationId and sender address of the caller.

Parameters:

member - where message will be sent

request - to send message must contain correlctionId and sender to handle reply.

Returns:

promise which will be completed with result of sending (message or exception)

Throws:

IllegalArgumentException - if message or address is null

spreadGossip

reactor.core.publisher.Mono<String> spreadGossip(Message message)

Spreads given message between cluster members using gossiping protocol.

Parameters:

message - message to disseminate.

Returns:

result future

metadata

<T> Optional<T> metadata()

Returns local cluster member metadata.

Returns:

local member metadata

metadata

<T> Optional<T> metadata(Member member)

Returns cluster member metadata by given member.

Parameters:

member - cluster member

Returns:

cluster member metadata

member

Member member()

Returns local cluster member which corresponds to this cluster instance.

Returns:

local member

member

Optional<Member> member(String id)

Returns cluster member with given id or null if no member with such id exists at joined cluster.

Returns:

member by id

member

Optional<Member> member(io.scalecube.net.Address address)

Returns cluster member by given address or null if no member with such address exists at joined cluster.

Returns:

member by address

members

Collection<Member> members()

Returns list of all members of the joined cluster. This will include all cluster members including local member.

Returns:

all members in the cluster (including local one)

otherMembers

Collection<Member> otherMembers()

Returns list of all cluster members of the joined cluster excluding local member.

Returns:

all members in the cluster (excluding local one)

updateMetadata

<T> reactor.core.publisher.Mono<Void> updateMetadata(T metadata)

Updates local member metadata with the given metadata map. Metadata is updated asynchronously and results in a membership update event for local member once it is updated locally. Information about new metadata is disseminated to other nodes of the cluster with a weekly-consistent guarantees.

Parameters:

metadata - new metadata

shutdown

void shutdown()

Member notifies other members of the cluster about leaving and gracefully shutdown and free occupied resources.

onShutdown

reactor.core.publisher.Mono<Void> onShutdown()

Returns promise which is completed when cluster instance has been shut down.

Returns:

promise which is completed once graceful shutdown is finished.

isShutdown

boolean isShutdown()

Check if cluster instance has been shut down.

Returns:

returns true if cluster instance has been shut down; false otherwise.