Generated Service Reply

Operation1Reply provides data members and member functions specific to each service in a server application. These member functions can be used to retrieve the results of a service request to a server application.
 

Hierarchy

BEATuxBldr · ServiceReply · Operation1Reply (Generated Service Reply)
 

Description

For operations in the Rose Model with out and/or inout parameters, the Rose Expert generates a class whose data members are the operation parameters of the out and/or inout kind. The name of the each parameter is used in the name of the corresponding generated data member and accessor member function.

For operations with an output parameter of a simple type, the generated data member and member function will be declared with that type. In the GetGetparameter2 example below, the parameter2 data member is an integer, which the GetGetparameter2 member function returns. The other simple types supported by the Rose Expert are listed in the Programming Model and Data Type Mapping section.

For operations with an output parameter of an aggregate type (for example, a structure type), the generated data member and member function will be declared as a structure. In the parameter3 example below, the parameter3 data member is a structure, and the Getparameter3 member function returns a pointer to that structure.

Warning: It is the responsibility of the client application to delete the reply object obtained from a service invocation. Deleting a reply object with a pending reply results in that outstanding reply being canceled.

Only the specific outstanding reply can be obtained. There is no support for retrieving "any" outstanding reply. The Rose Expert does not have any notion of a session associated with a service request, nor does it generate any code for maintaining the context in which a service request was made.

Rather than generating a get and set member function for each of the data members in the TPQCTL structure, GetTpqctl can be used to get a reference to the structure and SetTpqctl can be used to save any changes you make to that structure. The TPQCTL structure give you control of queueing operations when you wish to override the default operation of the queue. For more information about queueing, refer to tpenqueue in the BEA TUXEDO Reference Manual (see Where to Find Related Information).
 

Member Functions

This section lists the member functions of Generated Service Reply.

Table 4-14 Generated Service Reply Member Functions

Member Function Access Documented in

Getparameter2

public

Operation1Reply (Generated Service Reply)

Getparameter3

public

Operation1Reply (Generated Service Reply)

GetFlags

public

ServiceReply

GetReply

public

ServiceReply

GetTpqctl

public

ServiceReply

GetTpurcode

public

ServiceReply

ReplyCompleted

public

Operation1Reply (Generated Service Reply)

ServiceReply

public

ServiceReply

SetFlags

public

ServiceReply

SetQoptions

public

ServiceReply

SetTpqctl

public

ServiceReply


 

Getparameter2

Generated member function that returns a simple type.
 

Synopsis

int Getparameter2()

 

Returns

parameter2
A generated data member that contains a simple type
 

Description

The name of a generated member function is the same as the name of the parameter in the Rose Model, with the Get prepended. Calls to this member function returns the value of the parameter of the same name. For example, the Operation1Reply::Getparameter2() member function would return the value of the Operation1Reply::parameter2 data member.
 

parameter3

Generated data member that contains an aggregate type.
 

Synopsis

struct Struct1* Getparameter3()

 

Returns

parameter3*
A pointer to a generated data member that contains an aggregate type
 

Description

The name of a generated member function is the same as the name of the parameter in the Rose Model, with the Get prepended. Calls to this member function returns a pointer to a structure of the same name. or example, the Operation1Reply::Getparameter3() member function would return a pointer to the Operation1Reply::parameter3 data member.
 

ReplyCompleted

ReplyCompleted is used to determine when data has been returned by the service request.
 

Synopsis

Boolean ReplyCompleted() throw (TuxException*, 
Operation1Exception*)

 

Returns

TRUE
If service reply data can be obtained from Operation1Reply.

FALSE
If service reply data is not yet available from Operation1Reply.

 

Throws

TuxException*
This exception is thrown when an error is generated by BEA TUXEDO. Refer to TuxException for more information.

Operation1Exception* (Generated Exception)
A generated exception associated with Operation1.

 

Description

ReplyCompleted determines if a reply to the service request is available. For synchronous service requests, the reply is available on return from the service call. For asynchronous requests, the client must collect the outstanding reply, if it is available. Your application can determine when a reply is available by polling.

Once a call to ReplyCompleted returns TRUE, any further invocation on the same reply object raises an AtmiException.