Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

QueuedConnectionListener Class Reference

This flavor of ConnectionListener will queue up all of the TCP connections it established for later detection by the client code. More...

#include <queuedConnectionListener.h>

Inheritance diagram for QueuedConnectionListener:

ConnectionListener QueuedReturn< ConnectionListenerData > ConnectionReader List of all members.

Public Member Functions

 QueuedConnectionListener (ConnectionManager *manager, int num_threads)
virtual ~QueuedConnectionListener ()
bool new_connection_available ()
 Returns true if a new connection was recently established; the connection information may then be retrieved via get_new_connection().

bool get_new_connection (PointerTo< Connection > &rendezvous, NetAddress &address, PointerTo< Connection > &new_connection)
 If a previous call to new_connection_available() returned true, this function will return information about the newly established connection.

bool get_new_connection (PointerTo< Connection > &new_connection)
 This flavor of get_new_connection() simply returns a new connection, assuming the user doesn't care about the rendezvous socket that originated it or the address it came from.

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.

void set_max_queue_size (int max_size)
int get_max_queue_size () const
int get_current_queue_size () const

Protected Member Functions

virtual void connection_opened (const PointerTo< Connection > &rendezvous, const NetAddress &address, const PointerTo< Connection > &new_connection)
 An internal function called by ConnectionListener() when a new TCP connection has been established.

virtual void receive_datagram (const NetDatagram &datagram)
 This function must be declared because it is pure virtual in the base class, but it isn't used in this class and doesn't do anything.

virtual void process_incoming_data (SocketInfo *sinfo)
 This is the function that is called when activity is detected on a rendezvous port.

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_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)
bool thing_available () const
bool get_thing (ConnectionListenerData &thing)
bool enqueue_thing (const ConnectionListenerData &thing)
bool enqueue_unique_thing (const ConnectionListenerData &thing)

Protected Attributes

ConnectionManager * _manager

Detailed Description

This flavor of ConnectionListener will queue up all of the TCP connections it established for later detection by the client code.

Definition at line 62 of file queuedConnectionListener.h.

Constructor & Destructor Documentation

QueuedConnectionListener::QueuedConnectionListener (  ConnectionManager *  manager,
int  num_threads
) 
 

Definition at line 33 of file queuedConnectionListener.cxx.

References ConnectionReader::shutdown().

QueuedConnectionListener::~QueuedConnectionListener (   )  [virtual]
 

Definition at line 46 of file queuedConnectionListener.cxx.

References ConnectionReader::poll(), and QueuedReturn< ConnectionListenerData >::thing_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.

void QueuedConnectionListener::connection_opened (  const PointerTo< Connection > &  rendezvous,
const NetAddress &  address,
const PointerTo< Connection > &  new_connection
)  [protected, virtual]
 

An internal function called by ConnectionListener() when a new TCP connection has been established.

The QueuedConnectionListener simply queues up this fact for later retrieval by get_new_connection().

Implements ConnectionListener.

Definition at line 162 of file queuedConnectionListener.cxx.

bool QueuedReturn< ConnectionListenerData >::enqueue_thing (  const ConnectionListenerData &  thing  )  [protected, inherited]
 

Adds a new thing to the queue for later retrieval.

Returns true if successful, false if the queue is full (i.e. has reached _max_queue_size).

Referenced by get_new_connection().

bool QueuedReturn< ConnectionListenerData >::enqueue_unique_thing (  const ConnectionListenerData &  thing  )  [protected, inherited]
 

The same as enqueue_thing(), except the queue is first checked that it doesn't already have something like thing.

The return value is true if the enqueue operation was successful, false if the queue was full or the thing was already on the queue.

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.

int QueuedReturn< ConnectionListenerData >::get_current_queue_size (   )  const [inherited]
 

Returns the current number of things in the queue.

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 QueuedReturn< ConnectionListenerData >::get_max_queue_size (   )  const [inherited]
 

Returns the maximum size the queue is allowed to grow to.

See set_max_queue_size().

bool QueuedConnectionListener::get_new_connection (  PointerTo< Connection > &  new_connection  ) 
 

This flavor of get_new_connection() simply returns a new connection, assuming the user doesn't care about the rendezvous socket that originated it or the address it came from.

Definition at line 140 of file queuedConnectionListener.cxx.

bool QueuedConnectionListener::get_new_connection (  PointerTo< Connection > &  rendezvous,
NetAddress &  address,
PointerTo< Connection > &  new_connection
) 
 

If a previous call to new_connection_available() returned true, this function will return information about the newly established connection.

The rendezvous parameter is the particular rendezvous socket this new connection originally communicated with; it is provided in case the ConnectionListener was monitorind more than one and you care which one it was. The address parameter is the net address of the new client, and new_connection is the socket of the newly established connection.

The return value is true if a connection was successfully returned, or false if there was, in fact, no new connection. (This may happen if there are multiple threads accessing the QueuedConnectionListener).

Definition at line 111 of file queuedConnectionListener.cxx.

References ConnectionListenerData::_address, ConnectionListenerData::_new_connection, ConnectionListenerData::_rendezvous, and QueuedReturn< ConnectionListenerData >::enqueue_thing().

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 QueuedReturn< ConnectionListenerData >::get_thing (  ConnectionListenerData &  thing  )  [protected, inherited]
 

If a previous call to thing_available() returned true, this function will return the thing that has become available.

The return value is true if a thing was successfully returned, or false if there was, in fact, no thing available. (This may happen if there are multiple threads accessing the QueuedReturn).

Referenced by new_connection_available().

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.

bool QueuedConnectionListener::new_connection_available (   ) 
 

Returns true if a new connection was recently established; the connection information may then be retrieved via get_new_connection().

Definition at line 65 of file queuedConnectionListener.cxx.

References ConnectionListenerData::_address, ConnectionListenerData::_new_connection, ConnectionListenerData::_rendezvous, and QueuedReturn< ConnectionListenerData >::get_thing().

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().

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

This is the function that is called when activity is detected on a rendezvous port.

In this case, it performs the accept().

Reimplemented from ConnectionReader.

Definition at line 73 of file connectionListener.cxx.

References ConnectionReader::_manager, and NULL.

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 ConnectionListener::receive_datagram (  const NetDatagram &  datagram  )  [protected, virtual, inherited]
 

This function must be declared because it is pure virtual in the base class, but it isn't used in this class and doesn't do anything.

Implements ConnectionReader.

Definition at line 55 of file connectionListener.cxx.

References NetAddress::get_ip_string(), NULL, and pprerror().

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 QueuedReturn< ConnectionListenerData >::set_max_queue_size (  int  max_size  )  [inherited]
 

Sets the maximum size the queue is allowed to grow to.

This is primarily for a sanity check; this is a limit beyond which we can assume something bad has happened.

It's also a crude check against unfortunate seg faults due to the queue filling up and quietly consuming all available memory.

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().

bool QueuedReturn< ConnectionListenerData >::thing_available (   )  const [inline, protected, inherited]
 

Returns true if a thing is available on the queue; call get_thing() to extract the thing.

Referenced by ~QueuedConnectionListener().

Member Data Documentation

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().

The documentation for this class was generated from the following files:
Generated on Fri May 2 00:54:32 2003 for Panda by doxygen1.3