Class: TRemoteTestCaller

Declaration: RemoteTestCaller.h

Taxonomy Categories:

Member Functions:

Interface Category:

Developer Tool Programmer Interface.

Inherits From:

MRemoteCaller

Inherited By:

None.

Purpose:

A Communications caller class that allows a client to run tests in a different address space or on a different machine.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive from this class.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TRemoteTestCaller::TRemoteTestCaller

  1. TRemoteTestCaller ()
  2. TRemoteTestCaller (TRemoteCallerTransport * theTransport)
  3. TRemoteTestCaller (const TRemoteTestCaller &)

Interface Category:

Developer Tool Programmer Interface.

Purpose:

  1. Default constructor.
  2. Constructor which takes caller transport.
  3. Copy constructor.

Calling Context:

  1. Called by the stream-in operators and RunTest.
  2. Called by RunTest.
  3. Called to copy an object.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRemoteTestCaller::operator=

TRemoteTestCaller & operator =(const TRemoteTestCaller &)

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRemoteTestCaller::~TRemoteTestCaller

virtual ~ TRemoteTestCaller ()

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRemoteTestCaller::NewRun

virtual TTest * NewRun (const TTest & testToRun)

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Streams a test to the dispatcher, runs it within the dispatcher, then streams it back.

Calling Context:

Called by RunTest and directly.

Parameters:

Return Value:

Returns the test after it is run.

Exceptions:

Throws TStandardException if unable to get transport to the dispatcher.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRemoteTestCaller::Run

  1. virtual TTest * Run (const TText & commandLine)
  2. virtual TTest * Run (const TSequenceOf < TText > & commandArgs)

Interface Category:

Developer Tool Programmer Interface.

Purpose:

  1. Streams the given <commandLine> to the dispatcher. The dispatcher instantiates a test using the command line, runs it, and streams it back to Run.
  2. Streams the given <commandArgs> to the dispatcher. The dispatcher instantiates a test using the command args, runs it, and streams it back to Run. If the command args are bad, 0 is streamed back.

Calling Context:

  1. Call this function directly.
  2. Call this function directly.

Parameters:

Return Value:

Returns the test that was run.

Exceptions:

Throws TStandardException if unable to get transport to the dispatcher.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRemoteTestCaller::Queue

  1. virtual void Queue (TTest & testToQueue)
  2. virtual void Queue (const TText & commandLine)
  3. virtual void Queue (const TSequenceOf < TText > & commandArgs)

Interface Category:

Developer Tool Programmer Interface.

Purpose:

  1. Adds the test to the end of the queue of tests to be run.
  2. Instantiates the test by name using the given command line and adds the test to the end of the queue of tests to be run.
  3. Instantiates the test by name using the given command arguments and adds the test to the end of the queue of tests to be run.

Calling Context:

  1. Called by RunTest and directly.
  2. Call this function directly.
  3. Call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws TStandardException if unable to get transport to the dispatcher.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRemoteTestCaller::GetQueueLength

virtual long GetQueueLength ()

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Gets number of queued tests.

Calling Context:

Called by test dispatcher and directly.

Parameters:

Return Value:

Returns the number of queued tests.

Exceptions:

Throws TStandardException if unable to get transport to the dispatcher.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRemoteTestCaller::CopyQueue

virtual void CopyQueue (TSequenceOf < TTest > &)

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Copies the tests in the queue to the given collection.

Calling Context:

Call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws TStandardException if unable to get transport to the dispatcher.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRemoteTestCaller::TerminateServer

virtual void TerminateServer ()

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Terminates the server that is handling the requests.

Calling Context:

Call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws TStandardException if unable to get transport to the dispatcher.

Concurrency:

Not multithread safe.

Other Considerations:

None.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.