Agent: Change the method docstrings for IMaster

This commit is contained in:
Mike Salvatore 2021-11-22 13:02:09 -05:00 committed by Shreya Malviya
parent bd31cfd947
commit 082f034d58
1 changed files with 4 additions and 9 deletions

View File

@ -5,23 +5,18 @@ class IMaster(metaclass=abc.ABCMeta):
@abc.abstractmethod @abc.abstractmethod
def start(self) -> None: def start(self) -> None:
""" """
With the help of the puppet, starts and instructs the Agent to Run the control logic that will instruct the Puppet to perform various actions like scanning
perform various actions like scanning or exploiting a specific host. or exploiting a specific host.
""" """
pass
@abc.abstractmethod @abc.abstractmethod
def terminate(self) -> None: def terminate(self) -> None:
""" """
Effectively marks the Agent as dead, telling all actions being Stop the master and interrupt any actions that are currently being executed.
performed by the Agent to stop.
""" """
pass
@abc.abstractmethod @abc.abstractmethod
def cleanup(self) -> None: def cleanup(self) -> None:
""" """
With the help of the puppet, instructs the Agent to cleanup whatever Revert any changes that the master has directly or indirectly caused to the system.
is required since the Agent was killed.
""" """
pass