ServiceReply

ServiceReply is used as the base class for classes generated by the Rose Expert that are used to encapsulate data returned by a call to a service.
 

Hierarchy

BEATuxBldr · ServiceReply
 

Description

The member functions of this class provide default behavior for Operation1Reply (Generated Service Reply) sub-classes that the Rose Expert creates for your application.

Note: Most of the member functions of this class are used by the framework. Very few need to be used in your applications.
 

Member Functions

This section lists the member functions of ServiceReply.

Table 4-25 ServiceReply Member Functions

Member Function Access Documented in

GetFlags

public

ServiceReply

GetReply

public

ServiceReply

GetTpqctl

public

ServiceReply

GetTpurcode

public

ServiceReply

ServiceReply

public

ServiceReply

SetFlags

public

ServiceReply

SetQoptions

public

ServiceReply

SetTpqctl

public

ServiceReply


 

GetFlags

GetFlags returns the value of the flag used by the underlying BEA TUXEDO ATMI call.
 

Synopsis

Long GetFlags()

 

GetReply

GetReply returns the result of the service request.
 

Synopsis

Boolean GetReply(FBFR* replyBuffer) 
throw(AtmiException*, AppException*)
Boolean GetReply(FBFR32* replyBuffer) 
throw(AtmiException*, AppException*)

 

Parameters

replyBuffer
This argument contains the information returned by BEA TUXEDO

 

Throws

AtmiException*
This exception is thrown when a BEA TUXEDO ATMI error has occurred.

AppException*
This exception is thrown when an error specific to the generated application has occurred.

 

Description

GetReply has two distinct signatures; one is used when code generated by the Rose Expert uses FML buffers and the other code generated by the Rose Expert uses FML32 buffers. Both member functions are identical in all other ways.

Note: This member function is for the exclusive use of the framework.

For more information about FML and FML32 buffers, refer to the BEA TUXEDO Reference Manual (see Where to Find Related Information).
 

GetTpqctl

GetTpqctl returns a reference to the TPQCTL structure.
 

Synopsis

TPQCTL* GetTPqctl()

 

Description

The TPQCTL structure is used to pass and retrieve parameters associated with queuing a message. There is no unique "Get" or "Set" operation for each data member of the TPQCTL structure. If you wish to examine or modify the TPQCTL structure, use GetTpqctl to get a pointer to the structure, and SetTpqctl save your changes. You can make changes directly to the TPQCTL structure, or copy the TPQCTL structure to a temporary structure, make your changes to the temporary structure and use SetTpqctl to save the temporary structure to the ServiceReply object.

For more information about the BEA TUXEDO TPQCTL structure, refer to the BEA TUXEDO Reference Manual (see Where to Find Related Information).
 

GetTpurcode

GetTpurcode returns a C++ ATMI framework specific error code.
 

Synopsis

Int const GetTpurcode()

 

Description

Note: This member function is used exclusively by the framework.
 

ServiceReply


 

Synopsis

ServiceReply(int cd)

 

Description

This is the constructor for this class.

Note: This constructor is used exclusively by the framework.
 

SetFlags

SetFlags specifies the value of the flag used by the underlying BEA TUXEDO ATMI call.
 

Synopsis

void SetFlags(flags: Long)

 

Description

For more information about the BEA TUXEDO flags variable, refer to the BEA TUXEDO Reference Manual (see Where to Find Related Information).
 

SetQoptions


 

Synopsis

void SetQoptions(const char* qspace, const char* qname, 
const char* replyQue, const char* failureQue)

 

Parameters

qspace
A queue space is a collection of queues. The qspace parameter identifies a specific queue space.

qname
The name of a service provided by a BEA TUXEDO server application within the queue space specified by qspace.

replyQue
The name of the queue where reply messages are placed within the queue space specified by qspace.

failureQue
The name of the queue where failure messages are placed within the queue space specified by qspace.

 

Description

SetQoptions is used by the generated code to identify the pending reply to BEA TUXEDO.
 

SetTpqctl

SetTpqctl specifies the value of the TPQCTL structure.


 

Synopsis

void SetTpqctl(TPQCTL*)

 

Description

There is no unique "Get" or "Set" operation for each data member of the TPQCTL structure. If you wish to examine or modify the TPQCTL structure, use GetTpqctl to get a reference to the structure, and SetTpqctl specify changes.