Congegni
/
sintonia
7
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

cc-4105: added a bunch of docstrings

This commit is contained in:
Rudi Grinberg 2012-08-13 14:54:17 -04:00
parent e4a756075a
commit 12a5edfd5c
1 changed files with 35 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
python_apps/media-monitor2/media/monitor/watchersyncer.py
View File

@ -13,6 +13,11 @@ from media.monitor.eventcontractor import EventContractor
import api_clients.api_client as ac import api_clients.api_client as ac
class RequestSync(threading.Thread,Loggable): class RequestSync(threading.Thread,Loggable):
"""
This class is responsible for making the api call to send a request
to airtime. In the process it packs the requests and retries for
some number of times
"""
def __init__(self, watcher, requests): def __init__(self, watcher, requests):
threading.Thread.__init__(self) threading.Thread.__init__(self)
self.watcher = watcher self.watcher = watcher
@ -67,6 +72,10 @@ class RequestSync(threading.Thread,Loggable):
self.watcher.flag_done() self.watcher.flag_done()
class TimeoutWatcher(threading.Thread,Loggable): class TimeoutWatcher(threading.Thread,Loggable):
"""
The job of this thread is to keep an eye on WatchSyncer and force a
request whenever the requests go over time out
"""
def __init__(self, watcher, timeout=5): def __init__(self, watcher, timeout=5):
self.logger.info("Created timeout thread...") self.logger.info("Created timeout thread...")
threading.Thread.__init__(self) threading.Thread.__init__(self)
@ -132,10 +141,23 @@ class WatchSyncer(ReportHandler,Loggable):
Printing its representation:") Printing its representation:")
self.logger.info( repr(event) ) self.logger.info( repr(event) )
def requests_left_count(self): return len(self.__requests) def requests_left_count(self):
def events_left_count(self): return len(self.__queue) """
returns the number of requests left in the queue. requests are
functions that create RequestSync threads
"""
return len(self.__requests)
def events_left_count(self):
"""
Returns the number of events left in the queue to create a request
"""
return len(self.__queue)
def push_queue(self, elem): def push_queue(self, elem):
"""
Added 'elem' to the event queue and launch a request if we are
over the the chunking number
"""
self.logger.info("Added event into queue") self.logger.info("Added event into queue")
if self.events_left_count() >= self.chunking_number: if self.events_left_count() >= self.chunking_number:
self.push_request() self.push_request()
@ -143,6 +165,9 @@ class WatchSyncer(ReportHandler,Loggable):
self.__queue.append(elem) self.__queue.append(elem)
def flush_events(self): def flush_events(self):
"""
Force flush the current events held in the queue
"""
self.logger.info("Force flushing events...") self.logger.info("Force flushing events...")
self.push_request() self.push_request()
self.request_do() self.request_do()
@ -155,6 +180,9 @@ class WatchSyncer(ReportHandler,Loggable):
return len(self.__queue) > 0 return len(self.__queue) > 0
def requests_in_queue(self): def requests_in_queue(self):
"""
Returns true if there are any requests in the queue. False otherwise.
"""
return len(self.__requests) > 0 return len(self.__requests) > 0
def flag_done(self): def flag_done(self):
@ -163,8 +191,8 @@ class WatchSyncer(ReportHandler,Loggable):
""" """
self.request_running = False self.request_running = False
self.__current_thread = None self.__current_thread = None
# This call might not be necessary but we would like # This call might not be necessary but we would like to get the
# to get the ball running with the requests as soon as possible # ball running with the requests as soon as possible
if self.requests_in_queue() > 0: self.request_do() if self.requests_in_queue() > 0: self.request_do()
def request_do(self): def request_do(self):
@ -176,6 +204,9 @@ class WatchSyncer(ReportHandler,Loggable):
self.__requests.pop()() self.__requests.pop()()
def push_request(self): def push_request(self):
"""
Create a request from the current events in the queue and schedule it
"""
self.logger.info("WatchSyncer : Unleashing request") self.logger.info("WatchSyncer : Unleashing request")
# want to do request asyncly and empty the queue # want to do request asyncly and empty the queue
requests = copy.copy(self.__queue) requests = copy.copy(self.__queue)