Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File 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>

List of all members.

Public Member Functions

 DatagramTCPHeader (const NetDatagram &datagram)
 This constructor creates a header based on an already-constructed NetDatagram.

 DatagramTCPHeader (const void *data)
 This constructor decodes a header from a block of data of length datagram_tcp_header_size, presumably just read from a socket.

int get_datagram_size () const
 Returns the number of bytes in the associated datagram.

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.

bool verify_datagram (const NetDatagram &datagram) const
 Verifies that the indicated datagram has the appropriate length.


Private Attributes

NetDatagram _header

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 52 of file datagramTCPHeader.h.

Constructor & Destructor Documentation

DatagramTCPHeader::DatagramTCPHeader (  const NetDatagram &  datagram  ) 
 

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

Definition at line 40 of file datagramTCPHeader.cxx.

DatagramTCPHeader::DatagramTCPHeader (  const void *  data  ) 
 

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 63 of file datagramTCPHeader.cxx.

Member Function Documentation

int DatagramTCPHeader::get_datagram_size (   )  const [inline]
 

Returns the number of bytes in the associated datagram.

Definition at line 34 of file datagramTCPHeader.I.

References _header, Datagram::get_message(), and INLINE.

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 52 of file datagramTCPHeader.I.

bool DatagramTCPHeader::verify_datagram (  const NetDatagram &  datagram  )  const
 

Verifies that the indicated datagram has the appropriate length.

Returns true if it matches, false otherwise.

Definition at line 79 of file datagramTCPHeader.cxx.

Member Data Documentation

NetDatagram DatagramTCPHeader::_header [private]
 

Definition at line 66 of file datagramTCPHeader.h.

Referenced by DatagramUDPHeader::DatagramUDPHeader(), and get_datagram_size().

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