added a convenience target for generating all documentation based on existing google code example, fixed a few issues with doc strings
This commit is contained in:
parent
6d3470c95f
commit
188f9420ca
7 changed files with 38 additions and 21 deletions
|
@ -42,16 +42,7 @@ from core.xml.xmlsession import save_session_xml
|
|||
|
||||
class CoreRequestHandler(SocketServer.BaseRequestHandler):
|
||||
"""
|
||||
The SocketServer class uses the RequestHandler class for servicing
|
||||
requests, mainly through the handle() method. The CoreRequestHandler
|
||||
has the following basic flow:
|
||||
1. Client connects and request comes in via handle().
|
||||
2. handle() calls recvmsg() in a loop.
|
||||
3. recvmsg() does a recv() call on the socket performs basic
|
||||
checks that this we received a CoreMessage, returning it.
|
||||
4. The message data is queued using queuemsg().
|
||||
5. The handlerthread() thread pops messages from the queue and uses
|
||||
handlemsg() to invoke the appropriate handler for that message type.
|
||||
The SocketServer class uses the RequestHandler class for servicing requests.
|
||||
"""
|
||||
|
||||
def __init__(self, request, client_address, server):
|
||||
|
|
|
@ -655,8 +655,8 @@ class PyCoreNetIf(object):
|
|||
"""
|
||||
Attach network.
|
||||
|
||||
:param core.coreobj.PyCoreNet net: network to attach to
|
||||
:return:nothing
|
||||
:param core.coreobj.PyCoreNet net: network to attach
|
||||
:return: nothing
|
||||
"""
|
||||
if self.net:
|
||||
self.detachnet()
|
||||
|
|
|
@ -30,13 +30,13 @@ class SimpleLxcNode(PyCoreNode):
|
|||
"""
|
||||
Provides simple lxc functionality for core nodes.
|
||||
|
||||
:type nodedir: str
|
||||
:type ctrlchnlname: str
|
||||
:type client: core.netns.vnodeclient.VnodeClient
|
||||
:type pid: int
|
||||
:type up: bool
|
||||
:type lock: threading.RLock
|
||||
:type _mounts: list[tuple[str, str]]
|
||||
:var nodedir: str
|
||||
:var ctrlchnlname: str
|
||||
:var client: core.netns.vnodeclient.VnodeClient
|
||||
:var pid: int
|
||||
:var up: bool
|
||||
:var lock: threading.RLock
|
||||
:var _mounts: list[tuple[str, str]]
|
||||
"""
|
||||
valid_address_types = {"inet", "inet6", "inet6link"}
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue