StOpenTptOperation

StOpenTptOperation is a PowerPlant class that is used for encapsulating an Open Transport operation. It manages thread blocking for OpenTransport interface calls.

Methods :

The methods in this class are:

StOpenTptOperation()	~StOpenTptOperation()
GetCookie()	GetEventCode()
GetResultCode()	Int_TimerProc()
OperationTimedOut()	SetEventCode()
WaitForCompletion()	WaitForResult()

Data Members:

The data members in this class are:

mNotifHandler	mEventCode
mCookieTest	mTestCookie
mResultCode	mCookie
mOperationTimeout	sOTOpTimerUPP

Source files:

(Networking Classes)

UOpenTptOperation.h

UOpenTptOperation.cp

See also:

LGlobalsContext

StOpenTptOperation()

Purpose:

The constructor creates the object.

Access :

Public

Prototype:

StOpenTptOperation(

This constructor has the following parameter:

LOpenTptNotifHandler*	inNotifHandler	This is the Open Transport notification handler.
OTEventCode	inEventCode	The event code.
void*	inCookieTest	The cookie test value.
Boolean	inTestCookie	Whether to test the cookie.

~StOpenTptOperation()

Purpose:

The destructor destroys the object.

Access :

Public

Prototype:

~StOpenTptOperation();

GetCookie()

Purpose:

Returns the value of mCookie.

Access :

Public

Prototype:

void* GetCookie();

None

Return:

The value of mCookie.

GetEventCode()

Purpose:

Return the value of mEventCode.

Access :

Public

Prototype:

OTEventCode GetEventCode();

None

Return:

The value of mEventCode.

GetResultCode()

Purpose:

Return the value of mResultCode.

Access :

Public

Prototype:

OTResult GetResultCode();

None

Return:

The value of mResultCode.

Int_TimerProc()

Purpose:

Install a Time Manager proc.

Access :

Static, Protected

Prototype:

pascal void Int_TimerProc(TMTaskPtr tmTaskPtr

	: __A1

	#endif);

The parameter is the pointer to a Time Manager task block.

Return:

None

OperationTimedOut()

Purpose:

Return the value of mOperationTimeout.

Access :

Public

Prototype:

Boolean OperationTimedOut();

None

Return:

The value of mOperationTimeout.

SetEventCode()

Purpose:

Set the value of mEventCode.

Access :

Public

Prototype:

void SetEventCode(OTEventCode inEventCode);

This method has the following parameter:

OTEventCode

inEventCode

The Open Transport event code.

Return:

None

WaitForCompletion()

Purpose:

Wait for the Time Manager task to complete.

Access :

Public

Prototype:

void WaitForCompletion( UInt32 inTimeoutSeconds);

This method has the following parameter:

UInt32

inTimeoutSeconds

The Open Transport event code.

Return:

None

WaitForResult()

Purpose:

This method breaks into the debugger with a call to DebugStr().

Access :

Public

Prototype:

void WaitForResult();

None

Return:

None

mNotifHandler

Purpose:

The notification handler.

Access :

Protected

Prototype:

LOpenTptNotifHandler * mNotifHandler;

mEventCode

Purpose:

The event code.

Access :

Protected

Prototype:

OTEventCode mEventCode;

mCookieTest

Purpose:

The test cookie.

Access :

Protected

Prototype:

void * mCookieTest;

mTestCookie

Purpose:

Whether to test the cookie.

Access :

Protected

Prototype:

Boolean mTestCookie;

mResultCode

Purpose:

The result code.

Access :

Protected

Prototype:

OTResult mResultCode;

mCookie

Purpose:

The cookie pointer.

Access :

Protected

Prototype:

void* mCookie;

mOperationTimeout

Purpose:

Operation timed out.

Access :

Protected

Prototype:

Boolean mOperationTimeout;

sOTOpTimerUPP

Purpose:

The Open Transport operation timer proc pointer.edure

Access :

Static, Protected

Prototype:

TimerUPP sOTOpTimerUPP;