Tuxedo .NET Workstation Client API Reference

 

Namespaces

The Tuxedo .NET Workstation Client APIsare divided into two categories:Tuxedo ATMI C functions and ATMI FML functions and are contained in the namespace Bea.Tuxedo.ATMI and Bea.Tuxedo.FML respectively. To use these classes and methods, corresponding namespaces must be imported via C# statement either ¡°using Bea.Tuxedo.ATMI¡± or ¡°using Bea.Tuxedo.FML¡± or both.

Bea.Tuxedo.ATMI

This namespace includes all the classes and structures related to the functions listed in the ATMI C Function Reference section of Tuxedo 9.0 eDoc.

Bea.Tuxedo.FML

This namespace includes all the classes and structures related to the functions listed in the ATMI FML Function Reference section of Tuxedo 9.0 eDoc.

 

Classes

The Tuxedo .NET Workstation Client consists of the following classes, structures and delegates:

Class

namespace

Description

AppContext

Bea.Tuxedo.ATMI

Represents the application context that most ATMI functions operate on

AsyncCallDescriptor

Bea.Tuxedo.ATMI

Represents the handle returned by tpacall

ATMIC

Bea.Tuxedo.ATMI

Defines all the constants that ATMI programming will use (moved from atmi.h)

BufferType

Bea.Tuxedo.ATMI

Defines all the buffer types that Tuxedo supports

carray

Bea.Tuxedo.ATMI

Represents the carray type used in VIEW/VIEW32 programming

CLIENTID

Bea.Tuxedo.ATMI

The substitute for ATMI C type CLIENTID used in ATMI functions

ConversationDescriptor

Bea.Tuxedo.ATMI

Represents the handle returned by tpconnect

dec_t

Bea.Tuxedo.FML

The wrapper class for decimal functions

FException

Bea.Tuxedo.FML

Base class to represent an exception for an error generated from FML functions

FALIGNERRException

Bea.Tuxedo.FML

The substitute of FML error code FALIGNERR

FBADACMException

Bea.Tuxedo.FML

The substitute of FML error code FBADACM

FBADFLDException

Bea.Tuxedo.FML

The substitute of FML error code FBADFLD

FBADNAMEException

Bea.Tuxedo.FML

The substitute of FML error code FBADNAME

FBADTBLException

Bea.Tuxedo.FML

The substitute of FML error code FBADTBL

FBADVIEWException

Bea.Tuxedo.FML

The substitute of FML error code FBADVIEW

FEBADOPException

Bea.Tuxedo.FML

The substitute of FML error code FEBADOP

FEINVALException

Bea.Tuxedo.FML

The substitute of FML error code FEINVAL

FEUNIXException

Bea.Tuxedo.FML

The substitute of FML error code FEUNIX

FFTOPENException

Bea.Tuxedo.FML

The substitute of FML error code FFTOPEN

FFTSYNTAXException

Bea.Tuxedo.FML

The substitute of FML error code FFTSYNTAX

FMALLOCException

Bea.Tuxedo.FML

The substitute of FML error code FMALLOC

FNOCNAMEException

Bea.Tuxedo.FML

The substitute of FML error code FNOCNAME

FNOSPACEException

Bea.Tuxedo.FML

The substitute of FML error code FNOSPACE

FNOTFLDException

Bea.Tuxedo.FML

The substitute of FML error code FNOTFLD

FNOTPRESException

Bea.Tuxedo.FML

The substitute of FML error code FNOTPRES

FSYNTAXException

Bea.Tuxedo.FML

The substitute of FML error code FSYNTAX

FTYPERRException

Bea.Tuxedo.FML

The substitute of FML error code FTYPERR

FVFOPENException

Bea.Tuxedo.FML

The substitute of FML error code FVFOPEN

FVFSYNTAXException

Bea.Tuxedo.FML

The substitute of FML error code FVFSYNTAX

FILE

Bea.Tuxedo.FML

A wrapper class for standard IO functions such as fopen etc used by FML functions

FieldType

Bea.Tuxedo.FML

This enumeration defines all the field types FML/FML32 supports

FLDID

Bea.Tuxedo.FML

The substitute for ATMI C type FLDID used in FML functions

FLDLEN

Bea.Tuxedo.FML

The substitute for ATMI C type FLDLEN used in FML functions

FLDOCC

Bea.Tuxedo.FML

The substitute for ATMI C type FLDOCC used in FML functions

FMLC

Bea.Tuxedo.FML

Defines all the constant that FML programming will use (moved from fml.h and fml32.h)

LONG

Bea.Tuxedo.ATMI

This struct defines a type of integer which has same number of bits with the long type used by arguments of ATMI C and FML functions. (mainly for the purpose of interoperating with functions in Tuxedo libraries such as libwsc.dll, libfml.dll and libfml32.dll)

MEMBER

Bea.Tuxedo.FML

This class is used to describe the information such as offset, length etc of a member of C structure and is used in automatically generated sub-classes of TypedView and TypedView32 in FML programming

SubscriptionHandle

Bea.Tuxedo.ATMI

Represents the handle returned by tpsubscribe

TPEVCTL

Bea.Tuxedo.ATMI

The substitute for ATMI C type TPEVCTL used by ATMI C function tpsubscribe

TPKEY

Bea.Tuxedo.ATMI

The substitute for ATMI C type TPKEY used by ATMI C functions tpkey_open, tpkey_close etc

TPQCTL

Bea.Tuxedo.ATMI

The substitute for ATMI C type TPQCTL used by ATMI C functions tpenqueue and tpdequeue

TPTRANID

Bea.Tuxedo.ATMI

The substitute for ATMI C type TPTRANID used by ATMI C functions such as tpsuspend and tpresume

TypedBuffer

Bea.Tuxedo.ATMI

The base class to represent a Tuxedo typed buffer

TypedCArray

Bea.Tuxedo.ATMI

The derived class for CARRAY typed buffer

TypedFML

Bea.Tuxedo.FML

The derived class for 16-bit FML typed buffer

TypedFML32

Bea.Tuxedo.FML

The derived class for 32-bit FML typed buffer

TypedString

Bea.Tuxedo.ATMI

The derived class for STRING typed buffer

TypedTPINIT

Bea.Tuxedo.ATMI

The derived class for TPINIT typed buffer used in ATMI C functions such as tpinit

TypedUnknown

Bea.Tuxedo.ATMI

The derived class to represent a unrecognized kind of typed buffer

TypedView

Bea.Tuxedo.FML

The derived class for 16-bit VIEW typed buffer

TypedView32

Bea.Tuxedo.FML

The derived class for 32-bit VIEW typed buffer

TypedXML

Bea.Tuxedo.ATMI

The derived class for XML typed buffer

TPException

Bea.Tuxedo.ATMI

Base class to represent an exception for an error generated from ATMI C functions

TPEABORTException

Bea.Tuxedo.ATMI

The substitute of ATMI error code TPEABORT

TPEBADDESCException

Bea.Tuxedo.ATMI

The substitute of ATMI error code TPEBADDESC

TPEBLOCKException

Bea.Tuxedo.ATMI

The substitute of ATMI error code TPEBLOCK

TPECLASSNOTFOUNDException

Bea.Tuxedo.ATMI

This derived class is a newly added exception and have no counterpart in ATMI error code

TPEDIAGNOSTICException

Bea.Tuxedo.ATMI

The substitute of ATMI error code TPEDIAGNOSTIC

TPEEVENTException

Bea.Tuxedo.ATMI

The substitute of ATMI error code TPEEVENT

TPEFIXEDBUFException

Bea.Tuxedo.ATMI

This derived class is a newly added exception and have no counterpart in ATMI error code

TPEHAZARDException

Bea.Tuxedo.ATMI

The substitute of ATMI error code TPEHAZARD

TPEHEURISTICException

Bea.Tuxedo.ATMI

The substitute of ATMI error code TPEHEURISTIC

TPEINVALException

Bea.Tuxedo.ATMI

The substitute of ATMI error code TPEINVAL

TPEITYPEException

Bea.Tuxedo.ATMI

The substitute of ATMI error code TPEITYPE

TPELIMITException

Bea.Tuxedo.ATMI

The substitute of ATMI error code TPELIMIT

TPEMATCHException

Bea.Tuxedo.ATMI

The substitute of ATMI error code TPEMATCH

TPEMIBException

Bea.Tuxedo.ATMI

The substitute of ATMI error code TPEMIB

TPENOENTException

Bea.Tuxedo.ATMI

The substitute of ATMI error code TPENOENT

TPEOSException

Bea.Tuxedo.ATMI

The substitute of ATMI error code TPEOS

TPEOTYPEException

Bea.Tuxedo.ATMI

The substitute of ATMI error code TPEOTYPE

TPEPERMException

Bea.Tuxedo.ATMI

The substitute of ATMI error code TPEPERM

TPEPROTOException

Bea.Tuxedo.ATMI

The substitute of ATMI error code TPEPROTO

TPERELEASEException

Bea.Tuxedo.ATMI

The substitute of ATMI error code TPERELEASE

TPERMERRException

Bea.Tuxedo.ATMI

The substitute of ATMI error code TPERMERR

TPESVCERRException

Bea.Tuxedo.ATMI

The substitute of ATMI error code TPESVCERR

TPESVCFAILException

Bea.Tuxedo.ATMI

The substitute of ATMI error code TPESVCFAIL

TPESWITCHCTXTException

Bea.Tuxedo.ATMI

This derived class is a newly added exception and have no counterpart in ATMI error code

TPESYSTEMException

Bea.Tuxedo.ATMI

The substitute of ATMI error code TPESYSTEM

TPETBFVINSTANCEException

Bea.Tuxedo.ATMI

This derived class is a newly added exception and have no counterpart in ATMI error code

TPETBNOTSUPTException

Bea.Tuxedo.ATMI

This derived class is a newly added exception and have no counterpart in ATMI error code

TPETIMEException

Bea.Tuxedo.ATMI

The substitute of ATMI error code TPETIME

TPETRANException

Bea.Tuxedo.ATMI

The substitute of ATMI error code TPETRAN

TPGOTSIGException

Bea.Tuxedo.ATMI

The substitute of ATMI error code TPGOTSIG

Transaction

Bea.Tuxedo.ATMI

Includes all the transaction control functions such as tpbegin, tpcommit etc.

Utils

Bea.Tuxedo.ATMI

Provides some utility methods.

UnsolicitedMessageHandler

Bea.Tuxedo.ATMI

This delegate defines the prototype of the unsolicited message handler

XID

Bea.Tuxedo.ATMI

The substitute for ATMI C type XID used by ATMI C function such as tpconvert