# DatagramGeneratorNet

from pandac.PandaModules import DatagramGeneratorNet

Class : DatagramGeneratorNet
Description : This class provides datagrams one-at-a-time as read directly from the net, via a TCP connection. If a datagram is not available, get_datagram() will block until one is.

## Inheritance:

DatagramGeneratorNet: DatagramGenerator ConnectionReader QueuedReturn< Datagram >
DatagramGenerator:
ConnectionReader:
QueuedReturn< Datagram >:

## Methods of DatagramGeneratorNet:

DatagramGeneratorNet (Constructor)
getDatagram
isEof
isError

## Methods of DatagramGenerator:

getDatagram
getFile
getFilePos
isEof
isError

## Methods of ConnectionReader:

addConnection
getManager
getNumThreads
getRawMode
getTcpHeaderSize
isConnectionOk
isPolling
poll
removeConnection
setRawMode
setTcpHeaderSize

## Methods of QueuedReturn< Datagram >:

getCurrentQueueSize
getMaxQueueSize
getOverflowFlag
resetOverflowFlag
setMaxQueueSize

DatagramGeneratorNet DatagramGeneratorNet::DatagramGeneratorNet(ConnectionManager *manager, int num_threads); Description: Creates a new DatagramGeneratorNet with the indicated number of threads to handle requests. Normally num_threads should be either 0 or 1 to guarantee that datagrams are generated in the same order in which they were received.

getDatagram virtual bool DatagramGeneratorNet::get_datagram(Datagram &data); Inherited from DatagramGenerator Description: Reads the next datagram from the stream. Blocks until a datagram is available. Returns true on success, false on stream closed or error.

isEof virtual bool DatagramGeneratorNet::is_eof(void); Inherited from DatagramGenerator Description: Returns true if the stream has been closed normally. This test may only be made after a call to get_datagram() has failed.

isError virtual bool DatagramGeneratorNet::is_error(void); Description: Returns true if the stream has an error condition.

getDatagram virtual bool DatagramGenerator::get_datagram(Datagram &data) = 0; Undocumented function.

getFile virtual VirtualFile *DatagramGenerator::get_file(void); Description: Returns the VirtualFile that provides the source for these datagrams, if any, or NULL if the datagrams do not originate from a VirtualFile.

getFilePos virtual int DatagramGenerator::get_file_pos(void); Description: Returns the current file position within the data stream, if any, or 0 if the file position is not meaningful or cannot be determined. For DatagramGenerators that return a meaningful file position, this will be pointing to the first byte following the datagram returned after a call to get_datagram().

isEof virtual bool DatagramGenerator::is_eof(void) = 0; Undocumented function.

isError virtual bool DatagramGenerator::is_error(void) = 0; Undocumented function.

addConnection bool ConnectionReader::add_connection(Connection *connection); Description: 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.

getManager ConnectionManager *ConnectionReader::get_manager(void) const; Description: Returns a pointer to the ConnectionManager object that serves this ConnectionReader.

getNumThreads int ConnectionReader::get_num_threads(void) const; Description: Returns the number of threads the ConnectionReader has been created with.

getRawMode bool ConnectionReader::get_raw_mode(void) const; Description: Returns the current setting of the raw mode flag. See set_raw_mode().

getTcpHeaderSize int ConnectionReader::get_tcp_header_size(void) const; Description: Returns the current setting of TCP header size. See set_tcp_header_size().

isConnectionOk bool ConnectionReader::is_connection_ok(Connection *connection); Description: 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.)

isPolling bool ConnectionReader::is_polling(void) const; Description: Returns true if the reader is a polling reader, i.e. it has no threads.

poll void ConnectionReader::poll(void); Description: 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.

removeConnection bool ConnectionReader::remove_connection(Connection *connection); Description: 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.

setRawMode void ConnectionReader::set_raw_mode(bool mode); Description: 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.

setTcpHeaderSize void ConnectionReader::set_tcp_header_size(int tcp_header_size); Description: 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.

getCurrentQueueSize int ::QueuedReturn< Datagram >::get_current_queue_size(void) const; Undocumented function.

getMaxQueueSize int ::QueuedReturn< Datagram >::get_max_queue_size(void) const; Undocumented function.

getOverflowFlag bool ::QueuedReturn< Datagram >::get_overflow_flag(void) const; Undocumented function.

resetOverflowFlag void ::QueuedReturn< Datagram >::reset_overflow_flag(void); Undocumented function.

setMaxQueueSize void ::QueuedReturn< Datagram >::set_max_queue_size(int max_size); Undocumented function.