Saros
Distributed Collaborative Editing and Distributed Party Programming
de.fu_berlin.inf.dpp.monitoring.remote.RemoteProgressManager Class Reference
Inheritance diagram for de.fu_berlin.inf.dpp.monitoring.remote.RemoteProgressManager:
de.fu_berlin.inf.dpp.session.AbstractActivityProducer de.fu_berlin.inf.dpp.session.IActivityProducer

List of all members.

Public Member Functions

 RemoteProgressManager (ISarosSessionManager sessionManager)
IProgressMonitor createRemoteProgress (final List< User > users, final IProgressMonitor monitor)
de.fu_berlin.inf.dpp.monitoring.IProgressMonitor createRemoteProgress (final List< User > users, final de.fu_berlin.inf.dpp.monitoring.IProgressMonitor monitor)

Package Functions

void monitorUpdated (final ProgressActivity activity)
void removeProgress (final String id)

Detailed Description

The RemoteProgressManager is responsible for showing progress bars on the machines of other users.


Constructor & Destructor Documentation

de.fu_berlin.inf.dpp.monitoring.remote.RemoteProgressManager.RemoteProgressManager ( ISarosSessionManager  sessionManager)

Member Function Documentation

IProgressMonitor de.fu_berlin.inf.dpp.monitoring.remote.RemoteProgressManager.createRemoteProgress ( final List< User users,
final IProgressMonitor  monitor 
)

Returns a new IProgressMonitor which is displayed at the given remote sites.

Usage:

  • Call beginTask with the name of the Task to show to the user and the total amount of work.
  • Call worked to add amounts of work your task has finished (this will be summed up and should not exceed totalWorked
  • Call done as a last method to close the progress on the remote side.

Caution: This class does not check many invariants, but rather only sends your commands to the remote party.

Parameters:
users
monitor
Returns:
de.fu_berlin.inf.dpp.monitoring.IProgressMonitor de.fu_berlin.inf.dpp.monitoring.remote.RemoteProgressManager.createRemoteProgress ( final List< User users,
final de.fu_berlin.inf.dpp.monitoring.IProgressMonitor  monitor 
)

Returns a new IProgressMonitor which is displayed at the given remote sites.

Usage:

  • Call beginTask with the name of the Task to show to the user and the total amount of work.
  • Call worked to add amounts of work your task has finished (this will be summed up and should not exceed totalWorked
  • Call done as a last method to close the progress on the remote side.

Caution: This class does not check many invariants, but rather only sends your commands to the remote party.

Parameters:
users
monitor
Returns:
void de.fu_berlin.inf.dpp.monitoring.remote.RemoteProgressManager.monitorUpdated ( final ProgressActivity  activity) [package]
void de.fu_berlin.inf.dpp.monitoring.remote.RemoteProgressManager.removeProgress ( final String  id) [package]

Removes a RemoteProgress progress}. The progress will no longer receive any updates.

Parameters:
idthe id of the progress
 All Classes Namespaces Files Functions Variables Enumerations