org.zeromq.api

Interface CloneClient

All Known Implementing Classes:

CloneClientImpl

public interface CloneClient

An API client implementing the CHP (Clustered Hashmap Protocol), which will communicate via an agent (background thread) with a pair of stateful servers using the Binary Star Pattern.

Method Summary

Modifier and Type	Method and Description
void	close() Destroy this client.
void	connect(String address, int port) Connect to a new server endpoint.
String	get(String key) Look up the value in the shared hashmap.
Map<String,String>	getAll() Look up all values in the shared hashmap.
void	set(String key, String value) Set a new value in the shared hashmap, with no ttl.
void	set(String key, String value, long ttl) Set a new value in the shared hashmap.
void	subscribe(String subtree) Specify subtree for snapshot and updates.

Method Detail

subscribe

void subscribe(String subtree)

Specify subtree for snapshot and updates.

Note: We must do this before connecting to a server as the subtree specification is sent as the first command to the server.

Parameters:

subtree - The prefix (subtree) to subscribe to

connect

void connect(String address,
             int port)

Connect to a new server endpoint. We can connect to at most two servers.

Parameters:

address - The address of the server to connect to

port - The port on the server to connect to

set

void set(String key,
         String value)

Set a new value in the shared hashmap, with no ttl.

Parameters:

key - The key associated with the new value

value - The new value to set in the shared hashmap

set

void set(String key,
         String value,
         long ttl)

Set a new value in the shared hashmap.

Parameters:

key - The key associated with the new value

value - The new value to set in the shared hashmap

ttl - The time-to-live for the given value, in seconds

get

String get(String key)

Look up the value in the shared hashmap.

Parameters:

key - The key to look up

Returns:

The value associated with the given key, or null

getAll

Map<String,String> getAll()

Look up all values in the shared hashmap.

Returns:

The entire map

close

void close()

Destroy this client.