From 7d6affca746f49f5ffb2818b8a9ccf9d91388e8f Mon Sep 17 00:00:00 2001 From: Jonathan Wilkes Date: Wed, 25 Aug 2010 00:31:27 +0000 Subject: revised help docs that conform to the PDDP template svn path=/trunk/; revision=13942 --- doc/pddp/netreceive-help.pd | 131 +++++++++++++++++++++++++++++++------------- 1 file changed, 94 insertions(+), 37 deletions(-) (limited to 'doc/pddp/netreceive-help.pd') diff --git a/doc/pddp/netreceive-help.pd b/doc/pddp/netreceive-help.pd index 5ee47823..a241bf11 100644 --- a/doc/pddp/netreceive-help.pd +++ b/doc/pddp/netreceive-help.pd @@ -1,40 +1,97 @@ -#N canvas 300 97 467 585 10; -#X text 3 531 You can send and receive messages to Pd from the command -line using 'pdsend' and 'pdreceive'.; -#X obj 4 1 cnv 15 450 20 empty empty netreceive 20 10 1 18 -233017 --66577 0; -#X obj 79 313 netreceive 3000; -#X floatatom 179 334 0 0 0 0 - - -; -#X obj 79 387 netreceive 3001 1; -#X text 12 46 The Netreceive object opens a socket for TCP ("stream") -or UDP ("datagram") network reception on a specified port. If using -TCP \, an outlet gives you the number of Netsend objects (or other -compatible clients) have opened connections here.; -#X text 10 127 Incoming network messages appear on "receive" objects -\; it's up to the sender to select which one. Here \, a "receive foo" -fields messages sent from the Netsend help window \, q.v.; -#X text 34 270 first argument: portnumber = 3000; -#X text 34 286 second argument: 0 or none for TCP \, nonzero for UDP +#N canvas 0 0 555 619 10; +#X obj 0 595 cnv 15 552 21 empty \$0-pddp.cnv.footer empty 20 12 0 +14 -228856 -66577 0; +#X obj 0 0 cnv 15 552 40 empty \$0-pddp.cnv.header netreceive 3 12 +0 18 -204280 -1 0; +#X obj 0 331 cnv 3 550 3 empty \$0-pddp.cnv.inlets inlets 8 12 0 13 +-228856 -1 0; +#N canvas 46 242 494 344 META 0; +#X text 12 105 PLATFORM windows macosx gnulinux; +#X text 12 165 LIBRARY internal; +#X text 12 205 WEBSITE http://crca.ucsd.edu/~msp/; +#X text 12 65 LICENSE SIBSD; +#X text 12 185 AUTHOR Miller Puckette; +#X text 12 265 HELP_PATCH_AUTHORS Updated for Pd v0.41. Revised by +Jonathan Wilkes to conform to the PDDP template for Pd version 0.42. ; -#X text 217 312 <-- TCP \, port 3000; -#X text 241 386 <-- UDP \, port 3001; -#X text 213 335 <--- number of open connections; -#X text 5 366 incoming messages; -#X obj 79 334 print tcp; -#X obj 79 408 print udp; -#X text 11 178 There are some possibilities for intercommunication -with other programs... see the help for "netsend."; -#X text 19 26 [netreceive] -- listen for incoming messages from network +#X text 12 5 GENRE help; +#X text 12 45 KEYWORDS control network; +#X text 12 85 DESCRIPTION listen for incoming messages from a network ; -#X text 9 216 SECURITY ALERT: the port that netreceive opens has no +#X text 12 25 NAME netreceive; +#X text 12 125 OUTLET_0 anything; +#X text 12 145 OUTLET_1 float; +#X text 12 225 RELEASE_DATE 1997; +#X text 12 245 RELEASE_VERSION; +#X restore 500 597 pd META; +#X obj 0 358 cnv 3 550 3 empty \$0-pddp.cnv.outlets outlets 8 12 0 +13 -228856 -1 0; +#X obj 0 431 cnv 3 550 3 empty \$0-pddp.cnv.argument arguments 8 12 +0 13 -228856 -1 0; +#X obj 0 558 cnv 3 550 3 empty \$0-pddp.cnv.more_info more_info 8 12 +0 13 -228856 -1 0; +#N canvas 54 478 428 109 Related_objects 0; +#X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0 +14 -204280 -1 0; +#X text 8 2 [netreceive] Related Objects; +#X obj 22 43 netsend; +#X restore 102 598 pd Related_objects; +#X obj 78 367 cnv 17 3 25 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856 +-162280 0; +#X text 80 451 1) float; +#X obj 463 3 netreceive; +#X obj 430 20 pddp/pddplink http://wiki.puredata.info/en/netreceive +-text pdpedia: netreceive; +#X floatatom 226 82 0 0 0 0 - - -; +#X obj 139 145 netreceive 3001 1; +#X obj 139 82 print tcp; +#X obj 139 166 print udp; +#N canvas 57 331 428 261 About_netreceive 0; +#X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0 +14 -204280 -1 0; +#X text 8 2 [netreceive] More Info; +#X text 21 38 The [netreceive] object opens a socket for TCP ("stream") +or UDP ("datagram") network reception on a specified port. If using +TCP \, an outlet gives you the number of [netsend] objects (or other +compatible clients) have opened connections here.; +#X text 20 170 There are some possibilities for intercommunication +with other programs... see the help for [netsend].; +#X text 19 104 Incoming network messages appear at the left inlet of +the [netreceive] object. (They used to be received by [receive] objects +\, in which case it was up to the sender to select which one). To test +the object you can send messages from the [netsend] help window.; +#X text 18 208 SECURITY ALERT: the port that netreceive opens has no access restrictions \, so anyone can connect to it and send messages. -Be careful that; -#X text 109 509 [netreceive 4567 0 old]; -#X text 7 431 If you set the third argument to the word "old" \, everything -sent to the specified port is received into the global message space. -This is the original behavior of [netreceive]. This can be VERY INSECURE -since it gives someone full access to your computer \, allowing them -to do anything that Pd can via the network.; -#X connect 2 0 13 0; -#X connect 2 1 3 0; -#X connect 4 0 14 0; +; +#X restore 102 567 pd About_netreceive; +#X text 11 23 listen for incoming messages from a network; +#X text 168 466 - (optional) 0 for TCP \, nonzero for UDP. (Default +is TCP.); +#X text 168 451 - (optional) port number.; +#X text 80 466 2) float; +#X text 168 481 - if you set the third argument to the word "old" \, +everything sent to the specified port is received into the global message +space. This is the original behavior of [netreceive]. This can be VERY +INSECURE since it gives someone full access to your computer \, allowing +them to do anything that Pd can via the network.; +#X text 98 290 Old behavior: [netreceive 4567 0 old] (see argument +3 below); +#X text 80 481 3) symbol atom; +#X text 98 366 anything; +#X obj 78 403 cnv 17 3 17 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856 +-162280 0; +#X text 98 402 float; +#X text 264 60 <- TCP \, port 3000; +#X text 261 144 <- UDP \, port 3001; +#X text 98 205 You can send messages from the [netsend] objects in +the help patch for [netsend].; +#X text 168 366 - any message received by this [netreceive] object +will be sent to the left outlet.; +#X text 98 334 (none); +#X obj 139 61 netreceive 3000; +#X text 168 402 - when using TCP \, the [netreceive] object has a right +inlet which shows the number of open connections.; +#X obj 4 597 pddp/pddplink pddp/help.pd -text help; +#X connect 13 0 15 0; +#X connect 32 0 14 0; +#X connect 32 1 12 0; -- cgit v1.2.1