drama::EntryInfo Class Reference

Detailed Description

The EntryInfo class is used to access details about a DRAMA message event (and entry to an action).

#include "entryinfo.hh"

Public Member Functions
	EntryInfo ()
	Construct the EntryInfo item. More...
bool	ArgIsBulk () const
	Indicates if the action argument was transferred using bulk data techniques. More...
sds::Id	Argument () const
	Return any SDS argument to the action entry. More...
bool	Complete () const
	Indicate if any transaction associated with this entry is complete. More...
std::string	EntryName () const
	Return the name associated with the entry. More...
DitsPathType	EntryPath () const
	Returns the path associated with the current action entry, if any. More...
std::string	EntryTaskName () const
	Returns the task name of the path associated with the action entry, if any. More...
DitsTransIdType	EntryTransId () const
	Return the transaction id associated with the entry. More...
DitsBulkInfoType	GetBulkInfo () const
	Return bulk transfer info. More...
long int	LoadErrorStatus () const
	Returns the system status code associated with a load error. More...
std::string	LoadErrText () const
	Returns the system status code text associated with a load error. More...
EntryCode	Reason () const
	Return the reason associated with the action entry. More...
unsigned long	Sequence () const
	Return the Action sequence count. More...
void	SetFromDits ()
	Grab the information of interest from DITS. More...
StatusType	Status () const
	Return the status associated with the action entry. More...

Constructor & Destructor Documentation

drama::EntryInfo::EntryInfo ( )

inline

Construct the EntryInfo item.

Member Function Documentation

bool drama::EntryInfo::ArgIsBulk ( ) const

inline

Indicates if the action argument was transferred using bulk data techniques.

This will only return true if the argument is bulk and XXXX has not been invoked.

Returns

True if the argument to the message is a bulk data item.

sds::Id drama::EntryInfo::Argument ( ) const

inline

Return any SDS argument to the action entry.

Returns

The action entry argument.

Examples:

dramahello.cpp.

References drama::sds::Id::CreateFromSdsIdType().

bool drama::EntryInfo::Complete ( ) const

inline

Indicate if any transaction associated with this entry is complete.

std::string drama::EntryInfo::EntryName ( ) const

inline

Return the name associated with the entry.

DitsPathType drama::EntryInfo::EntryPath ( ) const

inline

Returns the path associated with the current action entry, if any.

Returns

The path, nullptr if there is none.

std::string drama::EntryInfo::EntryTaskName ( ) const

inline

Returns the task name of the path associated with the action entry, if any.

Returns

The task name, empty string if there is none.

References DramaTHROW.

DitsTransIdType drama::EntryInfo::EntryTransId ( ) const

inline

Return the transaction id associated with the entry.

Returns

The transaction id. If none, then nullptr.

DitsBulkInfoType drama::EntryInfo::GetBulkInfo ( ) const

inline

Return bulk transfer info.

This information is valid when the entry reason is EntryCode::BulkTransferred or EntryCode::BulkDone.

The fields in DitsBulkInfoType of interest are as follows

TotalBytes => This is the total number of bytes to be transferred. Taken from the original sending call. TransferredBytes => This is the number of bytes

Returns

Information on a bulk transfer.

long int drama::EntryInfo::LoadErrorStatus ( ) const

inline

Returns the system status code associated with a load error.

When a load operation fails or a task which had been loaded exits, the system status is returned. This function fetches this value. This function only give a sensible result sensible if Reason() has returned a reason of EntryCode::LoadFailed or EntryCode::Exit

In addition, this value may be hard to interpret is the load was on a remote machine, so DitsLoadErrorText may be more appropriate.

Returns

The load error status or zero.

std::string drama::EntryInfo::LoadErrText ( ) const

inline

Returns the system status code text associated with a load error.

When a load operation fails or a task which had been loaded exits, the system status is returned. This function fetches a text representation of this code as translated by the machine on which the load was preformed.

This function only give a sensible result sensible if Reason() has returned a reason of EntryCode::LoadFailed or EntryCode::Exit

Returns

The load error text or an empty string.

References drama::LoadFailed, and Reason().

EntryCode drama::EntryInfo::Reason ( ) const

inline

Return the reason associated with the action entry.

Returns

A DRAMA action entry reason.

Referenced by LoadErrText().

unsigned long drama::EntryInfo::Sequence ( ) const

inline

Return the Action sequence count.

void drama::EntryInfo::SetFromDits ( )

inline

Grab the information of interest from DITS.

Normally only executed from within DRAMA2 code. Not intended for use by application code.

Referenced by drama::thread::TUface::GrabEntryInfo(), and drama::MessageHandler::GrabEntryInfo().

StatusType drama::EntryInfo::Status ( ) const

inline

Return the status associated with the action entry.

This would normally be the status associated with completion of a message sent to a subsidiary task.

Returns

The DRAMA Status code associated with the entry.

---

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

• entryinfo.hh