omTCPMessage Class Reference
[GENERIC LIBRARY classes]

#include <omTCPMessage.h>

Public Member Functions
	omTCPMessage ()
wxString	GetCommand ()
wxString	GetParameter (int)
int	GetParCount ()
wxString	GetFormattedMessage ()
void	AddParameter (wxString)
Data Fields
wxString	fromAgent
	FROM_AGENT: field.
wxString	fromService
	FROM_SERVICE: field.
wxString	fromHost
	FROM_IP: field.
wxString	toAgent
	TO_AGENT: field.
wxString	toService
	TO_SERVICE: field.
wxString	toHost
	TO_IP: field.
wxString	command
	Command Code field.
wxArrayString	parameters
	Parameters.

---

Detailed Description

Store TCP/IP message.

This class is used to store a TCP message received or to send. Message fileds are stored in public attributes.

---

Constructor & Destructor Documentation

omTCPMessage::omTCPMessage (   )

Initialize the class.

---

Member Function Documentation

void omTCPMessage::AddParameter (  wxString  p  )

Set parameters Parameters: p  string containing the parameters

wxString omTCPMessage::GetCommand (   )

Return message command part.

wxString omTCPMessage::GetFormattedMessage (   )

Return message formatted to be sent via TCP/IP Returns: string containing formatted message

wxString omTCPMessage::GetParameter (  int  idx  )

Get a stored parameter. Parameters: idx  index of the parameter to retrive Returns: string containing the parameter.

int omTCPMessage::GetParCount (   )

Get the number of stored parameters. Returns: parameters number.

---

Field Documentation

wxString omTCPMessage::command

Command Code field.

wxString omTCPMessage::fromAgent

FROM_AGENT: field.

wxString omTCPMessage::fromHost

FROM_IP: field.

wxString omTCPMessage::fromService

FROM_SERVICE: field.

wxArrayString omTCPMessage::parameters

Parameters.

wxString omTCPMessage::toAgent

TO_AGENT: field.

wxString omTCPMessage::toHost

TO_IP: field.

wxString omTCPMessage::toService

TO_SERVICE: field.

---

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

• omTCPMessage.h
• omTCPMessage.cpp

 

Created with doxygen on: Tue Jun 8 13:59:50 2004 Copyright © by Luca Clivio