Panda3D
Public Member Functions | List of all members
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:
ConnectionReader

Public Member Functions

 RecentConnectionReader (ConnectionManager *manager)
 
bool data_available ()
 Returns true if a datagram is available on the queue; call get_data() to extract the datagram. More...
 
bool get_data (NetDatagram &result)
 If a previous call to data_available() returned true, this function will return the datagram that has become available. More...
 
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. More...
 
- Public Member Functions inherited from ConnectionReader
 ConnectionReader (ConnectionManager *manager, int num_threads, const std::string &thread_name=std::string())
 Creates a new ConnectionReader with the indicated number of threads to handle requests. More...
 
bool add_connection (Connection *connection)
 Adds a new socket to the list of sockets the ConnectionReader will monitor. More...
 
ConnectionManagerget_manager () const
 Returns a pointer to the ConnectionManager object that serves this ConnectionReader. More...
 
int get_num_threads () const
 Returns the number of threads the ConnectionReader has been created with. More...
 
bool get_raw_mode () const
 Returns the current setting of the raw mode flag. More...
 
int get_tcp_header_size () const
 Returns the current setting of TCP header size. More...
 
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. More...
 
bool is_polling () const
 Returns true if the reader is a polling reader, i.e. More...
 
void poll ()
 Explicitly polls the available sockets to see if any of them have any noise. More...
 
bool remove_connection (Connection *connection)
 Removes a socket from the list of sockets being monitored. More...
 
void set_raw_mode (bool mode)
 Sets the ConnectionReader into raw mode (or turns off raw mode). More...
 
void set_tcp_header_size (int tcp_header_size)
 Sets the header size of TCP packets. More...
 
void shutdown ()
 Terminates all threads cleanly. More...
 

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 32 of file recentConnectionReader.h.

Member Function Documentation

◆ data_available()

bool RecentConnectionReader::data_available ( )

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

Definition at line 47 of file recentConnectionReader.cxx.

◆ get_data() [1/2]

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 60 of file recentConnectionReader.cxx.

Referenced by get_data().

◆ get_data() [2/2]

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 79 of file recentConnectionReader.cxx.

References get_data().


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