PStatClientControlMessage Class Reference

This kind of message is sent from the client to the server on the TCP socket to establish critical control information. More...

#include "pStatClientControlMessage.h"

Public Types
enum	Type {   T_datagram = 0 , T_hello , T_define_collectors , T_define_threads ,   T_expire_thread , T_invalid }

Public Member Functions
bool	decode (const Datagram &datagram, PStatClientVersion *version)
	Extracts the message from the indicated datagram.
void	encode (Datagram &datagram) const
	Writes the message into the indicated datagram.

Public Attributes
std::string	_client_hostname
std::string	_client_progname
pvector< PStatCollectorDef * >	_collectors
int	_first_thread_index
int	_major_version
int	_minor_version
pvector< std::string >	_names
Type	_type

Detailed Description

This kind of message is sent from the client to the server on the TCP socket to establish critical control information.

Definition at line 30 of file pStatClientControlMessage.h.

Member Enumeration Documentation

Type

enum PStatClientControlMessage::Type

Definition at line 37 of file pStatClientControlMessage.h.

Constructor & Destructor Documentation

PStatClientControlMessage()

PStatClientControlMessage::PStatClientControlMessage

(

)

Definition at line 24 of file pStatClientControlMessage.cxx.

Member Function Documentation

decode()

bool PStatClientControlMessage::decode	(	const Datagram &	datagram,
		PStatClientVersion *	version )

Extracts the message from the indicated datagram.

Returns true on success, false on error.

Definition at line 77 of file pStatClientControlMessage.cxx.

References DatagramIterator::get_remaining_size(), DatagramIterator::get_string(), DatagramIterator::get_uint16(), DatagramIterator::get_uint8(), and PStatCollectorDef::read_datagram().

encode()

void PStatClientControlMessage::encode

(

Datagram &

datagram

)

const

Writes the message into the indicated datagram.

Definition at line 32 of file pStatClientControlMessage.cxx.

References Datagram::add_string(), Datagram::add_uint16(), Datagram::add_uint8(), and Datagram::clear().

Member Data Documentation

_client_hostname

std::string PStatClientControlMessage::_client_hostname

Definition at line 49 of file pStatClientControlMessage.h.

_client_progname

std::string PStatClientControlMessage::_client_progname

Definition at line 50 of file pStatClientControlMessage.h.

_collectors

pvector<PStatCollectorDef *> PStatClientControlMessage::_collectors

Definition at line 55 of file pStatClientControlMessage.h.

_first_thread_index

int PStatClientControlMessage::_first_thread_index

Definition at line 58 of file pStatClientControlMessage.h.

_major_version

int PStatClientControlMessage::_major_version

Definition at line 51 of file pStatClientControlMessage.h.

_minor_version

int PStatClientControlMessage::_minor_version

Definition at line 52 of file pStatClientControlMessage.h.

_names

pvector<std::string> PStatClientControlMessage::_names

Definition at line 59 of file pStatClientControlMessage.h.

_type

Type PStatClientControlMessage::_type

Definition at line 46 of file pStatClientControlMessage.h.

---

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

• panda/src/pstatclient/pStatClientControlMessage.h
• panda/src/pstatclient/pStatClientControlMessage.cxx