From 4af5ca85487d3d7eaea65db2c64b050115b9158b Mon Sep 17 00:00:00 2001 From: Scott Baker Date: Thu, 16 Oct 2008 05:48:51 +0000 Subject: [PATCH] check in component documentation --- docs/Makefile | 2 + docs/pythondoc-component.html | 136 ++++++++++++++++++++++++++++++++++ 2 files changed, 138 insertions(+) create mode 100644 docs/pythondoc-component.html diff --git a/docs/Makefile b/docs/Makefile index 8151ea11..d0f092e1 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -6,3 +6,5 @@ doc: pythondoc.py ../registry/registry.py ../registry/import.py \ ../registry/nuke.py + + pythondoc.py ../component/component.py diff --git a/docs/pythondoc-component.html b/docs/pythondoc-component.html new file mode 100644 index 00000000..655f2862 --- /dev/null +++ b/docs/pythondoc-component.html @@ -0,0 +1,136 @@ + + + + +The component Module + + +

The component Module

+

Geni Component Wrapper + +This wrapper implements the Geni Component Interface

+
+
ComponentManager(ip, port, key_file, cert_file) (class) [#]
+
+

ComponentManager is a GeniServer that serves component interface requests.

+

For more information about this class, see The ComponentManager Class.

+
+
+

The ComponentManager Class

+
+
ComponentManager(ip, port, key_file, cert_file) (class) [#]
+
+

ComponentManager is a GeniServer that serves component interface requests.

+
+
decode_ticket(ticket_string) [#]
+
+

Examine the ticket that was provided by the caller, check that it is +signed and verified correctly. Throw an exception if something is +wrong with the ticket. + +This is similar to geniserver.decode_authentication

+
+
ticket_string
+
+the string representation of the ticket
+

+
+
delete_slice(cred_str) [#]
+
+

Delete a slice.

+
+
cred
+
+a credential identifying the caller (callerGID) and the slice + (objectGID)
+

+
+
geni_ticket_to_plc_rec(ticket) [#]
+
+

Convert a geni ticket into a PLC record that can be submitted to the +node manager. This involves some minor reformatting of the fields +contained in the ticket.

+
+
ticket
+
+a ticket object
+
Returns:
+
+a dictionary containing the PLC record info
+

+
+
list_slices(cred_str) [#]
+
+

List the slices on a component.

+
+
cred_str
+
+string representation of a credential object that + authorizes the caller
+
Returns:
+
+a list of slice names
+

+
+
reboot(cred_str) [#]
+
+

Reboot the component.

+
+
cred_str
+
+string representation of a credential object that + authorizes the caller
+

+
+
redeem_ticket(ticket_str) [#]
+
+

Redeem a ticket. + +The ticket is submitted to the node manager, and the slice is instantiated +or updated as appropriate. + +TODO: This operation should return a sliver credential and indicate +whether or not the component will accept only sliver credentials, or +will accept both sliver and slice credentials.

+
+
ticket_str
+
+the string representation of a ticket object
+

+
+
register_functions() [#]
+
+

Register the server RPCs for the component

+
+
reset_slice(cred_str) [#]
+
+

Reset a slice.

+
+
cred
+
+a credential identifying the caller (callerGID) and the slice + (objectGID)
+

+
+
start_slice(cred_str) [#]
+
+

Start a slice.

+
+
cred
+
+a credential identifying the caller (callerGID) and the slice + (objectGID)
+

+
+
stop_slice(cred_str) [#]
+
+

Stop a slice.

+
+
cred
+
+a credential identifying the caller (callerGID) and the slice + (objectGID)
+

+
+
+ -- 2.43.0