Class: TDispatcherChildDictionary

Declaration: RemoteDispatcher.h

Taxonomy Categories:

Member Functions:


Interface Category:

API.

Inherits From:

TDispatcherChildDirectory

Inherited By:

None.

Purpose:

TDispatcherChildDictionary uses a dictionary to support the association of child objects and their corresponding ChildIDs.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derived classes are not supported in this release.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TDispatcherChildDictionary::TDispatcherChildDictionary

  1. TDispatcherChildDictionary ()
  2. TDispatcherChildDictionary (const TDispatcherChildDictionary & theDirectory)

Interface Category:

API.

Purpose:

  1. Default constructor.
  2. Copy constructor.

Calling Context:

  1. Called to instantiate an object. Call this function directly.
  2. Called to copy an object. Call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDispatcherChildDictionary::~TDispatcherChildDictionary

virtual ~ TDispatcherChildDictionary ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object. Call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDispatcherChildDictionary::operator=

TDispatcherChildDictionary & operator =(const TDispatcherChildDictionary & theDirectory)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object. Call this function directly.

Parameters:

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: TDispatcherChildDictionary::Lookup

virtual MRemoteDispatcher * Lookup (MRemoteCaller :: ChildID whichChild)

Interface Category:

API.

Purpose:

Searches the parent dispatcher's child list for the child dispatcher with the specified identifier.

Calling Context:

Called to obtain a pointer to the child dispatcher with the specified identifier. Call this function directly.

Parameters:

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: TDispatcherChildDictionary::Remove

virtual MRemoteDispatcher * Remove (MRemoteCaller :: ChildID whichChild)

Interface Category:

API.

Purpose:

Removes a child dispatcher object from the parent dispatcher's list of children.

Calling Context:

Called to remove a child dispatcher object from the parent dispatcher's list of children. Call this function directly.

Parameters:

Return Value:

A pointer to the child dispatcher that was removed. 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: TDispatcherChildDictionary::Add

virtual MRemoteCaller :: ChildID Add (MRemoteDispatcher * childObject)

Interface Category:

API.

Purpose:

Adds a child dispatcher to the parent dispatcher's list of children.

Calling Context:

Called to add a child dispatcher to the parent dispatcher's list of children. Call this function directly.

Parameters:

Return Value:

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

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.
Copyright©1995 Taligent,Inc. All rights reserved.