org.zeromq.api

Interface BinaryStarReactor

All Known Implementing Classes:

BinaryStarReactorImpl

public interface BinaryStarReactor

Reactor implementing the Binary Star pattern, used to construct HA-pairs that can forward messages to an application in an event-driven manner.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BinaryStarReactor.Event Events, which start with the states our peer can be in.
static class	BinaryStarReactor.Mode Startup modes.
static class	BinaryStarReactor.State States we can be in at any point in time.

Field Summary

Fields

Modifier and Type	Field and Description
static long	BSTAR_HEARTBEAT We send state information this often.

Method Summary

Modifier and Type	Method and Description
Reactor	getReactor() Get the underlying Reactor.
void	registerVoterSocket(Socket socket) Register a client voter socket.
void	setActiveHandler(LoopHandler handler) Register a handler to be called each time there's a state change.
void	setHeartbeatInterval(long heartbeatInterval) Set the heartbeat interval used to detect peer outage.
void	setPassiveHandler(LoopHandler handler) Register a handler to be called each time there's a state change.
void	setVoterHandler(LoopHandler handler) Register a voter handler to be called each time the application receives a message.
void	start() Start the underlying Reactor.
void	stop() Stop the underlying Reactor.

Field Detail

BSTAR_HEARTBEAT

static final long BSTAR_HEARTBEAT

We send state information this often. If peer doesn't respond in two heartbeats, it is 'dead'.

See Also:

Constant Field Values

Method Detail

start

void start()

Start the underlying Reactor.

stop

void stop()

Stop the underlying Reactor.

registerVoterSocket

void registerVoterSocket(Socket socket)

Register a client voter socket. Only one socket can be registered.

Parameters:

socket - The client socket

setVoterHandler

void setVoterHandler(LoopHandler handler)

Register a voter handler to be called each time the application receives a message.

Parameters:

handler - The handler for client events

setActiveHandler

void setActiveHandler(LoopHandler handler)

Register a handler to be called each time there's a state change.

Parameters:

handler - The handler for state change events

setPassiveHandler

void setPassiveHandler(LoopHandler handler)

Register a handler to be called each time there's a state change.

Parameters:

handler - The handler for state change events

getReactor

Reactor getReactor()

Get the underlying Reactor.

Returns:

The underlying Reactor

setHeartbeatInterval

void setHeartbeatInterval(long heartbeatInterval)

Set the heartbeat interval used to detect peer outage.

Parameters:

heartbeatInterval - The heartbeat interval, in milliseconds