net_msg_hdr Klassenreferenz

Enthält Headerdaten einer Nachricht, die über das Netzwerk verschickt wird. Mehr ...

#include <protocol.h>

Aufstellung aller Elemente

Öffentliche Methoden
	net_msg_hdr (void)
	Erstellt eine Nachricht mit Standardparametern.
	net_msg_hdr (unsigned char type, unsigned char cmd, size_t param_size=0)
int	set_type (unsigned char type)
int	set_cmd (unsigned char cmd)
int	set_chksum (void)
int	set_size (size_t size)
unsigned char	get_type (void) const
unsigned char	get_cmd (void) const
size_t	get_size (void) const
Private Attribute
unsigned char	type
	Kodiert den Typ der Nachricht (z.B. MSG_TYPE_SYSTEM).
unsigned char	cmd
	Kodiert den Befehl der Nachricht (z.B. MSG_PING).
size_t	param_size
	Größe des Parameterfeldes in Bytes.

---

Ausführliche Beschreibung

Enthält Headerdaten einer Nachricht, die über das Netzwerk verschickt wird.

---

Beschreibung der Konstruktoren und Destruktoren

net_msg_hdr::net_msg_hdr

(

void

)

Erstellt eine Nachricht mit Standardparametern.

net_msg_hdr::net_msg_hdr	(	unsigned char	type,
		unsigned char	cmd,
		size_t	param_size = 0
	)

Erstellt eine Nachricht mit vorgegebenen Parametern.

Parameter:

	type	Der Typ der Nachricht, z.B. MSG_TYPE_SYTEM. Siehe protocol.h für weitere Typen.
	cmd	Der Befehl der Nachricht, z.B. MSG_PING. Siehe protocol.h für weitere Befehle.
	param_size	Länge der Parameter der Nachricht in Bytes

---

Dokumentation der Elementfunktionen

unsigned char net_msg_hdr::get_cmd

(

void

)

const

Gibt den Befehl der Nachricht zurück.

Rückgabe:

Der Nachrichtenbefehl (0-255, z.B. MSG_PING), siehe Definitionen in protocol.h.

size_t net_msg_hdr::get_size

(

void

)

const

Gibt die Parametergröße der Nachricht zurück.

Rückgabe:

Die Länge des Parameterblocks in Bytes.

unsigned char net_msg_hdr::get_type

(

void

)

const

Gibt den Typ der Nachricht zurück.

Rückgabe:

Der Nachrichtentyp (0-255, z.B. MSG_TYPE_SYSTEM), siehe Definitionen in protocol.h

int net_msg_hdr::set_chksum

(

void

)

int net_msg_hdr::set_cmd

(

unsigned char

cmd

)

Setzt den Befehl der Nachricht.

Parameter:

cmd

Neuer Befehl der Nachricht

Rückgabe:

Immer 0.

int net_msg_hdr::set_size

(

size_t

size

)

Setzt die Größe der Parameter der Nachricht

Parameter:

size

Die neue Parametergröße der Nachricht

Rückgabe:

Immer 0.

int net_msg_hdr::set_type

(

unsigned char

type

)

Setzt den Typ der Nachricht.

Parameter:

type

Neuer Typ der Nachricht

Rückgabe:

Immer 0.

---

Dokumentation der Datenelemente

unsigned char net_msg_hdr::cmd [private]

Kodiert den Befehl der Nachricht (z.B. MSG_PING).

size_t net_msg_hdr::param_size [private]

Größe des Parameterfeldes in Bytes.

unsigned char net_msg_hdr::type [private]

Kodiert den Typ der Nachricht (z.B. MSG_TYPE_SYSTEM).

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Dateien:

• protocol.h
• protocol.cpp

---