org.zeromq.api

Interface Poller

All Known Implementing Classes:

PollerImpl

public interface Poller

Poller for polling sockets and receiving callbacks for events.

Method Summary

Modifier and Type	Method and Description
boolean	disable(SelectableChannel channel) Disable a channel in the poller, preventing it from waking up the thread when messages are received on it.
boolean	disable(Socket socket) Disable a socket in the poller, preventing it from waking up the thread when messages are received on it.
int	enable(SelectableChannel channel) Enable a channel in the poller after it has been disabled.
int	enable(Socket socket) Enable a socket in the poller after it has been disabled.
void	poll() Poll a socket indefinitely.
void	poll(long timeoutMillis) Poll a socket for a given amount of time.
int	register(Pollable pollable, PollListener listener) Register a new poll item.
boolean	unregister(SelectableChannel channel) Unregister a channel from the poller.
boolean	unregister(Socket socket) Unregister a socket from the poller.

Method Detail

poll

void poll()

Poll a socket indefinitely.

poll

void poll(long timeoutMillis)

Poll a socket for a given amount of time.

Parameters:

timeoutMillis - The number of milliseconds to wait before returning

enable

int enable(Socket socket)

Enable a socket in the poller after it has been disabled.

Parameters:

socket - The socket registered with the poller to be enabled

Returns:

The new index of the socket in the poller, for reference

disable

boolean disable(Socket socket)

Disable a socket in the poller, preventing it from waking up the thread when messages are received on it.

Parameters:

socket - The socket registered with the poller to be disabled

Returns:

true if the socket was disabled, false otherwise

enable

int enable(SelectableChannel channel)

Enable a channel in the poller after it has been disabled.

Parameters:

channel - The channel registered with the poller to be enabled

Returns:

The new index of the socket in the poller, for reference

disable

boolean disable(SelectableChannel channel)

Disable a channel in the poller, preventing it from waking up the thread when messages are received on it.

Parameters:

channel - The channel registered with the poller to be disabled

Returns:

true if the socket was disabled, false otherwise

register

int register(Pollable pollable,
             PollListener listener)

Register a new poll item.

Parameters:

pollable - The pollable containing the socket and polling options

listener - The listener that handles events for the given pollable

Returns:

The new index of the socket in the poller, for reference

unregister

boolean unregister(Socket socket)

Unregister a socket from the poller.

Parameters:

socket - The socket registered with the poller to be unregistered

Returns:

true if the socket was unregistered, false otherwise

unregister

boolean unregister(SelectableChannel channel)

Unregister a channel from the poller.

Parameters:

channel - The channel registered with the poller to be unregistered

Returns:

true if the socket was disabled, false otherwise