protlib::TPMsg Class Reference

transport protcol message More...

#include <source/ariba/utility/transport/tcpip/protlib/tp.h>

Inherits protlib::message.

Collaboration diagram for protlib::TPMsg:

Collaboration graph
[legend]

List of all members.

Public Member Functions

void set_oif (uint16 iface)
 set Outgoing Interface
uint16 get_oif ()
 get Outgoing Interface
virtual void clear_pointers ()
 TPMsg (NetMsg *m=NULL, address *peer=NULL, address *ownaddr=NULL, TPError *e=NULL, uint16 oif=0)
 constructor
virtual ~TPMsg ()
 destructor
const addressget_peeraddress () const
 get peer address
const addressget_ownaddress () const
 set own address
addressset_peeraddress (address *a)
 set peer address
addressset_ownaddress (address *a)
 set own address
NetMsgget_message () const
 get network message
NetMsgset_message (NetMsg *m)
 set network message
TPErrorget_error () const
 get TP error
TPErrorset_error (TPError *e)
 set TP error

Private Attributes

addresspeeraddr
 peer address
addressownaddr
 own address
NetMsgmsg
 network message
TPErrorerr
uint16 oif
 outgoing interface index


Detailed Description

transport protcol message

This message class is used to carry received network messages.

Definition at line 131 of file tp.h.


Constructor & Destructor Documentation

protlib::TPMsg::TPMsg ( NetMsg m = NULL,
address p = NULL,
address o = NULL,
TPError e = NULL,
uint16  oif = 0 
) [inline]

constructor

Initialize and set message type and source to 'transport'.

Definition at line 194 of file tp.h.

protlib::TPMsg::~TPMsg (  )  [inline, virtual]

destructor

Dispose NetMsg, address, err and then delete TPMsg.

Definition at line 205 of file tp.h.

References err, msg, ownaddr, and peeraddr.


Member Function Documentation

void protlib::TPMsg::clear_pointers (  )  [inline, virtual]

Clear all pointer fields.

Reimplemented from protlib::message.

Definition at line 183 of file tp.h.

References err, msg, ownaddr, and peeraddr.

TPError * protlib::TPMsg::get_error (  )  const [inline]

get TP error

Definition at line 243 of file tp.h.

References err.

NetMsg * protlib::TPMsg::get_message (  )  const [inline]

get network message

Definition at line 233 of file tp.h.

References msg.

Referenced by ariba::transport::tcpip::receiverThread().

uint16 protlib::TPMsg::get_oif (  )  [inline]

get Outgoing Interface

Definition at line 160 of file tp.h.

References oif.

const address * protlib::TPMsg::get_ownaddress (  )  const [inline]

set own address

Definition at line 216 of file tp.h.

References ownaddr.

Referenced by ariba::transport::tcpip::receiverThread().

const address * protlib::TPMsg::get_peeraddress (  )  const [inline]

get peer address

Definition at line 213 of file tp.h.

References peeraddr.

Referenced by protlib::TPoverTCP::receiver_thread(), and ariba::transport::tcpip::receiverThread().

TPError * protlib::TPMsg::set_error ( TPError e  )  [inline]

set TP error

Definition at line 246 of file tp.h.

References err.

NetMsg * protlib::TPMsg::set_message ( NetMsg m  )  [inline]

set network message

Definition at line 236 of file tp.h.

References msg.

void protlib::TPMsg::set_oif ( uint16  iface  )  [inline]

set Outgoing Interface

Definition at line 158 of file tp.h.

References oif.

address * protlib::TPMsg::set_ownaddress ( address a  )  [inline]

set own address

Definition at line 226 of file tp.h.

References ownaddr.

address * protlib::TPMsg::set_peeraddress ( address a  )  [inline]

set peer address

Definition at line 219 of file tp.h.

References peeraddr.


Member Data Documentation

Definition at line 169 of file tp.h.

Referenced by clear_pointers(), get_error(), set_error(), and ~TPMsg().

network message

Definition at line 168 of file tp.h.

Referenced by clear_pointers(), get_message(), set_message(), and ~TPMsg().

outgoing interface index

Definition at line 171 of file tp.h.

Referenced by get_oif(), and set_oif().

own address

Definition at line 166 of file tp.h.

Referenced by clear_pointers(), get_ownaddress(), set_ownaddress(), and ~TPMsg().

peer address

Definition at line 164 of file tp.h.

Referenced by clear_pointers(), get_peeraddress(), set_peeraddress(), and ~TPMsg().


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

Generated on Fri Aug 14 23:39:56 2009 for Ariba by  doxygen 1.5.8