Another little reorg; we are quite tightly bound to implementation of CStruct

This commit is contained in:
Brian Candler
2011-05-02 18:17:24 +01:00
parent 14f8a27d2b
commit a6eda43b2e
3 changed files with 35 additions and 7 deletions

25
README
View File

@@ -5,6 +5,29 @@ This library provides an API for using a Linux Netlink socket, for doing
things like manipulating IP interfaces, routes and firewall rules
programmatically.
Code organisation
=================
There are separate classes for each Netlink protocol providing a high-level
API. These all in turn use the NLSocket class, which has methods for adding
the headers to messages and sending them over a socket. The messages
themselves are built using class Message or RtattrMessage, which in turn are
subclasses of CStruct, which performs the low-level packing and unpacking of
the message bodies.
Route Firewall ...etc
| | |
+-------+-------+
|
v
NLSocket
|
v
Message / RtattrMessage
|
v
CStruct
Useful reference material
=========================
@@ -41,6 +64,8 @@ TODO
====
* Exception hierarchy
* Unit tests
* Integration tests
Copyright
=========