Panda3D
Public Member Functions | List of all members
DatagramTCPHeader Class Reference

A class that encapsulates the extra bytes that are sent in front of each datagram to identify it when it is sent on TCP. More...

#include "datagramTCPHeader.h"

Public Member Functions

 DatagramTCPHeader (const NetDatagram &datagram, int header_size)
 This constructor creates a header based on an already-constructed NetDatagram. More...
 
 DatagramTCPHeader (const void *data, int header_size)
 This constructor decodes a header from a block of data of length datagram_tcp_header_size, presumably just read from a socket. More...
 
int get_datagram_size (int header_size) const
 Returns the number of bytes in the associated datagram. More...
 
std::string get_header () const
 Returns a pointer to a block of data of length datagram_tcp_header_size, which can be written to the network as the header information. More...
 
bool verify_datagram (const NetDatagram &datagram, int header_size) const
 Verifies that the indicated datagram has the appropriate length. More...
 

Detailed Description

A class that encapsulates the extra bytes that are sent in front of each datagram to identify it when it is sent on TCP.

This is similar to DatagramUDPHeader, except it does not include a checksum, since this is unnecessary on UDP.

Definition at line 35 of file datagramTCPHeader.h.

Constructor & Destructor Documentation

◆ DatagramTCPHeader() [1/2]

DatagramTCPHeader::DatagramTCPHeader ( const NetDatagram datagram,
int  header_size 
)

This constructor creates a header based on an already-constructed NetDatagram.

Definition at line 26 of file datagramTCPHeader.cxx.

◆ DatagramTCPHeader() [2/2]

DatagramTCPHeader::DatagramTCPHeader ( const void *  data,
int  header_size 
)

This constructor decodes a header from a block of data of length datagram_tcp_header_size, presumably just read from a socket.

Definition at line 61 of file datagramTCPHeader.cxx.

Member Function Documentation

◆ get_datagram_size()

int DatagramTCPHeader::get_datagram_size ( int  header_size) const

Returns the number of bytes in the associated datagram.

Definition at line 70 of file datagramTCPHeader.cxx.

◆ get_header()

std::string DatagramTCPHeader::get_header ( ) const
inline

Returns a pointer to a block of data of length datagram_tcp_header_size, which can be written to the network as the header information.

Definition at line 19 of file datagramTCPHeader.I.

References Datagram::get_message().

◆ verify_datagram()

bool DatagramTCPHeader::verify_datagram ( const NetDatagram datagram,
int  header_size 
) const

Verifies that the indicated datagram has the appropriate length.

Returns true if it matches, false otherwise.

Definition at line 91 of file datagramTCPHeader.cxx.


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