Class: MRemoteCaller

Declaration: RemoteCaller.h

Taxonomy Categories:

Member Functions:

MRemoteCaller
~MRemoteCaller
operator=
Ping
ExitDispatcher
GetTransport
SetTransport
MakeDispatcherID

Interface Category:

API.

Inherits From:

None.

Inherited By:

MRemoteCallerChild TCursor TCursorTrackingSprite TMediaRegistryCaller TRemoteTestCaller TDisplayDeviceHandle TShutdownServerHandle TDocumentRegistry TNotifyingDisplay

Purpose:

MRemoteCaller is a mixin class that you can use to perform remote procedure calls that are implemented in other objects, tasks, or servers with a corresponding MRemoteDispatcher mixin.

Instantiation:

MRemoteCaller is a generic base class and is not intended to be instantiated.

Deriving Classes:

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

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: MRemoteCaller::MRemoteCaller

MRemoteCaller ()
MRemoteCaller (TRemoteCallerTransport * theTransport)
MRemoteCaller (const MRemoteCaller & theCaller)

Interface Category:

API.

Purpose:

Default constructor.
Creates an MRemoteCaller that uses the specified transport.
Copy constructor.

Calling Context:

Called by the stream-in operators and by derived classes.
Called to create an MRemoteCaller that uses the specified transport. Called by derived classes.
Called to copy an object. Called by derived classes.

Parameters:

Takes no parameters.
TRemoteCallerTransport * theTransport -The transport to use.
const MRemoteCaller & theCaller -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: MRemoteCaller::~MRemoteCaller

virtual ~ MRemoteCaller ()

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

MRemoteCaller & operator =(const MRemoteCaller & 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 MRemoteCaller & 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: MRemoteCaller::Ping

virtual void Ping ()

Interface Category:

API.

Purpose:

Sends a null request.

Calling Context:

Called to sent a null request. This member function can be used to test the message stream transport to a server. Called by derived classes or users of 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: MRemoteCaller::ExitDispatcher

virtual void ExitDispatcher ()

Interface Category:

API.

Purpose:

Disconnects from the dispatcher.

Calling Context:

Called to disconnect from the dispatcher. Called by derived classes or users of 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: MRemoteCaller::GetTransport

TRemoteCallerTransport * GetTransport () const

Interface Category:

API.

Purpose:

Returns a pointer to the transport used to communicate with the corresponding MRemoteDispatcher.

Calling Context:

Called to obtain a reference to the transport used to communicate with the corresponding MRemoteDispatcher. Called by derived classes or users of derived classes.

Parameters:

Takes no parameters.

Return Value:

A pointer to the transport.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: MRemoteCaller::SetTransport

void SetTransport (TRemoteCallerTransport * theTransport)

Interface Category:

API.

Purpose:

A protected member function that initializes the transport used to communicate with the corresponding MRemoteDispatcher.

Calling Context:

SetTransport is commonly used only in conjunction with the default constructor when defining a derived class that includes a transport.

Parameters:

TRemoteCallerTransport * theTransport -The transport to use.

Return Value:

None.

Exceptions:

Throws TRemoteCallException(kCantChangeTransport) when it's called and the transport has already been initialized.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: MRemoteCaller::MakeDispatcherID

static DispatcherID MakeDispatcherID (const TStandardText & dispatcherName)

Interface Category:

API.

Purpose:

Returns a hash value for the specified dispatcher.

Calling Context:

Called to obtain a hash value for the specified dispatcher. Called by derived classes or users of derived classes.

Parameters:

const TStandardText & dispatcherName -The name of the dispatcher for which the hash value is generated.

Return Value:

The hash value generated for the dispatcher.

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.