Class: MRemoteCallerChild

Declaration: RemoteCaller.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MRemoteCaller

Inherited By:

MAudioRemoteCaller

Purpose:

MRemoteCallerChild is a mixin class that you can use to create callers that are children of the main MRemoteCaller and share its transport.

Instantiation:

MRemoteCallerChild is an abstract class and cannot be instantiated.

Deriving Classes:

MRemoteCallerChild is a mixin class for deriving child callers for handling remote procedure calls.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: MRemoteCallerChild::MRemoteCallerChild

MRemoteCallerChild (MRemoteCaller * theParentCaller)
MRemoteCallerChild (MRemoteCaller * theParentCaller, ChildID theChildID)
MRemoteCallerChild (const MRemoteCallerChild & theCaller)
MRemoteCallerChild ()

Interface Category:

API.

Purpose:

Creates a caller child for the specified parent caller. The parent's transport is used. The child's identifier is set to zero.
Creates a caller child with the specified identifier for the specified parent caller. The parent's transport is used.
Copy constructor.
Default constructor.

Calling Context:

Called to create a caller that is the child of the specified caller. Called by derived classes.
Called to create a caller that is the child of the specified caller. Called by derived classes.
Called to copy an object. Called by derived classes.
Called primarily by the stream-in operators and by derived classes.

Parameters:

MRemoteCaller * theParentCaller -The parent caller.
MRemoteCaller * theParentCaller -The parent caller.
ChildID theChildID -The child identifier to use.
const MRemoteCallerChild & theCaller -The object to be copied.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws TRemoteCallException(kInvalidParentCaller) if theParentCaller supplied is NIL.
Throws TRemoteCallException(kInvalidParentCaller) if theParentCaller supplied is NIL.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: MRemoteCallerChild::~MRemoteCallerChild

virtual ~ MRemoteCallerChild ()

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

MRemoteCallerChild & operator =(const MRemoteCallerChild & theCaller)

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 MRemoteCallerChild & theCaller -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: MRemoteCallerChild::GetChildID

ChildID GetChildID ()

Interface Category:

API.

Purpose:

Returns this object's child identifier.

Calling Context:

Called to obtain this object's child identifier. Called by derived classes or users of derived classes.

Parameters:

Takes no parameters.

Return Value:

Returns the child identifier.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: MRemoteCallerChild::SetChildID

void SetChildID (ChildID theChildID)

Interface Category:

API.

Purpose:

Sets this object's child identifier to the specified value.

Calling Context:

Called to set this object's child identifier. Called by derived classes or users of derived classes.

Parameters:

ChildID theChildID -The child identifier to use.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: MRemoteCallerChild::GetParent

MRemoteCaller * GetParent ()

Interface Category:

API.

Purpose:

Returns a pointer to the parent of this child caller.

Calling Context:

Called to obtain a pointer to this object's parent. Called by derived classes or users of derived classes.

Parameters:

Takes no parameters.

Return Value:

A pointer to the parent of this object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: MRemoteCallerChild::SetParent

void SetParent (MRemoteCaller * parent)

Interface Category:

API.

Purpose:

Sets the parent of this caller object to the specified object and adopts the new parent's transport.

Calling Context:

Called to set this object's parent. Called by derived classes or users of derived classes.

Parameters:

MRemoteCaller * parent -The parent of this object.

Return Value:

None.

Exceptions:

Throws TRemoteCallException(kInvalidParentCaller) if the parent pointer is NIL.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: MRemoteCallerChild::SetTransport

void SetTransport (TRemoteCallerTransport * theTransport)

Interface Category:

API.

Purpose:

Sets the transport for this object.

Calling Context:

Called to set the transport for this object. Called by derived classes or users of derived classes.

Parameters:

TRemoteCallerTransport * theTransport -The transport to use.

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.