Class: TInstalledTestServer

Declaration: InstalledTestServer.h

Taxonomy Categories:

Member Functions:

Interface Category:

Developer Tool Programmer Interface.

Inherits From:

TThreadProgram

Inherited By:

None.

Purpose:

Thread program that can be used to install a test server as a separate thread in the current task.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Use TInstalledTestServer directly. Do not derive.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TInstalledTestServer::TInstalledTestServer

TInstalledTestServer ()
TInstalledTestServer (const TText & serverName)
TInstalledTestServer (const TInstalledTestServer & source)

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Default constructor.
Constructor that takes the name of the test server.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Called by the Test framework and directly.
Called to copy an object.

Parameters:

Takes no parameters.
const TText & serverName -The name of the test server.
const TInstalledTestServer & source -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TInstalledTestServer::~TInstalledTestServer

virtual ~ TInstalledTestServer ()

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TInstalledTestServer::operator=

TInstalledTestServer & operator =(const TInstalledTestServer & other)

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TInstalledTestServer & other -The right-hand side object.

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: TInstalledTestServer::operator<<=

virtual TStream & operator <<= (TStream & fromwhere)

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromwhere -The stream the object is streamed in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TInstalledTestServer::operator>>=

virtual TStream & operator >>=(TStream & towhere) const

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & towhere -The stream the object is streamed out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TInstalledTestServer::Prepare

virtual void Prepare ()

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Overrides TThreadProgram::Prepare. It creates the local test server but does not start it up. This function is run in the current thread.

Calling Context:

Called by TTaligentTaskHandle constructor to initialize the thread program.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TInstalledTestServer::Run

virtual void Run ()

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Overrides TThreadProgram::Run. This function starts up the local test server and does a death watch on the dispatcher thread for the test server. This function is run in a new thread.

Calling Context:

Called by TTaligentTaskHandle constructor to run in a separate thread.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

If an exception is caught, an assertion is made.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TInstalledTestServer::StartLocalTestServer

static void StartLocalTestServer (const TText & serverName)

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Starts up a test server in the current thread.

Calling Context:

Call this function directly.

Parameters:

const TText & serverName -The name of the server.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.