BDE 4.14.0 Production release
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
balb::SimpleRequest Class Reference

#include <balb_testmessages.h>

Public Types

enum  { ATTRIBUTE_ID_DATA = 0 , ATTRIBUTE_ID_RESPONSE_LENGTH = 1 }
 
enum  { NUM_ATTRIBUTES = 2 }
 
enum  { ATTRIBUTE_INDEX_DATA = 0 , ATTRIBUTE_INDEX_RESPONSE_LENGTH = 1 }
 

Public Member Functions

 SimpleRequest (bslma::Allocator *basicAllocator=0)
 
 SimpleRequest (const SimpleRequest &original, bslma::Allocator *basicAllocator=0)
 
 ~SimpleRequest ()
 Destroy this object.
 
SimpleRequest & operator= (const SimpleRequest &rhs)
 Assign to this object the value of the specified rhs object.
 
template<class STREAM >
STREAM & bdexStreamIn (STREAM &stream, int version)
 
void reset ()
 
template<class MANIPULATOR >
int manipulateAttributes (MANIPULATOR &manipulator)
 
template<class MANIPULATOR >
int manipulateAttribute (MANIPULATOR &manipulator, int id)
 
template<class MANIPULATOR >
int manipulateAttribute (MANIPULATOR &manipulator, const char *name, int nameLength)
 
bsl::string & data ()
 
int & responseLength ()
 
bsl::ostream & print (bsl::ostream &stream, int level=0, int spacesPerLevel=4) const
 
template<class STREAM >
STREAM & bdexStreamOut (STREAM &stream, int version) const
 
template<class ACCESSOR >
int accessAttributes (ACCESSOR &accessor) const
 
template<class ACCESSOR >
int accessAttribute (ACCESSOR &accessor, int id) const
 
template<class ACCESSOR >
int accessAttribute (ACCESSOR &accessor, const char *name, int nameLength) const
 
const bsl::string & data () const
 
int responseLength () const
 

Static Public Member Functions

static int maxSupportedBdexVersion ()
 
static const bdlat_AttributeInfo * lookupAttributeInfo (int id)
 
static const bdlat_AttributeInfo * lookupAttributeInfo (const char *name, int nameLength)
 

Static Public Attributes

static const char CLASS_NAME []
 
static const bdlat_AttributeInfo ATTRIBUTE_INFO_ARRAY []
 

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
ATTRIBUTE_ID_DATA 
ATTRIBUTE_ID_RESPONSE_LENGTH 

◆ anonymous enum

anonymous enum
Enumerator
NUM_ATTRIBUTES 

◆ anonymous enum

anonymous enum
Enumerator
ATTRIBUTE_INDEX_DATA 
ATTRIBUTE_INDEX_RESPONSE_LENGTH 

Constructor & Destructor Documentation

◆ SimpleRequest() [1/2]

balb::SimpleRequest::SimpleRequest ( bslma::Allocator *  basicAllocator = 0)
explicit

Create an object of type SimpleRequest having the default value. Use the optionally specified basicAllocator to supply memory. If basicAllocator is 0, the currently installed default allocator is used.

◆ SimpleRequest() [2/2]

balb::SimpleRequest::SimpleRequest ( const SimpleRequest &  original,
bslma::Allocator *  basicAllocator = 0 
)

Create an object of type SimpleRequest having the value of the specified original object. Use the optionally specified basicAllocator to supply memory. If basicAllocator is 0, the currently installed default allocator is used.

◆ ~SimpleRequest()

balb::SimpleRequest::~SimpleRequest ( )

Member Function Documentation

◆ accessAttribute() [1/2]

template<class ACCESSOR >
int balb::SimpleRequest::accessAttribute ( ACCESSOR &  accessor,
const char *  name,
int  nameLength 
) const

Invoke the specified accessor on the (non-modifiable) attribute of this object indicated by the specified name of the specified nameLength, supplying accessor with the corresponding attribute information structure. Return the value returned from the invocation of accessor if name identifies an attribute of this class, and -1 otherwise.

◆ accessAttribute() [2/2]

template<class ACCESSOR >
int balb::SimpleRequest::accessAttribute ( ACCESSOR &  accessor,
int  id 
) const

Invoke the specified accessor on the (non-modifiable) attribute of this object indicated by the specified id, supplying accessor with the corresponding attribute information structure. Return the value returned from the invocation of accessor if id identifies an attribute of this class, and -1 otherwise.

◆ accessAttributes()

template<class ACCESSOR >
int balb::SimpleRequest::accessAttributes ( ACCESSOR &  accessor) const

Invoke the specified accessor sequentially on each (non-modifiable) attribute of this object, supplying accessor with the corresponding attribute information structure until such invocation returns a non-zero value. Return the value from the last invocation of accessor (i.e., the invocation that terminated the sequence).

◆ bdexStreamIn()

template<class STREAM >
STREAM & balb::SimpleRequest::bdexStreamIn ( STREAM &  stream,
int  version 
)

Assign to this object the value read from the specified input stream using the specified version format and return a reference to the modifiable stream. If stream is initially invalid, this operation has no effect. If stream becomes invalid during this operation, this object is valid, but its value is undefined. If version is not supported, stream is marked invalid and this object is unaltered. Note that no version is read from stream. See the bslx package-level documentation for more information on bdex streaming of value-semantic types and containers.

◆ bdexStreamOut()

template<class STREAM >
STREAM & balb::SimpleRequest::bdexStreamOut ( STREAM &  stream,
int  version 
) const

Write the value of this object to the specified output stream using the specified version format and return a reference to the modifiable stream. If version is not supported, stream is unmodified. Note that version is not written to stream. See the bslx package-level documentation for more information on bdex streaming of value-semantic types and containers.

◆ data() [1/2]

bsl::string & balb::SimpleRequest::data ( )
inline

Return a reference to the modifiable "Data" attribute of this object.

◆ data() [2/2]

const bsl::string & balb::SimpleRequest::data ( ) const
inline

Return a reference to the non-modifiable "Data" attribute of this object.

◆ lookupAttributeInfo() [1/2]

static const bdlat_AttributeInfo * balb::SimpleRequest::lookupAttributeInfo ( const char *  name,
int  nameLength 
)
static

Return attribute information for the attribute indicated by the specified name of the specified nameLength if the attribute exists, and 0 otherwise.

◆ lookupAttributeInfo() [2/2]

static const bdlat_AttributeInfo * balb::SimpleRequest::lookupAttributeInfo ( int  id)
static

Return attribute information for the attribute indicated by the specified id if the attribute exists, and 0 otherwise.

◆ manipulateAttribute() [1/2]

template<class MANIPULATOR >
int balb::SimpleRequest::manipulateAttribute ( MANIPULATOR &  manipulator,
const char *  name,
int  nameLength 
)

Invoke the specified manipulator on the address of the (modifiable) attribute indicated by the specified name of the specified nameLength, supplying manipulator with the corresponding attribute information structure. Return the value returned from the invocation of manipulator if name identifies an attribute of this class, and -1 otherwise.

◆ manipulateAttribute() [2/2]

template<class MANIPULATOR >
int balb::SimpleRequest::manipulateAttribute ( MANIPULATOR &  manipulator,
int  id 
)

Invoke the specified manipulator on the address of the (modifiable) attribute indicated by the specified id, supplying manipulator with the corresponding attribute information structure. Return the value returned from the invocation of manipulator if id identifies an attribute of this class, and -1 otherwise.

◆ manipulateAttributes()

template<class MANIPULATOR >
int balb::SimpleRequest::manipulateAttributes ( MANIPULATOR &  manipulator)

Invoke the specified manipulator sequentially on the address of each (modifiable) attribute of this object, supplying manipulator with the corresponding attribute information structure until such invocation returns a non-zero value. Return the value from the last invocation of manipulator (i.e., the invocation that terminated the sequence).

◆ maxSupportedBdexVersion()

int balb::SimpleRequest::maxSupportedBdexVersion ( )
inlinestatic

Return the most current bdex streaming version number supported by this class. See the bslx package-level documentation for more information on bdex streaming of value-semantic types and containers.

◆ operator=()

SimpleRequest & balb::SimpleRequest::operator= ( const SimpleRequest &  rhs)

◆ print()

bsl::ostream & balb::SimpleRequest::print ( bsl::ostream &  stream,
int  level = 0,
int  spacesPerLevel = 4 
) const

Format this object to the specified output stream at the optionally specified indentation level and return a reference to the modifiable stream. If level is specified, optionally specify spacesPerLevel, the number of spaces per indentation level for this and all of its nested objects. Each line is indented by the absolute value of level * spacesPerLevel. If level is negative, suppress indentation of the first line. If spacesPerLevel is negative, suppress line breaks and format the entire output on one line. If stream is initially invalid, this operation has no effect. Note that a trailing newline is provided in multiline mode only.

◆ reset()

void balb::SimpleRequest::reset ( )

Reset this object to the default value (i.e., its value upon default construction).

◆ responseLength() [1/2]

int & balb::SimpleRequest::responseLength ( )
inline

Return a reference to the modifiable "ResponseLength" attribute of this object.

◆ responseLength() [2/2]

int balb::SimpleRequest::responseLength ( ) const
inline

Return a reference to the non-modifiable "ResponseLength" attribute of this object.

Member Data Documentation

◆ ATTRIBUTE_INFO_ARRAY

const bdlat_AttributeInfo balb::SimpleRequest::ATTRIBUTE_INFO_ARRAY[]
static

◆ CLASS_NAME

const char balb::SimpleRequest::CLASS_NAME[]
static
The documentation for this class was generated from the following file: