Cluster (ScaleCube/Cluster 1.0.5 API)

```
public interface Cluster
```
Facade cluster interface which provides API to interact with cluster members.

Author:

Anton Kharenko

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Address`	`address()` Returns local listen `Address` of this cluster instance.
`static CompletableFuture<Cluster>`	`join()` Init cluster instance and join cluster asynchronously.
`static CompletableFuture<Cluster>`	`join(Address... seedMembers)` Init cluster instance with the given seed members and join cluster asynchronously.
`static CompletableFuture<Cluster>`	`join(ClusterConfig config)` Init cluster instance with the given configuration and join cluster synchronously.
`static CompletableFuture<Cluster>`	`join(Map<String,String> metadata, Address... seedMembers)` Init cluster instance with the given metadata and seed members and join cluster synchronously.
`static Cluster`	`joinAwait()` Init cluster instance and join cluster synchronously.
`static Cluster`	`joinAwait(Address... seedMembers)` Init cluster instance with the given seed members and join cluster synchronously.
`static Cluster`	`joinAwait(ClusterConfig config)` Init cluster instance with the given configuration and join cluster synchronously.
`static Cluster`	`joinAwait(Map<String,String> metadata, Address... seedMembers)` Init cluster instance with the given metadata and seed members and join cluster synchronously.
`rx.Observable<Message>`	`listen()`
`rx.Observable<Message>`	`listenGossips()` Listens for gossips from other cluster members.
`rx.Observable<MembershipEvent>`	`listenMembership()` Listen changes in cluster membership.
`Member`	`member()` Returns local cluster member which corresponds to this cluster instance.
`Optional<Member>`	`member(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.
`NetworkEmulator`	`networkEmulator()` Returns network emulator associated with this instance of cluster.
`Collection<Member>`	`otherMembers()` Returns list of all cluster members of the joined cluster excluding local member.
`void`	`send(Address address, Message message)`
`void`	`send(Address address, Message message, CompletableFuture<Void> promise)`
`void`	`send(Member member, Message message)`
`void`	`send(Member member, Message message, CompletableFuture<Void> promise)`
`CompletableFuture<Void>`	`shutdown()` Member notifies other members of the cluster about leaving and gracefully shutdown and free occupied resources.
`void`	`spreadGossip(Message message)` Spreads given message between cluster members using gossiping protocol.
`void`	`updateMetadata(Map<String,String> metadata)` Updates local member metadata with the given metadata map.
`void`	`updateMetadataProperty(String key, String value)` Updates single key-value pair of local member's metadata.

- Method Detail
  - joinAwait
```
static Cluster joinAwait()
```
    Init cluster instance and join cluster synchronously.
  - joinAwait
```
static Cluster joinAwait(Address... seedMembers)
```
    Init cluster instance with the given seed members and join cluster synchronously.
  - joinAwait
```
static Cluster joinAwait(Map<String,String> metadata,
                         Address... seedMembers)
```
    Init cluster instance with the given metadata and seed members and join cluster synchronously.
  - joinAwait
```
static Cluster joinAwait(ClusterConfig config)
```
    Init cluster instance with the given configuration and join cluster synchronously.
  - join
```
static CompletableFuture<Cluster> join()
```
    Init cluster instance and join cluster asynchronously.
  - join
```
static CompletableFuture<Cluster> join(Address... seedMembers)
```
    Init cluster instance with the given seed members and join cluster asynchronously.
  - join
```
static CompletableFuture<Cluster> join(Map<String,String> metadata,
                                       Address... seedMembers)
```
    Init cluster instance with the given metadata and seed members and join cluster synchronously.
  - join
```
static CompletableFuture<Cluster> join(ClusterConfig config)
```
    Init cluster instance with the given configuration and join cluster synchronously.
  - address
```
Address address()
```
    Returns local listen Address of this cluster instance.
  - send
```
void send(Member member,
          Message message)
```
  - send
```
void send(Member member,
          Message message,
          CompletableFuture<Void> promise)
```
  - send
```
void send(Address address,
          Message message)
```
  - send
```
void send(Address address,
          Message message,
          CompletableFuture<Void> promise)
```
  - listen
```
rx.Observable<Message> listen()
```
  - spreadGossip
```
void spreadGossip(Message message)
```
    Spreads given message between cluster members using gossiping protocol.
  - listenGossips
```
rx.Observable<Message> listenGossips()
```
    Listens for gossips from other cluster members.
  - member
```
Member member()
```
    Returns local cluster member which corresponds to this cluster instance.
  - member
```
Optional<Member> member(String id)
```
    Returns cluster member with given id or null if no member with such id exists at joined cluster.
  - member
```
Optional<Member> member(Address address)
```
    Returns cluster member by given address or null if no member with such address exists at joined cluster.
  - members
```
Collection<Member> members()
```
    Returns list of all members of the joined cluster. This will include all cluster members including local member.
  - otherMembers
```
Collection<Member> otherMembers()
```
    Returns list of all cluster members of the joined cluster excluding local member.
  - updateMetadata
```
void updateMetadata(Map<String,String> 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
  - updateMetadataProperty
```
void updateMetadataProperty(String key,
                            String value)
```
    Updates single key-value pair of local member's metadata. This is a shortcut method and anyway update will result in a full metadata update. In case if you need to update several metadata property together it is recommended to use updateMetadata(Map).
    
    Parameters:
    
    key - metadata key to update
    
    value - metadata value to update
  - listenMembership
```
rx.Observable<MembershipEvent> listenMembership()
```
    Listen changes in cluster membership.
  - shutdown
```
CompletableFuture<Void> shutdown()
```
    Member notifies other members of the cluster about leaving and gracefully shutdown and free occupied resources.
    
    Returns:
    
    Listenable future which is completed once graceful shutdown is finished.
  - networkEmulator
```
@Nonnull
NetworkEmulator networkEmulator()
```
    Returns network emulator associated with this instance of cluster. It always returns non null instance even if network emulator is disabled by transport config. In case when network emulator is disable all calls to network emulator instance will result in no operation.

Interface Cluster

Method Summary

Method Detail

joinAwait

joinAwait

joinAwait

joinAwait

join

join

join

join

address

send

send

send

send

listen

spreadGossip

listenGossips

member

member

member

members

otherMembers

updateMetadata

updateMetadataProperty

listenMembership

shutdown

networkEmulator