Panda3D
Classes | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes

PStatReader Class Reference

This is the class that does all the work for handling communications from a single Panda client. More...

#include "pStatReader.h"

Inheritance diagram for PStatReader:
ConnectionReader

List of all members.

Classes

class  FrameData

Public Member Functions

 PStatReader (PStatServer *manager, PStatMonitor *monitor)
bool add_connection (Connection *connection)
 Adds a new socket to the list of sockets the ConnectionReader will monitor.
void close ()
 This will be called by the PStatClientData in response to its close() call.
ConnectionManagerget_manager () const
 Returns a pointer to the ConnectionManager object that serves this ConnectionReader.
PStatMonitorget_monitor ()
 Returns the monitor that this reader serves.
int get_num_threads () const
 Returns the number of threads the ConnectionReader has been created with.
bool get_raw_mode () const
 Returns the current setting of the raw mode flag.
int get_tcp_header_size () const
 Returns the current setting of TCP header size.
void idle ()
 Called each frame to do what needs to be done for the monitor's user-defined idle routines.
bool is_connection_ok (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.
bool is_polling () const
 Returns true if the reader is a polling reader, i.e.
void lost_connection ()
 This is called by the PStatServer when it detects that the connection has been lost.
void poll ()
 Explicitly polls the available sockets to see if any of them have any noise.
bool remove_connection (Connection *connection)
 Removes a socket from the list of sockets being monitored.
void set_raw_mode (bool mode)
 Sets the ConnectionReader into raw mode (or turns off raw mode).
void set_tcp_connection (Connection *tcp_connection)
 This is intended to be called only once, immediately after construction, by the PStatListener that created it.
void set_tcp_header_size (int tcp_header_size)
 Sets the header size of TCP packets.
void shutdown ()
 Terminates all threads cleanly.

Protected Types

typedef pvector< SocketInfo * > Sockets

Protected Member Functions

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 flush_read_connection (Connection *connection)
 Attempts to read all the possible data from the indicated connection, which has just delivered a write error (and has therefore already been closed).
virtual bool process_incoming_data (SocketInfo *sinfo)
 This is run within a thread when the call to select() indicates there is data available on a socket.
virtual bool process_incoming_tcp_data (SocketInfo *sinfo)
virtual bool process_incoming_udp_data (SocketInfo *sinfo)
virtual bool process_raw_incoming_tcp_data (SocketInfo *sinfo)
virtual bool process_raw_incoming_udp_data (SocketInfo *sinfo)

Protected Attributes

Sockets _removed_sockets
Sockets _sockets
LightMutex _sockets_mutex

Detailed Description

This is the class that does all the work for handling communications from a single Panda client.

It reads sockets received from the client and boils them down into PStatData.

Definition at line 44 of file pStatReader.h.


Member Function Documentation

bool ConnectionReader::add_connection ( 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 196 of file connectionReader.cxx.

Referenced by PStatServer::listen(), MayaToEggServer::poll(), and set_tcp_connection().

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 471 of file connectionReader.cxx.

void PStatReader::close ( )

This will be called by the PStatClientData in response to its close() call.

It will tell the server to let go of the reader so it can shut down its connection.

Definition at line 69 of file pStatReader.cxx.

References lost_connection(), and PStatServer::remove_reader().

Referenced by PStatClientData::close().

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 482 of file connectionReader.cxx.

Referenced by ConnectionListener::process_incoming_data().

void ConnectionReader::flush_read_connection ( Connection connection) [protected, virtual, inherited]

Attempts to read all the possible data from the indicated connection, which has just delivered a write error (and has therefore already been closed).

If the connection is not monitered by this reader, does nothing.

Definition at line 431 of file connectionReader.cxx.

References Socket_fdset::clear(), ConnectionReader::process_incoming_data(), and ConnectionReader::remove_connection().

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

Returns a pointer to the ConnectionManager object that serves this ConnectionReader.

Definition at line 330 of file connectionReader.cxx.

PStatMonitor * PStatReader::get_monitor ( )

Returns the monitor that this reader serves.

Definition at line 137 of file pStatReader.cxx.

int ConnectionReader::get_num_threads ( ) const [inherited]

Returns the number of threads the ConnectionReader has been created with.

Definition at line 341 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 368 of file connectionReader.cxx.

int ConnectionReader::get_tcp_header_size ( ) const [inherited]

Returns the current setting of TCP header size.

See set_tcp_header_size().

Definition at line 393 of file connectionReader.cxx.

void PStatReader::idle ( )

Called each frame to do what needs to be done for the monitor's user-defined idle routines.

Definition at line 126 of file pStatReader.cxx.

Referenced by PStatServer::poll().

bool ConnectionReader::is_connection_ok ( 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 258 of file connectionReader.cxx.

bool ConnectionReader::is_polling ( ) const [inline, inherited]

Returns true if the reader is a polling reader, i.e.

it has no threads.

Definition at line 23 of file connectionReader.I.

Referenced by DatagramGeneratorNet::get_datagram().

void PStatReader::lost_connection ( )

This is called by the PStatServer when it detects that the connection has been lost.

It should clean itself up and shut down nicely.

Definition at line 108 of file pStatReader.cxx.

References ConnectionManager::close_connection().

Referenced by close(), and PStatServer::poll().

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 292 of file connectionReader.cxx.

References TrueClock::get_global_ptr(), and ConnectionReader::process_incoming_data().

Referenced by QueuedConnectionReader::data_available(), DatagramGeneratorNet::get_datagram(), QueuedConnectionListener::new_connection_available(), PStatServer::poll(), and MayaToEggServer::poll().

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

This is run within a thread when the call to select() indicates there is data available on a socket.

Returns true if the data is read successfully, false on failure (for instance, because the connection is closed).

Reimplemented in ConnectionListener.

Definition at line 500 of file connectionReader.cxx.

Referenced by ConnectionReader::flush_read_connection(), and ConnectionReader::poll().

bool ConnectionReader::remove_connection ( 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 227 of file connectionReader.cxx.

Referenced by ConnectionReader::flush_read_connection().

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.

This is similar to set_tcp_header_size(0), except that it also turns off headers for UDP packets.

Definition at line 357 of file connectionReader.cxx.

void PStatReader::set_tcp_connection ( Connection tcp_connection)

This is intended to be called only once, immediately after construction, by the PStatListener that created it.

It tells the reader about the newly-established TCP connection to a client.

Definition at line 83 of file pStatReader.cxx.

References ConnectionReader::add_connection(), and PStatServer::get_udp_port().

Referenced by PStatListener::connection_opened().

void ConnectionReader::set_tcp_header_size ( int  tcp_header_size) [inherited]

Sets the header size of TCP packets.

At the present, legal values for this are 0, 2, or 4; this specifies the number of bytes to use encode the datagram length at the start of each TCP datagram. Sender and receiver must independently agree on this.

Definition at line 382 of file connectionReader.cxx.

void ConnectionReader::shutdown ( ) [inherited]

Terminates all threads cleanly.

Normally this is only called by the destructor, but it may be called explicitly before destruction.

Definition at line 405 of file connectionReader.cxx.


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations