Class: TDispatcherChildDirectory

Declaration: RemoteDispatcher.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

TDispatcherChildDictionary

Purpose:

TDispatcherChildDirectory is a class used in the default implementation of child objects to associate child objects with their corresponding ChildIDs.

Instantiation:

Abstract class ; cannot be instantiated.

Deriving Classes:

TDispatcherChildDictionary is derived from TDispatcherChildDirectory.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TDispatcherChildDirectory::TDispatcherChildDirectory

TDispatcherChildDirectory ()
TDispatcherChildDirectory (const TDispatcherChildDirectory & theDirectory)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators and by derived classes.
Called to copy an object. Called by derived classes.

Parameters:

Takes no parameters.
const TDispatcherChildDirectory & theDirectory -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: TDispatcherChildDirectory::~TDispatcherChildDirectory

virtual ~ TDispatcherChildDirectory ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object. Called by derived classes.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDispatcherChildDirectory::operator=

TDispatcherChildDirectory & operator =(const TDispatcherChildDirectory & theDirectory)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object. Called by derived classes or users of derived classes.

Parameters:

const TDispatcherChildDirectory & theDirectory -The object to be copied.

Return Value:

A reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDispatcherChildDirectory::DoneWith

virtual void DoneWith (MRemoteDispatcher * childObject)

Interface Category:

API.

Purpose:

Informs the child directory that this child dispatcher is released from use.

Calling Context:

Called when the user is done using the child dispatcher. Called by derived classes or users of derived classes.

Parameters:

MRemoteDispatcher * childObject -The child dispatcher that is released from use.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDispatcherChildDirectory::Use

virtual MRemoteDispatcher * Use (MRemoteCaller :: ChildID whichChild)

Interface Category:

API.

Purpose:

Informs the child directory that this child dispatcher is being used.

Calling Context:

Called when the user wants to use the child dispatcher. Called by derived classes or users of derived classes.

Parameters:

MRemoteCaller :: ChildID whichChild -The child dispatcher to be used.

Return Value:

A pointer to the child dispatcher with a matching identifier. A NIL pointer is returned if there is no match.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDispatcherChildDirectory::Lookup

virtual MRemoteDispatcher * Lookup (MRemoteCaller :: ChildID whichChild)

Interface Category:

API.

Purpose:

A pure virtual member function that searches the parent dispatcher's child list for the child dispatcher with the specified identifier.

Calling Context:

Cannot be called. Override it in derived classes.

Parameters:

MRemoteCaller :: ChildID whichChild -The child identifier for which to search.

Return Value:

A pointer to the child dispatcher with a matching identifier. A NIL pointer is returned if there is no match.

Exceptions:

Not applicable.

Concurrency:

Not applicable.

Other Considerations:

None.

Member Function: TDispatcherChildDirectory::Remove

virtual MRemoteDispatcher * Remove (MRemoteCaller :: ChildID whichChild)

Interface Category:

API.

Purpose:

A pure virtual member function that removes a child dispatcher object from the parent dispatcher's list of children.

Calling Context:

Cannot be called. Override it in derived classes.

Parameters:

MRemoteCaller :: ChildID whichChild -The identifier of the child dispatcher to be removed.

Return Value:

A pointer to the child dispatcher that was removed. A NIL pointer is returned if there is no match.

Exceptions:

Not applicable.

Concurrency:

Not applicable.

Other Considerations:

None.

Member Function: TDispatcherChildDirectory::Add

virtual MRemoteCaller :: ChildID Add (MRemoteDispatcher * childObject)

Interface Category:

API.

Purpose:

A pure virtual member function that adds a child dispatcher to the parent dispatcher's list of children.

Calling Context:

Cannot be called. Override it in derived classes.

Parameters:

MRemoteDispatcher * childObject -The child dispatcher to add.

Return Value:

Returns the identifier assigned to the child directory that was added.

Exceptions:

Not applicable.

Concurrency:

Not applicable.

Other Considerations:

None.

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