---

RecentConnectionReader Class Reference

This flavor of ConnectionReader will read from its sockets and retain only the single most recent datagram for inspection by client code. More...

#include <recentConnectionReader.h>

Inheritance diagram for RecentConnectionReader:

List of all members.

Public Member Functions
	RecentConnectionReader (ConnectionManager *manager)
virtual	~RecentConnectionReader ()
bool	data_available ()
	Returns true if a datagram is available on the queue; call get_data() to extract the datagram.
bool	get_data (NetDatagram &result)
	If a previous call to data_available() returned true, this function will return the datagram that has become available.
bool	get_data (Datagram &result)
	This flavor of RecentConnectionReader::get_data(), works like the other, except that it only fills a Datagram object, not a NetDatagram object.
bool	add_connection (const PointerTo< Connection > &connection)
	Adds a new socket to the list of sockets the ConnectionReader will monitor.
bool	remove_connection (const PointerTo< Connection > &connection)
	Removes a socket from the list of sockets being monitored.
bool	is_connection_ok (const PointerTo< Connection > &connection)
	Returns true if the indicated connection has been added to the ConnectionReader and is being monitored properly, false if it is not known, or if there was some error condition detected on the connection.
void	poll ()
	Explicitly polls the available sockets to see if any of them have any noise.
ConnectionManager *	get_manager () const
	Returns a pointer to the ConnectionManager object that serves this ConnectionReader.
bool	is_polling () const
	Returns true if the reader is a polling reader, i.e.
int	get_num_threads () const
	Returns the number of threads the ConnectionReader has been created with.
void	set_raw_mode (bool mode)
	Sets the ConnectionReader into raw mode (or turns off raw mode).
bool	get_raw_mode () const
	Returns the current setting of the raw mode flag.
Protected Member Functions
virtual void	receive_datagram (const NetDatagram &datagram)
	An internal function called by ConnectionReader() when a new datagram has become available.
void	shutdown ()
	Terminates all threads cleanly.
void	clear_manager ()
	This should normally only be called when the associated ConnectionManager destructs.
void	finish_socket (SocketInfo *sinfo)
	To be called when a socket has been fully read and is ready for polling for additional data.
virtual void	process_incoming_data (SocketInfo *sinfo)
	This is run within a thread when the call to PR_Poll() indicates there is data available on a socket.
virtual void	process_incoming_udp_data (SocketInfo *sinfo)
virtual void	process_incoming_tcp_data (SocketInfo *sinfo)
virtual void	process_raw_incoming_udp_data (SocketInfo *sinfo)
virtual void	process_raw_incoming_tcp_data (SocketInfo *sinfo)
Protected Attributes
ConnectionManager *	_manager
Private Attributes
bool	_available
Datagram	_datagram
PRLock *	_mutex

---

Detailed Description

This flavor of ConnectionReader will read from its sockets and retain only the single most recent datagram for inspection by client code.

It's useful particularly for reading telemetry-type data from UDP sockets where you don't care about getting every last socket, and in fact if the sockets are coming too fast you'd prefer to skip some of them.

This class will always create one thread for itself.

Definition at line 55 of file recentConnectionReader.h.

---

Constructor & Destructor Documentation

RecentConnectionReader::RecentConnectionReader (  ConnectionManager *  manager  )

Definition at line 33 of file recentConnectionReader.cxx. References QueuedReturn< Thing >::_available, and QueuedReturn< Thing >::_mutex.

RecentConnectionReader::~RecentConnectionReader (   )  [virtual]

Definition at line 52 of file recentConnectionReader.cxx. References _available.

---

Member Function Documentation

bool ConnectionReader::add_connection (  const PointerTo< Connection > &  connection  )  [inherited]

Adds a new socket to the list of sockets the ConnectionReader will monitor. A datagram that comes in on any of the monitored sockets will be reported. In the case of a ConnectionListener, this adds a new rendezvous socket; any activity on any of the monitored sockets will cause a connection to be accepted. The return value is true if the connection was added, false if it was already there. add_connection() is thread-safe, and may be called at will by any thread. Definition at line 210 of file connectionReader.cxx. References ConnectionReader::_reexamine_sockets, ConnectionReader::_removed_sockets, ConnectionReader::_sockets, and ConnectionReader::_sockets_mutex.

void ConnectionReader::clear_manager (   )  [protected, inherited]

This should normally only be called when the associated ConnectionManager destructs. It resets the ConnectionManager pointer to NULL so we don't have a floating pointer. This makes the ConnectionReader invalid; presumably it also will be destructed momentarily. Definition at line 487 of file connectionReader.cxx.

bool RecentConnectionReader::data_available (   )

Returns true if a datagram is available on the queue; call get_data() to extract the datagram. Definition at line 71 of file recentConnectionReader.cxx. References _available, _datagram, and _mutex.

void ConnectionReader::finish_socket (  SocketInfo *  sinfo  )  [protected, inherited]

To be called when a socket has been fully read and is ready for polling for additional data. Definition at line 502 of file connectionReader.cxx.

bool RecentConnectionReader::get_data (  Datagram &  result  )

This flavor of RecentConnectionReader::get_data(), works like the other, except that it only fills a Datagram object, not a NetDatagram object. This means that the Datagram cannot be queried for its source Connection and/or NetAddress, but it is useful in all other respects. Definition at line 133 of file recentConnectionReader.cxx.

bool RecentConnectionReader::get_data (  NetDatagram &  result  )

If a previous call to data_available() returned true, this function will return the datagram that has become available. The return value is true if a datagram was successfully returned, or false if there was, in fact, no datagram available. (This may happen if there are multiple threads accessing the RecentConnectionReader). Definition at line 100 of file recentConnectionReader.cxx.

ConnectionManager * ConnectionReader::get_manager (   )  const [inherited]

Returns a pointer to the ConnectionManager object that serves this ConnectionReader. Definition at line 364 of file connectionReader.cxx. References ConnectionReader::_threads.

int ConnectionReader::get_num_threads (   )  const [inherited]

Returns the number of threads the ConnectionReader has been created with. Definition at line 394 of file connectionReader.cxx.

bool ConnectionReader::get_raw_mode (   )  const [inherited]

Returns the current setting of the raw mode flag. See set_raw_mode(). Definition at line 428 of file connectionReader.cxx.

bool ConnectionReader::is_connection_ok (  const PointerTo< Connection > &  connection  )  [inherited]

Returns true if the indicated connection has been added to the ConnectionReader and is being monitored properly, false if it is not known, or if there was some error condition detected on the connection. (If there was an error condition, normally the ConnectionManager would have been informed and closed the connection.) Definition at line 296 of file connectionReader.cxx. References ConnectionReader::_manager.

bool ConnectionReader::is_polling (   )  const [inherited]

Returns true if the reader is a polling reader, i.e. it has no threads. Definition at line 379 of file connectionReader.cxx.

void ConnectionReader::poll (   )  [inherited]

Explicitly polls the available sockets to see if any of them have any noise. This function does nothing unless this is a polling-type ConnectionReader, i.e. it was created with zero threads (and is_polling() will return true). It is not necessary to call this explicitly for a QueuedConnectionReader. Definition at line 342 of file connectionReader.cxx. References ConnectionReader::_raw_mode. Referenced by QueuedConnectionListener::~QueuedConnectionListener().

void ConnectionReader::process_incoming_data (  SocketInfo *  sinfo  )  [protected, virtual, inherited]

This is run within a thread when the call to PR_Poll() indicates there is data available on a socket. Reimplemented in ConnectionListener. Definition at line 543 of file connectionReader.cxx. References ConnectionReader::_manager, ConnectionManager::connection_reset(), NULL, and pprerror().

void ConnectionReader::process_incoming_tcp_data (  SocketInfo *  sinfo  )  [protected, virtual, inherited]

Definition at line 640 of file connectionReader.cxx.

void ConnectionReader::process_incoming_udp_data (  SocketInfo *  sinfo  )  [protected, virtual, inherited]

Definition at line 567 of file connectionReader.cxx.

void ConnectionReader::process_raw_incoming_tcp_data (  SocketInfo *  sinfo  )  [protected, virtual, inherited]

Definition at line 839 of file connectionReader.cxx. References ConnectionReader::_next_index, ConnectionReader::_num_results, ConnectionReader::_poll, ConnectionReader::_polled_sockets, ConnectionReader::_reexamine_sockets, ConnectionReader::_shutdown, and NULL.

void ConnectionReader::process_raw_incoming_udp_data (  SocketInfo *  sinfo  )  [protected, virtual, inherited]

Definition at line 785 of file connectionReader.cxx.

void RecentConnectionReader::receive_datagram (  const NetDatagram &  datagram  )  [protected, virtual]

An internal function called by ConnectionReader() when a new datagram has become available. The RecentConnectionReader simply queues it up for later retrieval by get_data(). Implements ConnectionReader. Definition at line 157 of file recentConnectionReader.cxx.

bool ConnectionReader::remove_connection (  const PointerTo< Connection > &  connection  )  [inherited]

Removes a socket from the list of sockets being monitored. Returns true if the socket was correctly removed, false if it was not on the list in the first place. remove_connection() is thread-safe, and may be called at will by any thread. Definition at line 253 of file connectionReader.cxx.

void ConnectionReader::set_raw_mode (  bool  mode  )  [inherited]

Sets the ConnectionReader into raw mode (or turns off raw mode). In raw mode, datagram headers are not expected; instead, all the data available on the pipe is treated as a single datagram. Definition at line 413 of file connectionReader.cxx. Referenced by HTTPClient::HTTPClient().

void ConnectionReader::shutdown (   )  [protected, inherited]

Terminates all threads cleanly. Normally this is only called by the destructor. Definition at line 443 of file connectionReader.cxx. Referenced by QueuedConnectionListener::QueuedConnectionListener().

---

Member Data Documentation

bool RecentConnectionReader::_available [private]

Definition at line 68 of file recentConnectionReader.h. Referenced by data_available(), and ~RecentConnectionReader().

Datagram RecentConnectionReader::_datagram [private]

Definition at line 69 of file recentConnectionReader.h. Referenced by data_available().

ConnectionManager* ConnectionReader::_manager [protected, inherited]

Definition at line 146 of file connectionReader.h. Referenced by ConnectionReader::SocketInfo::get_socket(), ConnectionReader::is_connection_ok(), ConnectionReader::process_incoming_data(), and ConnectionListener::process_incoming_data().

PRLock* RecentConnectionReader::_mutex [private]

Definition at line 70 of file recentConnectionReader.h. Referenced by data_available().

---

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

• panda/src/net/recentConnectionReader.h
• panda/src/net/recentConnectionReader.cxx

---