Class: TNetworkServiceReference

Declaration: NetworkService.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TServiceReference

Inherited By:

None.

Purpose:

Refers to a service that is accessible via network communication. The service may be defined in this machine, or in another machine in the same network. TNetworkServiceReference uses an object directory to look up the service when connecting to it.

Instantiation:

Allocate on the heap or the stack

Deriving Classes:

Do not derive any classes from TNetworkServiceReference

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

TNetworkServiceReference is typically not instantiated directly but is created using the CreateReference member function of TServiceDefinition.

Member Function: TNetworkServiceReference::TNetworkServiceReference

TNetworkServiceReference (const TLocalObjectName &)
TNetworkServiceReference (const TLocalObjectName &, const TNetworkName &)
TNetworkServiceReference (const TNetworkServiceReference & copy)
TNetworkServiceReference ()

Interface Category:

API.

Purpose:

Creates a reference to the service with the specified name in this machine.
Creates a reference to the service with the specified name in the specified machine.
Copies a service reference. All parameters are copied, but the new reference is not active.
Default constructor. Creates an object that does not refer to any service.

Calling Context:

Called to create a reference to a local service.
Called to create a reference to a service on another machine.
Called to copy an object.
Called by the stream-in operators.

Parameters:

const TLocalObjectName & -Identifies the service.
const TLocalObjectName & -Identifies the service.
const TNetworkName & -Identifies the machine that implements the service.
const TNetworkServiceReference & copy -The object to be copied.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

TNetworkServiceReference is typically not instantiated directly but is created using the CreateReference member function of TServiceDefinition.

Member Function: TNetworkServiceReference::~TNetworkServiceReference

virtual ~ TNetworkServiceReference ()

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:

Not multithread safe.

Other Considerations:

None.

Member Function: TNetworkServiceReference::operator=

TNetworkServiceReference & operator =(const TNetworkServiceReference & copy)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TNetworkServiceReference & copy -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: TNetworkServiceReference::operator<<=

virtual TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromWhere -The stream from which the object stream itself in.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TNetworkServiceReference::operator>>=

virtual TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toWhere -The stream to which the object stream itself.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TNetworkServiceReference::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Creates a hash value for this TNetworkServiceReference.

Calling Context:

Called to create a hash value for this TNetworkServiceReference.

Parameters:

Takes no parameters.

Return Value:

The hash value for this TNetworkServiceReference.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TNetworkServiceReference::IsEqualTo

virtual bool IsEqualTo (const TServiceReference &) const

Interface Category:

API.

Purpose:

Evaluates whether two objects refer to the same service.

Calling Context:

Called by TServiceReference::IsEqual.

Parameters:

const TServiceReference & toWhat -The object to which this object is compared.

Return Value:

Returns true if this object and the parameter refer to the same service.

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.