Generated Service Request

Interface1 (Generated Service Request Class) is used by client applications to make service requests to the co-responding Interface1Impl (Generated Service Implementation) object.
 

Hierarchy

Module1 · Interface1 (Abstract Base Class) · Interface1 (Generated Service Request Class)
 

Description

For each interface in a module in the Contract Repository, a class of this type is derived from the Abstract Interface class Module1::Interface1. The member functions of this class are mapped onto BEA TUXEDO service requests, and has code to marshal operation parameters to FML buffers, and throw exceptions specific to BEA TUXEDO system error codes and exceptions specific to this operation. Refer to TuxException and Operation1Exception (Generated Exception) for more information about these exceptions.

Objects of this class serve as a local surrogate to the remote Interface1Impl (Generated Service Implementation) object running in the application server and are used to make service requests to that object. These objects are stateless and can be reused for subsequent service requests or deleted, as desired. The output argument values (specified in the Contract Repository interface definition) are available as data members in Operation1Reply (Generated Service Reply) and can be retrieved by the member functions of that class.

Warning: The client application is responsible for the deletion of Interface1 objects. Interface1 does not support copy semantics.
 

Data Types

This section lists the data types of Generated Service Request class

Table 4-15 Generated Service Request Data Types

Data Type	Access	Documented in
InvocationType	public	Generated Service Request

InvocationType

InvocationType is an enumerated type that indicates the type of service request. Valid values for invoke are:

Table 4-16 Generated Service Request InvocationType Modes

Name	Description
INVALID	Used internally when one of the other invocation types is not specified.
ASYNCHRONOUS	Requestor does not wait for the response but will poll for it at a later time.
FORWARD	Request is sent on to another service that will complete the work and reply to the original requestor.
QUEUED	Request is deferred. The request is stored in a queue until communications can be completed.
SYNCHRONOUS	Requestor waits for a response.This is the default value of invoke, and is reset to the default after every service request.

Use GetInvoke to determine the current value of InvocationType, and SetInvoke to specify a new value.
 

Member Functions

This section lists the member functions of the Generated Service Request class.

Table 4-17 Generated Service Request Member Functions

Member Function	Access	Documented in
GetFlags	public	Generated Service Request
GetInvoke	public	Generated Service Request
GetTpqctl	public	Generated Service Request
Operation1	public	Generated Service Request
SetFlags	public	Generated Service Request
SetInvoke	public	Generated Service Request
SetQoptions	public	Generated Service Request
SetTpqctl	public	Generated Service Request

GetFlags

GetFlags returns the value of flags.
 

Synopsis

The flags variable specifies which flags of the underlying BEA TUXEDO ATMI call is set. For more information about queueing, refer to tpenqueue in the BEA TUXEDO Reference Manual (see Where to Find Related Information).
 

GetInvoke

GetInvoke returns the value of InvocationType, which indicates the type of service request
 

Synopsis

GetTpqctl returns the a reference to the TPQCTL structure.
 

Synopsis

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 Interface1 (Generated Service Request Class) object.

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

Operation1

Operation1 is a generated member function that makes a request to a BEA TUXEDO service with the same name.
 

Synopsis

parameter1

Generated parameter of a simple type.

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

Synopsis

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

SetInvoke

SetInvoke specifies the service invocation type by setting the value of InvocationType.
 

Synopsis

SetQoptions is used to specify the parameters of a queued service request.
 

Synopsis

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

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.

SetQoptions must be called with the required parameters before invoking Operation1 on this generated service request object.
 

SetTpqctl

SetTpqctl specifies the value of the TPQCTL structure.
 

Synopsis

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