DRAMA C++ Intro   Class Hierarchy   Alphabetical List of types   List of Classes   File List   Class Member Index   File Members Index   Related Pages  

DcppBuffers Class Reference

#include <dcpp.h>

List of all members.


Detailed Description

A structure representing message buffer sizes.

DcppBuffers stores message buffer sizes. Routines allow access to each component. Normally the user constructs such an object with the other details used by DcppTask when getting a path to a task.

See also:
DcppTask , DitsPathGet()


Public Methods

 DcppBuffers (long int MessageBytes=800, long int MaxMessages=2, long int ReplyBytes=800, long int MaxReplies=2)
 Construct a DcppBuffers object from indivual specifications.

 DcppBuffers (const DitsPathInfoType &i)
 Construct a DcppBuffers object from a DitsPathInfoType variable.

 operator const DitsPathInfoType * () const
 Return the DitsPathInfoType data for this object.

long int MessageBytes () const
 Return the message bytes specification.

long int MaxMessages () const
 Return the Max Messages specification.

long int ReplyBytes () const
 Return the reply bytes specification.

long int MaxReplies () const
 Return the Max Replies specification.


Constructor & Destructor Documentation

DcppBuffers::DcppBuffers long int    MessageBytes = 800,
long int    MaxMessages = 2,
long int    ReplyBytes = 800,
long int    MaxReplies = 2
[inline]
 

Construct a DcppBuffers object from indivual specifications.

See also:
DitsPathGet()
Parameters:
MessageBytes  The number of bytes in a typical message.
MaxMessages  The maximum number of typical messages which might be outstanding at any time.
ReplyBytes  The number of bytes in a typical reply message.
MaxReplies  The maximum number of typical reply messages which might be outstanding at any time.

DcppBuffers::DcppBuffers const DitsPathInfoType &    i [inline]
 

Construct a DcppBuffers object from a DitsPathInfoType variable.

See also:
DitsPathGet
Parameters:
i  The buffer specification.


Member Function Documentation

long int DcppBuffers::MaxMessages   const [inline]
 

Return the Max Messages specification.

long int DcppBuffers::MaxReplies   const [inline]
 

Return the Max Replies specification.

long int DcppBuffers::MessageBytes   const [inline]
 

Return the message bytes specification.

DcppBuffers::operator const DitsPathInfoType *   const [inline]
 

Return the DitsPathInfoType data for this object.

long int DcppBuffers::ReplyBytes   const [inline]
 

Return the reply bytes specification.


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

Click here for the DRAMA home page and here for the AAO home page.

For more information, contact tjf@aaoepp.aao.gov.au 

Generated on Tue Nov 3 09:09:56 2009 for AAO DRAMA C++ Interfaces by doxygen 1.2.18