Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.red5.server.api.scheduling
Interface ISchedulingService

All Superinterfaces:
  IScopeService

All Known Implementing Classes:
  ApplicationAdapter, ApplicationSchedulingService, MultiThreadedApplicationAdapter, QuartzSchedulingService

    public interface ISchedulingService

extends IScopeService

Service that supports periodic execution of jobs, adding, removing and getting their name as list.

Author:
  The Red5 Project (red5@osflash.org), Joachim Bauch (jojo@struktur.de), Paul Gregoire (mondain@gmail.com)

Field Summary
`static String` | `BEAN_NAME`

Method Summary
`String` | `addScheduledJob(int interval, IScheduledJob job)` Schedule a job for periodic execution.
`String` | `addScheduledJobAfterDelay(int interval, IScheduledJob job, int delay)` Schedule a job for periodic execution which will start after the specifed delay.
`String` | `addScheduledOnceJob(Date date, IScheduledJob job)` Schedule a job for single execution at a given date.
`String` | `addScheduledOnceJob(long timeDelta, IScheduledJob job)` Schedule a job for single execution in the future.
`List<String>` | `getScheduledJobNames()` Return names of scheduled jobs.
`void` | `pauseScheduledJob(String name)` Pauses the trigger which initiates job execution.
`void` | `removeScheduledJob(String name)` Stop executing a previously scheduled job.
`void` | `resumeScheduledJob(String name)` Resumes the trigger which initiates job execution.

Field Detail

### BEAN_NAME

    static final String BEAN_NAME

See Also:
  Constant Field Values

Method Detail

### addScheduledJob

    String addScheduledJob(int interval,
                           IScheduledJob job)

  Schedule a job for periodic execution.

  Parameters:
    `interval` - time in milliseconds between two notifications of the job
    `job` - the job to trigger periodically
  Returns:
    the name of the scheduled job

### addScheduledOnceJob

    String addScheduledOnceJob(long timeDelta,
                               IScheduledJob job)

  Schedule a job for single execution in the future. Please note that the jobs are not saved if Red5 is restarted in the meantime.

  Parameters:
    `timeDelta` - time delta in milliseconds from the current date
    `job` - the job to trigger
  Returns:
    the name of the scheduled job

### addScheduledOnceJob

    String addScheduledOnceJob(Date date,
                               IScheduledJob job)

  Schedule a job for single execution at a given date. Please note that the jobs are not saved if Red5 is restarted in the meantime.

  Parameters:
    `date` - date when the job should be executed
    `job` - the job to trigger
  Returns:
    the name of the scheduled job

### addScheduledJobAfterDelay

    String addScheduledJobAfterDelay(int interval,
                                     IScheduledJob job,
                                     int delay)

  Schedule a job for periodic execution which will start after the specifed delay.

  Parameters:
    `interval` - time in milliseconds between two notifications of the job
    `job` - the job to trigger periodically
    `delay` - time in milliseconds to pass before first execution.
  Returns:
    the name of the scheduled job

### pauseScheduledJob

    void pauseScheduledJob(String name)

  Pauses the trigger which initiates job execution.

  Parameters:
    `name` - name of the job to stop

### resumeScheduledJob

    void resumeScheduledJob(String name)

  Resumes the trigger which initiates job execution.

  Parameters:
    `name` - name of the job to stop

### removeScheduledJob

    void removeScheduledJob(String name)

  Stop executing a previously scheduled job.

  Parameters:
    `name` - name of the job to stop

### getScheduledJobNames

    List<String> getScheduledJobNames()

  Return names of scheduled jobs.

  Returns:
    list of job names

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2006-2010 The Red5 Project