Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

ssobjects::PacketMessage Class Reference

Container for a packet and socket. More...

#include <packetmessageque.h>

List of all members.

Public Methods

 PacketMessage (SocketInstance *const s, PacketBuffer *const p)
virtual ~PacketMessage ()
PacketBufferpacket () const
 < Pointer to the packet that was read in. More...

SocketInstancesocket () const
 < Pointer to the socket that the packet data was read from. More...

uint id () const
 < Unique id of this packet. More...


Detailed Description

Container for a packet and socket.

The PacketMessage object is created by the SimpleServer object, and is used to contain a pointer to the socket and packet data that was just read in.

Note:
The unique id is not thread-safe.


Constructor & Destructor Documentation

ssobjects::PacketMessage::PacketMessage ( SocketInstance *const s,
PacketBuffer *const p )
 

Constructs a message that will be used to place into the message que.

Parameters:
s   Pointer to the socket that the data in p was read from.
p   Pointer to the packet object that was created from the data read from socket s.

ssobjects::PacketMessage::~PacketMessage ( ) [virtual]
 

Destructs. Does not delete objects that were passed in. You are responsible for that.


Member Function Documentation

uint ssobjects::PacketMessage::id ( ) const [inline]
 

< Unique id of this packet.

This is rarely used.

PacketBuffer * ssobjects::PacketMessage::packet ( ) const [inline]
 

< Pointer to the packet that was read in.

SocketInstance * ssobjects::PacketMessage::socket ( ) const [inline]
 

< Pointer to the socket that the packet data was read from.


The documentation for this class was generated from the following files:
Generated at Tue Sep 25 00:26:37 2001 for SimpleServerObjects by doxygen1.2.7 written by Dimitri van Heesch, © 1997-2001