Main Page | Class Hierarchy | Class List | File List | Class Members | Related Pages

glite::rgma::Resource Class Reference

#include <Resource.h>

Inheritance diagram for glite::rgma::Resource:

glite::rgma::ResourceImpl glite::rgma::Consumer glite::rgma::OnDemandProducer glite::rgma::PrimaryProducer glite::rgma::Registry glite::rgma::SecondaryProducer glite::rgma::ConsumerImpl glite::rgma::OnDemandProducerImpl glite::rgma::PrimaryProducerImpl glite::rgma::SecondaryProducerImpl List of all members.

Public Member Functions

virtual ResourceEndpoint getEndpoint ()=0
virtual TimeInterval getTerminationInterval ()=0 throw (RemoteException, UnknownResourceException)
virtual void setTerminationInterval (TimeInterval &time_interval)=0 throw (RemoteException, UnknownResourceException, RGMAException)
virtual void destroy ()=0 throw (RemoteException, UnknownResourceException)
virtual void close ()=0 throw (RemoteException, UnknownResourceException)
virtual void showSignOfLife ()=0 throw (RemoteException, UnknownResourceException)

Protected Attributes

ResourceEndpoint m_endPoint
TimeInterval m_terminationInterval

Detailed Description

An object managed by a Web Service that an API can interact with. Either a Producer or a Consumer.


Member Function Documentation

virtual void glite::rgma::Resource::close  )  throw (RemoteException, UnknownResourceException) [pure virtual]
 

Closes the resource. The resource will no longer be available through this API and will be destroyed once it has finished interacting with other components.

Exceptions:
RemoteException If the service could not be contacted.
UnknownResourceException If the resource could not be found

Implemented in glite::rgma::ResourceImpl.

virtual void glite::rgma::Resource::destroy  )  throw (RemoteException, UnknownResourceException) [pure virtual]
 

Closes and destroys the resource. The resource will no longer be available to any component.

Exceptions:
RemoteException If the service could not be contacted.
UnknownResourceException If the resource could not be found

Implemented in glite::rgma::ResourceImpl.

virtual ResourceEndpoint glite::rgma::Resource::getEndpoint  )  [pure virtual]
 

Gets the endpoint of the service/resource the API communicates with.

Returns:
The service/instance identifier

Implemented in glite::rgma::ResourceImpl.

virtual TimeInterval glite::rgma::Resource::getTerminationInterval  )  throw (RemoteException, UnknownResourceException) [pure virtual]
 

Retrieves the resource's termination interval.

Returns:
a pointer to the termination interval as a TimeInterval.
Exceptions:
RemoteException If the service could not be contacted.
UnknownResourceException If the resource could not be found
See also:
setTerminationInterval

Implemented in glite::rgma::ResourceImpl.

virtual void glite::rgma::Resource::setTerminationInterval TimeInterval time_interval  )  throw (RemoteException, UnknownResourceException, RGMAException) [pure virtual]
 

Sets the termination interval for this resource.

Parameters:
terminationInterval The time interval after which the resource may destroy itself if no contact has been made from the API.

Deprecated:
Exceptions:
RemoteException If the service could not be contacted.
UnknownResourceException If the resource could not be found
RGMAException If the termination interval is invalid (e.g. in the past)
See also:
getTerminationInterval

Implemented in glite::rgma::ResourceImpl.

virtual void glite::rgma::Resource::showSignOfLife  )  throw (RemoteException, UnknownResourceException) [pure virtual]
 

Indicates to the resource that this API is still alive. This should be used to keep a resource alive when no other method needs to be called.

Exceptions:
RemoteException If the service could not be contacted.
UnknownResourceException If the resource could not be found

Implemented in glite::rgma::ResourceImpl.


The documentation for this class was generated from the following file:
Generated on Wed Apr 25 19:11:33 2007 for glite-rgma-api-cpp by doxygen 1.3.5