Public Member Functions

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, int header_size)
 This constructor creates a header based on an already-constructed NetDatagram.
 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.
int get_datagram_size (int header_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, int header_size) const
 Verifies that the indicated datagram has the appropriate length.

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

Constructor & Destructor Documentation

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

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

Definition at line 29 of file datagramTCPHeader.cxx.

References Datagram::add_uint16(), Datagram::add_uint32(), Datagram::get_length(), and Datagram::get_message().

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

Member Function Documentation

int DatagramTCPHeader::get_datagram_size ( int  header_size) const

Returns the number of bytes in the associated datagram.

Definition at line 78 of file datagramTCPHeader.cxx.

References DatagramIterator::get_uint16(), and DatagramIterator::get_uint32().

Referenced by verify_datagram().

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

References Datagram::get_message().

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

References Datagram::dump_hex(), get_datagram_size(), and Datagram::get_message().

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