App Engine Python SDK  v1.6.9 rev.445
The Python runtime is available as an experimental Preview feature.
Public Member Functions | Public Attributes | List of all members
google.appengine.api.taskqueue.taskqueue_stub._BackgroundTaskScheduler Class Reference
Inheritance diagram for google.appengine.api.taskqueue.taskqueue_stub._BackgroundTaskScheduler:

Public Member Functions

def __init__
 
def UpdateNextEventTime
 
def Shutdown
 
def MainLoop
 

Public Attributes

 task_executor
 
 default_retry_seconds
 

Detailed Description

The task scheduler class.

This class is designed to be run in a background thread.

Note: There must not be more than one instance of _BackgroundTaskScheduler per
group.

Constructor & Destructor Documentation

def google.appengine.api.taskqueue.taskqueue_stub._BackgroundTaskScheduler.__init__ (   self,
  group,
  task_executor,
  retry_seconds,
  kwargs 
)
Constructor.

Args:
  group: The group that we will automatically execute tasks from. Must be an
  instance of _Group.
  task_executor: The class used to convert a task into a http request. Must
  be an instance of _TaskExecutor.
  retry_seconds: The number of seconds to delay a task by if its execution
  fails.
  _get_time: a callable that returns the current time in seconds since the
  epoch. This argument may only be passed in by keyword. If unset, use
  time.time.

Member Function Documentation

def google.appengine.api.taskqueue.taskqueue_stub._BackgroundTaskScheduler.MainLoop (   self)
The main loop of the scheduler.
def google.appengine.api.taskqueue.taskqueue_stub._BackgroundTaskScheduler.Shutdown (   self)
Request this TaskExecutor to exit.
def google.appengine.api.taskqueue.taskqueue_stub._BackgroundTaskScheduler.UpdateNextEventTime (   self,
  next_event_time 
)
Notify the TaskExecutor of the closest event it needs to process.

Args:
  next_event_time: The time of the event in seconds since the epoch.

The documentation for this class was generated from the following file: