Classes | Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
ros::PollSet Class Reference

Manages a set of sockets being polled through the poll() function call. More...

#include <poll_set.h>

Classes

struct  SocketInfo
 

Public Types

typedef boost::function< void(int)> SocketUpdateFunc
 

Public Member Functions

bool addEvents (int sock, int events)
 Add events to be polled on a socket. More...
 
bool addSocket (int sock, const SocketUpdateFunc &update_func, const TransportPtr &transport=TransportPtr())
 Add a socket. More...
 
bool delEvents (int sock, int events)
 Delete events to be polled on a socket. More...
 
bool delSocket (int sock)
 Delete a socket. More...
 
 PollSet ()
 
void signal ()
 Signal our poll() call to finish if it's blocked waiting (see the poll_timeout option for update()). More...
 
void update (int poll_timeout)
 Process all socket events. More...
 
 ~PollSet ()
 

Private Types

typedef std::map< int, SocketInfoM_SocketInfo
 
typedef std::vector< int > V_int
 

Private Member Functions

void createNativePollset ()
 Creates the native pollset for our sockets, if any have changed. More...
 
void onLocalPipeEvents (int events)
 Called when events have been triggered on our signal pipe. More...
 

Private Attributes

V_int just_deleted_
 
boost::mutex just_deleted_mutex_
 
boost::mutex signal_mutex_
 
signal_fd_t signal_pipe_ [2]
 
M_SocketInfo socket_info_
 
boost::mutex socket_info_mutex_
 
bool sockets_changed_
 
std::vector< socket_pollfdufds_
 

Detailed Description

Manages a set of sockets being polled through the poll() function call.

PollSet provides thread-safe ways of adding and deleting sockets, as well as adding and deleting events.

Definition at line 57 of file poll_set.h.

Member Typedef Documentation

typedef std::map<int, SocketInfo> ros::PollSet::M_SocketInfo
private

Definition at line 137 of file poll_set.h.

typedef boost::function<void(int)> ros::PollSet::SocketUpdateFunc

Definition at line 63 of file poll_set.h.

typedef std::vector<int> ros::PollSet::V_int
private

Definition at line 143 of file poll_set.h.

Constructor & Destructor Documentation

ros::PollSet::PollSet ( )

Definition at line 49 of file poll_set.cpp.

ros::PollSet::~PollSet ( )

Definition at line 60 of file poll_set.cpp.

Member Function Documentation

bool ros::PollSet::addEvents ( int  sock,
int  events 
)

Add events to be polled on a socket.

addEvents() may be called from any thread.

Parameters
sockThe socket to add events to
eventsThe events to add

Definition at line 121 of file poll_set.cpp.

bool ros::PollSet::addSocket ( int  sock,
const SocketUpdateFunc update_func,
const TransportPtr transport = TransportPtr() 
)

Add a socket.

addSocket() may be called from any thread.

Parameters
sockThe socket to add
update_funcThe function to call when a socket has events
transportThe (optional) transport associated with this socket. Mainly used to prevent the transport from being deleted while we're calling the update function

Definition at line 65 of file poll_set.cpp.

void ros::PollSet::createNativePollset ( )
private

Creates the native pollset for our sockets, if any have changed.

Definition at line 254 of file poll_set.cpp.

bool ros::PollSet::delEvents ( int  sock,
int  events 
)

Delete events to be polled on a socket.

delEvents() may be called from any thread.

Parameters
sockThe socket to delete events from
eventsThe events to delete

Definition at line 140 of file poll_set.cpp.

bool ros::PollSet::delSocket ( int  sock)

Delete a socket.

delSocket() may be called from any thread.

Parameters
sockThe socket to delete

Definition at line 91 of file poll_set.cpp.

void ros::PollSet::onLocalPipeEvents ( int  events)
private

Called when events have been triggered on our signal pipe.

Definition at line 277 of file poll_set.cpp.

void ros::PollSet::signal ( )

Signal our poll() call to finish if it's blocked waiting (see the poll_timeout option for update()).

Definition at line 160 of file poll_set.cpp.

void ros::PollSet::update ( int  poll_timeout)

Process all socket events.

This function will actually call poll() on the available sockets, and allow them to do their processing.

update() may only be called from one thread at a time

Parameters
poll_timeoutThe time, in milliseconds, for the poll() call to timeout after if there are no events. Note that this does not provide an upper bound for the entire function, just the call to poll()

Definition at line 175 of file poll_set.cpp.

Member Data Documentation

V_int ros::PollSet::just_deleted_
private

Definition at line 144 of file poll_set.h.

boost::mutex ros::PollSet::just_deleted_mutex_
private

Definition at line 142 of file poll_set.h.

boost::mutex ros::PollSet::signal_mutex_
private

Definition at line 148 of file poll_set.h.

signal_fd_t ros::PollSet::signal_pipe_[2]
private

Definition at line 149 of file poll_set.h.

M_SocketInfo ros::PollSet::socket_info_
private

Definition at line 138 of file poll_set.h.

boost::mutex ros::PollSet::socket_info_mutex_
private

Definition at line 139 of file poll_set.h.

bool ros::PollSet::sockets_changed_
private

Definition at line 140 of file poll_set.h.

std::vector<socket_pollfd> ros::PollSet::ufds_
private

Definition at line 146 of file poll_set.h.


The documentation for this class was generated from the following files:


roscpp
Author(s): Morgan Quigley, Josh Faust, Brian Gerkey, Troy Straszheim
autogenerated on Wed Dec 20 2017 03:58:42