mirror of
https://github.com/markqvist/Reticulum.git
synced 2024-11-05 05:40:14 +00:00
Refactored and documented Reticulum class
This commit is contained in:
parent
b2eebd90ea
commit
aa02931364
@ -128,7 +128,7 @@ class Identity:
|
||||
return False
|
||||
|
||||
@staticmethod
|
||||
def exitHandler():
|
||||
def exit_handler():
|
||||
Identity.saveKnownDestinations()
|
||||
|
||||
|
||||
|
@ -36,6 +36,13 @@ class Reticulum:
|
||||
other programs to use on demand.
|
||||
"""
|
||||
|
||||
# The default RNS MTU is 500 bytes. This number has been chosen as
|
||||
# a balance between compatibility with existing hardware devices
|
||||
# on one hand, and the ability to use sufficiently high cryptographic
|
||||
# key sizes on the other. In custom RNS network implementations, it
|
||||
# is possible to raise this value, but doing so will completely break
|
||||
# compatibility with all other RNS networks. An identical MTU is a
|
||||
# prerequisite for peers to communicate in the same network.
|
||||
MTU = 500
|
||||
HEADER_MAXSIZE = 23
|
||||
MDU = MTU - HEADER_MAXSIZE
|
||||
@ -43,6 +50,8 @@ class Reticulum:
|
||||
router = None
|
||||
config = None
|
||||
|
||||
# The default configuration path will be expanded to a directory
|
||||
# named ".reticulum" inside the current users home directory
|
||||
configdir = os.path.expanduser("~")+"/.reticulum"
|
||||
configpath = ""
|
||||
storagepath = ""
|
||||
@ -50,8 +59,14 @@ class Reticulum:
|
||||
|
||||
@staticmethod
|
||||
def exit_handler():
|
||||
RNS.Transport.exitHandler()
|
||||
RNS.Identity.exitHandler()
|
||||
"""
|
||||
This exit handler is called whenever Reticulum is asked to
|
||||
shut down, and will in turn call exit handlers in other
|
||||
classes, saving necessary information to disk and carrying
|
||||
out cleanup operations.
|
||||
"""
|
||||
RNS.Transport.exit_handler()
|
||||
RNS.Identity.exit_handler()
|
||||
|
||||
def __init__(self,configdir=None):
|
||||
"""
|
||||
|
@ -1116,7 +1116,7 @@ class Transport:
|
||||
return False
|
||||
|
||||
@staticmethod
|
||||
def exitHandler():
|
||||
def exit_handler():
|
||||
RNS.log("Saving packet hashlist to storage...", RNS.LOG_VERBOSE)
|
||||
try:
|
||||
packet_hashlist_path = RNS.Reticulum.storagepath+"/packet_hashlist"
|
||||
|
Loading…
Reference in New Issue
Block a user