projects / mirror_ifupdown2.git / blame
| Commit | Line | Data |
|---|---|---|
| 2c8c4ce7 RP |
1 | Documentation for the Code |
| 2 | ************************** | |
| 3 | ||
| 4 | ||
| 5 | ifupdownmain | |
| 6 | ============ | |
| 7 | ||
| 8 | ifupdownmain is the main ifupdown module. | |
| 9 | ||
| 10 | .. automodule:: ifupdownmain | |
| 11 | ||
| 12 | .. autoclass:: ifupdownMain | |
| 13 | :members: up, down, reload, query | |
| 14 | ||
| 15 | iface | |
| 16 | ===== | |
| 17 | ||
| 18 | .. automodule:: iface | |
| 19 | ||
| 20 | .. autoclass:: iface | |
| 21 | :members: state, status, flags, priv_flags, refcnt, lowerifaces, upperifaces, add_to_upperifaces, get_attr_value, get_attr_value_first, get_attr_value_n, update_config, update_config_with_status, get_config_attr_status, compare, dump_raw, dump, dump_pretty | |
| 22 | ||
| 23 | .. autoclass:: ifaceState | |
| 24 | ||
| 25 | .. autoclass:: ifaceStatus | |
| 26 | ||
| 27 | .. autoclass:: ifaceJsonEncoder | |
| 28 | ||
| 29 | scheduler | |
| 30 | ========= | |
| 31 | ||
| 32 | .. automodule:: scheduler | |
| 33 | ||
| 34 | .. autoclass:: ifaceScheduler | |
| 35 | :members: sched_ifaces | |
| 36 | ||
| 37 | .. autoclass:: ifaceSchedulerFlags | |
| 38 | ||
| 39 | ||
| 40 | networkinterfaces | |
| 41 | ================= | |
| 42 | ||
| 43 | .. automodule:: networkinterfaces | |
| 44 | ||
| 45 | .. autoclass:: networkInterfaces | |
| 46 | :members: load, subscribe | |
| 47 | ||
| 48 | statemanager | |
| 49 | ============ | |
| 50 | ||
| 51 | .. automodule:: statemanager | |
| 52 | ||
| 53 | .. autoclass:: pickling | |
| 54 | :members: save, save_obj, load | |
| 55 | ||
| 56 | .. autoclass:: stateManager | |
| 57 | :members: read_saved_state, save_state | |
| 58 | ||
| 59 | graph | |
| 60 | ===== | |
| 61 | ||
| 62 | .. automodule:: graph | |
| 63 | ||
| 64 | .. autoclass:: graph | |
| 65 | :members: topological_sort_graphs_all, generate_dots |