aboutsummaryrefslogtreecommitdiff
path: root/modules/README
diff options
context:
space:
mode:
authorHans-Christoph Steiner <eighthave@users.sourceforge.net>2005-12-15 07:26:47 +0000
committerHans-Christoph Steiner <eighthave@users.sourceforge.net>2005-12-15 07:26:47 +0000
commit37b6643df2df7d784a31ca73f7bb90dc109c2401 (patch)
treea8664e5adcfcb60cae136063d627549ecb76619b /modules/README
parentc50ce0e0217ea07e2d450add2ab29cecea66fa96 (diff)
removing PDP source (except debian files) before import of PDP 0.12.4
svn path=/trunk/externals/pdp/; revision=4217
Diffstat (limited to 'modules/README')
-rw-r--r--modules/README30
1 files changed, 0 insertions, 30 deletions
diff --git a/modules/README b/modules/README
deleted file mode 100644
index 54f816c..0000000
--- a/modules/README
+++ /dev/null
@@ -1,30 +0,0 @@
-This file describes the protocol used for communicating packets.
-See include/pdp.h and the sources in this directory for more info.
-
-There are 3 kinds of pdp messages:
-
-[pdp register_ro <packet_id>]
-[pdp register_rw <packet_id>]
-[pdp process]
-
-Together they form the pdp protocol. An object can receive a packet
-by catching the 3 kinds of messages:
-
-When a register_ro message is received, the object can call
-pdp_packet_copy_ro(packet) to reserve a read only copy for itself.
-
-The same goes for handling the register_rw message. You can
-reserve a read/write copy by using pdp_packet_copy_rw(packet)
-
-When a process message is received, the object is allowed to start
-processing the packet data end send the resulting packet(s) out.
-
-To send out a packet, use the pdp_packet_pass_if_valid(outlet, &packet)
-method. It passes a packet, and sets the reference to -1 (the undefined
-packet id).
-
-
-If you want to write pdp externs, consider using the pdp_base object
-to derive your object from. Have a look at pdp_add, pdp_gain, pdp_noise
-to see how to do this.
-