open.source/magic-wormhole-transit-relay
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

more docstrings

Browse Source
This commit is contained in:
meejah 2021-04-12 08:09:57 -06:00
parent ef96af2a80
commit 8132ea8f91
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/wormhole_transit_relay/server_state.py
View File

@ -12,6 +12,10 @@ from twisted.python import log
class ITransitClient(Interface): class ITransitClient(Interface):
"""
Represents the client side of a connection to this transit
relay. This is used by TransitServerState instances.
"""
started_time = Attribute("timestamp when the connection was established") started_time = Attribute("timestamp when the connection was established")
@ -61,6 +65,9 @@ class IUsageWriter(Interface):
@implementer(IUsageWriter) @implementer(IUsageWriter)
class MemoryUsageRecorder: class MemoryUsageRecorder:
"""
Remebers usage records in memory.
"""
def __init__(self): def __init__(self):
self.events = [] self.events = []
@ -81,6 +88,10 @@ class MemoryUsageRecorder:
@implementer(IUsageWriter) @implementer(IUsageWriter)
class LogFileUsageRecorder: class LogFileUsageRecorder:
"""
Writes usage records to a file. The records are written in JSON,
one record per line.
"""
def __init__(self, writable_file): def __init__(self, writable_file):
self._file = writable_file self._file = writable_file
@ -102,6 +113,9 @@ class LogFileUsageRecorder:
@implementer(IUsageWriter) @implementer(IUsageWriter)
class DatabaseUsageRecorder: class DatabaseUsageRecorder:
"""
Write usage records into a database
"""
def __init__(self, db): def __init__(self, db):
self._db = db self._db = db
@ -174,7 +188,6 @@ class UsageTracker(object):
self._blur_usage = blur_usage self._blur_usage = blur_usage
if blur_usage: if blur_usage:
log.msg("blurring access times to %d seconds" % self._blur_usage) log.msg("blurring access times to %d seconds" % self._blur_usage)
## XXX log.msg("not logging Transit connections to Twisted log")
else: else:
log.msg("not blurring access times") log.msg("not blurring access times")