Class: TRequestBasedMemberFunctionConnection

Declaration: Notification.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TNotifierConnection

Inherited By:

TRequestBasedMemberFunctionConnectionTo

Purpose:

This class is the base class for TRequestBasedMemberFunctionConnectionTo. Its only purpose is to provide implementation sharing for instances of TRequestBasedMemberFunctionConnectionTo. It should never be used directly by clients. Clients should always use TRequestBasedMemberFunctionConnectionTo.

Instantiation:

Never instantiated directly by clients.

Deriving Classes:

TRequestBasedMemberFunctionConnectionTo is the only derived class.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TRequestBasedMemberFunctionConnection::TRequestBasedMemberFunctionConnection

TRequestBasedMemberFunctionConnection (void * theReceiver, TRequestProcessor * processorToUse, TNotificationMemberFunction * notificationFunction, ENotTheDefaultFunction)
TRequestBasedMemberFunctionConnection (void * theReceiver, TRequestProcessor * processorToUse, TNotificationMemberFunction * defaultFunction)
TRequestBasedMemberFunctionConnection (void * theReceiver, TRequestProcessor * processorToUse, TNotificationMemberFunction * defaultFunction, const TInterest & theInterest)
TRequestBasedMemberFunctionConnection (TNotificationMemberFunction * notificationFunction)

Interface Category:

API.

Purpose:

Creates a new request based member function connection with no default notification member function pointer. The request processor is not adopted, it is aliased. The request process is used to serialize the notifications that a receiver object will get with other requests made against the object. Thus, the receiver object does not have to deal with concurrency issues.
Creates a new request based member function with the specified member function to be used as the default notification handler. The request processor is not adopted, it is aliased. The request process is used to serialize the notifications that a receiver object will get with other requests made against the object. Thus, the receiver object does not have to deal with concurrency issues.
Creates a new request based member function with the specified member function to be used as the default notification handler and the interest to be added as the initial interest. The request processor is not adopted, it is aliased. The request process is used to serialize the notifications that a receiver object will get with other requests made against the object. Thus, the receiver object does not have to deal with concurrency issues.
Default constructor.

Calling Context:

Called only by TMemberFunctionConnectionTo.
Called only by TMemberFunctionConnectionTo.
Called only by TMemberFunctionConnectionTo.
Called only by TMemberFunctionConnectionTo.

Parameters:

AReceiver * theReceiver -The object to receive the notifications.
TRequestProcessor * processorToUse -The aliased request processor to be used to dispatch the notifications to the receiver object.
ENotTheDefaultFunction -Indicates no default function provided.
TNotificationMemberFunction* defaultFunction -Member function instance used to call member functions in typesafe way.
AReceiver * theReceiver -The object to receive the notifications.
TRequestProcessor * processorToUse -The aliased request processor to be used to dispatch the notifications to the receiver object.
TNotificationMemberFunction* defaultFunction -The member function of the object that will be called to handle notifications on interests that do not have their own specified member function.
AReceiver * theReceiver -The object to receive the notifications.
TRequestProcessor * processorToUse -The aliased request processor to be used to dispatch the notifications to the receiver object.
TNotificationMemberFunction* defaultFunction -The member function of the object that will be called to handle notifications on interests that do not have their own specified member function.
const TInterest & -The initial interest.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TRequestBasedMemberFunctionConnection::~TRequestBasedMemberFunctionConnection

virtual ~ TRequestBasedMemberFunctionConnection ()

Interface Category:

API.

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:

Multithread safe.

Other Considerations:

None.

Member Function: TRequestBasedMemberFunctionConnection::SetRequestProcessor

void SetRequestProcessor (TRequestProcessor *)

Interface Category:

API.

Purpose:

Set the request processor to be used when calling notification member functions.

Calling Context:

You can call this function directly.

Parameters:

TRequestProcessor * -The request processor to alias.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TRequestBasedMemberFunctionConnection::GetRequestProcessor

TRequestProcessor * GetRequestProcessor () const

Interface Category:

API.

Purpose:

Returns the request processor currently in use by this connection.

Calling Context:

You can call this function directly.

Parameters:

Takes no parameters.

Return Value:

TRequestProcessor * -The request processor.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TRequestBasedMemberFunctionConnection::GetVoidReceiver

void * GetVoidReceiver () const

Interface Category:

API.

Purpose:

Returns the receiver as void*.

Calling Context:

Called only by TMemberFunctionConnectionTo.

Parameters:

Takes no parameters.

Return Value:

void * -The receiver.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TRequestBasedMemberFunctionConnection::GetDefaultMemberFunctionImplementation

const TNotificationMemberFunction * GetDefaultMemberFunctionImplementation () const

Interface Category:

API.

Purpose:

Returns the default member function object.

Calling Context:

Called only by TMemberFunctionConnectionTo.

Parameters:

Takes no parameters.

Return Value:

The default member function.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TRequestBasedMemberFunctionConnection::SetVoidReceiver

void SetVoidReceiver (void * theReceiver)
void SetVoidReceiver (void * theReceiver, TNotificationMemberFunction * defaultFunction)

Interface Category:

API.

Purpose:

Sets the receiver as a void *.
Sets the receiver and default function.

Calling Context:

Called only by TMemberFunctionConnectionTo.
Called only by TMemberFunctionConnectionTo.

Parameters:

void * theReceiver -The receiver object as void*.
void * theReceiver -The receiver object as void*.
TNotificationMemberFunction * defaultFunction -The default function.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TRequestBasedMemberFunctionConnection::RemoveAllInterests

virtual void RemoveAllInterests ()

Interface Category:

API.

Purpose:

Removes all of the connection's interests. If the connection is connected to the notifier, then it will no longer receive any notifications. However, it is still connected to the notifier and should be disconnected before being deleted.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TRequestBasedMemberFunctionConnection::RemoveInterest

virtual void RemoveInterest (const TInterest &)

Interface Category:

API.

Purpose:

Removes all the interests that match the passed-in interest. The connection will no longer get notifications that are associated with this interest.

Calling Context:

Call this function directly.

Parameters:

const TInterest & -The passed in interest.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TRequestBasedMemberFunctionConnection::Notify

virtual void Notify (const TNotification &, const TInterest &)

Interface Category:

API.

Purpose:

Called by the notifier to cause the connection to distribute the notification to the connection. The connection can then distribute the notification to its receiver object or a global receiver function.

Calling Context:

Call this function directly.

Parameters:

const TNotification & -The notification to distribute.
const TInterest & -The interest used to match the connections that will get the distributed notification.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TRequestBasedMemberFunctionConnection::Connect

virtual void Connect ()

Interface Category:

API.

Purpose:

Performs a connect on the notifier and registers all of the connection's own interests with the notifier. After this point, the receiver will begin to receive notifications that match its interests.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TRequestBasedMemberFunctionConnection::Disconnect

virtual void Disconnect ()

Interface Category:

API.

Purpose:

Performs a disconnect from the notifier and removes all of the connection's own interests from the notifier's list of interests. The receiver will no longer be sent any new notifications.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TRequestBasedMemberFunctionConnection::AddInterestImplementation

void AddInterestImplementation (const TInterest &)
void AddInterestImplementation (const TInterest &, TNotificationMemberFunction *)

Interface Category:

API.

Purpose:

Shared implementation of add interest.
Shared implementation of add interest with specific member function.

Calling Context:

Called only by TMemberFunctionConnectionTo.
Called only by TMemberFunctionConnectionTo.

Parameters:

const TInterest & -The interest.
const TInterest & -The interest.
TNotificationMemberFunction * -The member function to call.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TRequestBasedMemberFunctionConnection::AdoptInterestImplementation

void AdoptInterestImplementation (TInterest *)
void AdoptInterestImplementation (TInterest *, TNotificationMemberFunction *)

Interface Category:

API.

Purpose:

Shared implementation of add interest.
Shared implementation of add interest with specific member function.

Calling Context:

Called only by TMemberFunctionConnectionTo.
Called only by TMemberFunctionConnectionTo.

Parameters:

const TInterest * -The interest.
const TInterest * -The interest.
TNotificationMemberFunction * -The member function to call.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

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