added doc
This commit is contained in:
parent
94e61890ae
commit
632421235f
@ -22,10 +22,16 @@ class EventLogger:
|
|||||||
self.verbose = verbose
|
self.verbose = verbose
|
||||||
|
|
||||||
def setup_msq_queue(self):
|
def setup_msq_queue(self):
|
||||||
|
"""
|
||||||
|
Sets up the message queue which calls self.log on msg receive.
|
||||||
|
"""
|
||||||
mb = MBWrapper(exchange_name='logger', callback=self.log)
|
mb = MBWrapper(exchange_name='logger', callback=self.log)
|
||||||
mb.setup_receiver()
|
mb.setup_receiver()
|
||||||
|
|
||||||
def get_keys(self):
|
def get_keys(self):
|
||||||
|
"""
|
||||||
|
Returns the available redis keys.
|
||||||
|
"""
|
||||||
return json.dumps([key.decode() for key in self.redis.keys()])
|
return json.dumps([key.decode() for key in self.redis.keys()])
|
||||||
|
|
||||||
def get_list_of(self, key):
|
def get_list_of(self, key):
|
||||||
@ -48,6 +54,13 @@ class EventLogger:
|
|||||||
return key.decode() if key else json.dumps("")
|
return key.decode() if key else json.dumps("")
|
||||||
|
|
||||||
def log(self, msg):
|
def log(self, msg):
|
||||||
|
"""
|
||||||
|
Logging callback. Logs the msg depending on its type to the respective redis key.
|
||||||
|
Types can be DAF, TrafficLightState or TargetVelocity. If type is unknown, message is still logged as key
|
||||||
|
UNKNOWN.
|
||||||
|
|
||||||
|
:param msg: pickled msg binary to log
|
||||||
|
"""
|
||||||
try:
|
try:
|
||||||
msg = pickle.loads(msg)
|
msg = pickle.loads(msg)
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
|
|||||||
@ -37,16 +37,28 @@ def get_keys():
|
|||||||
|
|
||||||
@app.route("/api/keys")
|
@app.route("/api/keys")
|
||||||
def api_get_keys():
|
def api_get_keys():
|
||||||
|
"""
|
||||||
|
:return: list of available redis keys
|
||||||
|
"""
|
||||||
return el.get_keys()
|
return el.get_keys()
|
||||||
|
|
||||||
|
|
||||||
@app.route("/api/keys/<key>/")
|
@app.route("/api/keys/<key>/")
|
||||||
def api_get_of_key(key):
|
def api_get_of_key(key):
|
||||||
|
"""
|
||||||
|
:param key: key to get data of
|
||||||
|
:return: list of data to the respective key
|
||||||
|
"""
|
||||||
return el.get_list_of(key)
|
return el.get_list_of(key)
|
||||||
|
|
||||||
|
|
||||||
@app.route("/api/keys/<key>/<index>/")
|
@app.route("/api/keys/<key>/<index>/")
|
||||||
def api_get_index_of_key(key, index):
|
def api_get_index_of_key(key, index):
|
||||||
|
"""
|
||||||
|
:param key: key to get data element of
|
||||||
|
:param index: index of keys data list
|
||||||
|
:return: element matching index of key
|
||||||
|
"""
|
||||||
return el.get_index_of(key, index)
|
return el.get_index_of(key, index)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user