From 6c1eff1e5128a6ec8dae72c7a164a20c8190290c Mon Sep 17 00:00:00 2001
From: Holger Hans Peter Freyther <zecke@selfish.org>
Date: Sun, 12 Jun 2011 14:39:31 +0200
Subject: [PATCH] doc: Add a simple DESIGN document

Describe objects and how they interact with each other.
---
 DESIGN | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 DESIGN

diff --git a/DESIGN b/DESIGN
new file mode 100644
index 0000000..03b8e51
--- /dev/null
+++ b/DESIGN
@@ -0,0 +1,25 @@
+Some simple design notes to guide people
+
+- MGCPGrammar can parse requests and replies
+
+- MGCPCommand base class of commands
+   - asDatagram to create message
+
+- MGCPTrunk a trunk with a destination and nr. endpoints
+   - MGCPVirtualTrunk for 1@mgw.. in hex
+   - MGCPE1Trunk for ds-1/... handling
+   - both hold MGCPEndpoints
+
+- MGCPTransaction a command to create a transaction
+   - callback for completion (wth response)
+   - callback for a timeout
+   - created with an endpoint and the callagent
+
+- MGCPCallAgent serves the Call-Agent port
+   - Generates the transaction id for a transaction
+   - Does the retransmission
+   - Handles timeout
+   - Recycles transaction after three minutes
+     (to block a transaction identifier)
+
+