Skip to content

Commit

Permalink
Updated docstrings and comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
Juergen Brendel committed Jul 21, 2017
1 parent 2b88c1e commit b94e9fd
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 4 deletions.
15 changes: 11 additions & 4 deletions vpcrouter/watcher/plugins/configfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,14 @@ def read_route_spec_config(fname):

class Configfile(common.WatcherPlugin):
"""
Implements the WatcherPlugin interface for the 'http' plugin.
Implements the WatcherPlugin interface for the 'configfile' plugin.
Start a Bottle application thread, which serves a minimal HTTP interface
to set route specs or enquire about the status.
Establishes a watcher thread, which detectes any changes to the config
file and re-reads it.
The plugin adds a command line argument to vpc-router:
-f / --file: The name of the config file, which should be monitored.
"""
def start(self):
Expand Down Expand Up @@ -150,7 +154,10 @@ def stop(self):

@classmethod
def add_arguments(cls, parser):
# Arguments for the configfile mode
"""
Arguments for the configfile mode.
"""
parser.add_argument('-f', '--file', dest='file',
help="config file for routing groups "
"(only in configfile mode)")
Expand Down
5 changes: 5 additions & 0 deletions vpcrouter/watcher/plugins/http.py
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,11 @@ class Http(common.WatcherPlugin):
Start a Bottle application thread, which serves a minimal HTTP interface
to set route specs or enquire about the status.
This plugin adds two command line arguments to vpc-router:
-a / --address: The listen address for the HTTP server.
-p / --port: The listen port for the HTTP server.
"""
def start(self):
"""
Expand Down

0 comments on commit b94e9fd

Please sign in to comment.