Library: Net
Package: Sockets
Header: Poco/Net/PollSet.h
Description
A set of sockets that can be efficiently polled as a whole.
If supported, PollSet is implemented using epoll (Linux) or poll (BSD) APIs. A fallback implementation using select() is also provided.
Member Summary
Member Functions: add, clear, count, empty, has, poll, remove, size, update, wakeUp
Types Aliases
SocketModeMap
using SocketModeMap = std::map < Poco::Net::Socket, int >;
Enumerations
Mode
POLL_READ = Socket::SELECT_READ
POLL_WRITE = Socket::SELECT_WRITE
POLL_ERROR = Socket::SELECT_ERROR
Constructors
PollSet
PollSet();
Creates an empty PollSet.
Destructor
~PollSet
~PollSet();
Destroys the PollSet.
Member Functions
add
void add(
const Poco::Net::Socket & socket,
int mode
);
Adds the given socket to the set, for polling with the given mode, which can be an OR'd combination of POLL_READ, POLL_WRITE and POLL_ERROR. Subsequent socket additions to the PollSet are mode-cumulative, so the following code:
StreamSocket ss; PollSet ps; ps.add(ss, PollSet::POLL_READ); ps.add(ss, PollSet::POLL_WRITE);
shall result in the socket being monitored for read and write, equivalent to this:
ps.update(ss, PollSet::POLL_READ | PollSet::POLL_WRITE);
clear
void clear();
Removes all sockets from the PollSet.
count
int count() const;
Deprecated. This function is deprecated and should no longer be used.
Returns the number of sockets monitored. This method is deprecated. Use size() instead.
empty
bool empty() const;
Returns true if no socket is registered for polling.
has
bool has(
const Socket & socket
) const;
Returns true if socket is registered for polling.
poll
SocketModeMap poll(
const Poco::Timespan & timeout
);
Waits until the state of at least one of the PollSet's sockets changes accordingly to its mode, or the timeout expires. Returns a PollMap containing the sockets that have had their state changed.
remove
void remove(
const Poco::Net::Socket & socket
);
Removes the given socket from the set.
size
std::size_t size() const;
Returns the number of sockets monitored.
update
void update(
const Poco::Net::Socket & socket,
int mode
);
Updates the mode of the given socket. If socket does not exist in the PollSet, it is silently added. For an existing socket, any prior mode is overwritten. Updating socket is non-mode-cumulative.
The following code:
StreamSocket ss; PollSet ps; ps.update(ss, PollSet::POLL_READ); ps.update(ss, PollSet::POLL_WRITE);
shall result in the socket being monitored for write only.
wakeUp
void wakeUp();