-
Notifications
You must be signed in to change notification settings - Fork 745
/
NetAddr.html
107 lines (107 loc) · 9.17 KB
/
NetAddr.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta http-equiv="Content-Style-Type" content="text/css">
<title></title>
<meta name="Generator" content="Cocoa HTML Writer">
<meta name="CocoaVersion" content="824.41">
<style type="text/css">
p.p1 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica}
p.p2 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; min-height: 14.0px}
p.p3 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco}
p.p4 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; min-height: 12.0px}
p.p5 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #bf0000}
p.p6 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #000000; min-height: 12.0px}
p.p7 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #000000}
p.p8 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #606060}
span.s1 {font: 18.0px Helvetica}
span.s2 {font: 9.0px Monaco}
span.s3 {font: 12.0px Helvetica}
span.s4 {color: #000000}
span.s5 {color: #0000bf}
span.s6 {color: #606060}
span.s7 {color: #007300}
span.Apple-tab-span {white-space:pre}
</style>
</head>
<body>
<p class="p1"><span class="s1"><b>NetAddr</b></span><span class="s2"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></span><b>network address</b></p>
<p class="p2"><br></p>
<p class="p1">superclass: Object</p>
<p class="p2"><br></p>
<p class="p2"><br></p>
<p class="p1"><span class="Apple-tab-span"> </span><b>*new(hostname, port)</b><span class="Apple-tab-span"> </span>create new net address.<span class="Apple-converted-space"> </span></p>
<p class="p1"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>Hostname is a string, either an ip number (e.g. <i>"192.168.34.56"</i>) or a hostname such as <i>"otherHost.local"</i>.</p>
<p class="p1"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>Port is a port number, like <i>57110</i>.</p>
<p class="p1"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>Note: to send messages internally, loopback ip is used: <i>"127.0.0.1"</i></p>
<p class="p2"><span class="Apple-tab-span"> </span></p>
<p class="p1"><span class="Apple-tab-span"> </span><b>*fromIP(ip, port)</b><span class="Apple-tab-span"> </span><span class="Apple-tab-span">create new net address using an integer ip number.</span></p>
<p class="p2"><span class="Apple-tab-span"> </span></p>
<p class="p1"><span class="Apple-tab-span"> </span><b>*langPort</b><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>Get the port sclang is currently listening on (may change after a recompile).</p>
<p class="p2"><span class="Apple-tab-span"> </span></p>
<p class="p1"><span class="Apple-tab-span"> </span><b>*localAddr</b><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>Get a NetAddr which corresponds to localhost and the port sclang is listening on.</p>
<p class="p2"><span class="Apple-tab-span"> </span></p>
<p class="p1"><span class="Apple-tab-span"> </span><b>sendMsg(args...)</b><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>send a message without timestamp to the addr.</p>
<p class="p2"><span class="Apple-tab-span"> </span></p>
<p class="p1"><span class="Apple-tab-span"> </span><b>sendBundle(timestamp, args...)</b><span class="Apple-tab-span"> </span>send a bundle with timestamp to the addr.</p>
<p class="p2"><span class="Apple-tab-span"> </span></p>
<p class="p1"><span class="Apple-tab-span"> </span><b>sendRaw(rawArray)</b><span class="Apple-tab-span"> </span>send a raw message without timestamp to the addr.</p>
<p class="p2"><span class="Apple-tab-span"> </span></p>
<p class="p1"><span class="Apple-tab-span"> </span><b>connect(disconnectHandler)</b><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>open TCP connection. <b>disconnectHandler</b> is called when</p>
<p class="p1"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>the connection is closed (either by the client or by the server)</p>
<p class="p2"><span class="Apple-tab-span"> </span></p>
<p class="p1"><span class="Apple-tab-span"> </span><b>disconnect</b><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>close TCP connection</p>
<p class="p2"><span class="Apple-tab-span"> </span></p>
<p class="p1"><span class="Apple-tab-span"> </span><b>ip </b><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>returns the ip number (as string)</p>
<p class="p1"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>example:<span class="Apple-converted-space"> </span></p>
<p class="p3"><span class="s3"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></span>n = NetAddr("localhost", 57110);</p>
<p class="p3"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>n.ip;</p>
<p class="p4"><span class="Apple-tab-span"> </span></p>
<p class="p1"><b><span class="Apple-tab-span"> </span>*disconnectAll<span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></b>close all TCP connections</p>
<p class="p2"><span class="Apple-tab-span"> </span></p>
<p class="p1"><b><span class="Apple-tab-span"> </span>*broadcastFlag<span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></b>check broadcast flag</p>
<p class="p2"><span class="Apple-tab-span"> </span></p>
<p class="p1"><b><span class="Apple-tab-span"> </span>*broadcastFlag_( flag )<span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></b>Sets the broadcast flag (whether or not broadcast messages can be sent)</p>
<p class="p2"><span class="Apple-tab-span"> </span></p>
<p class="p1"><b><span class="Apple-tab-span"> </span>*useDoubles_( flag )<span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></b></p>
<p class="p2"><span class="Apple-tab-span"> </span></p>
<p class="p4"><br></p>
<p class="p4"><br></p>
<p class="p5">// example</p>
<p class="p6"><br></p>
<p class="p6"><br></p>
<p class="p5"><span class="s4">n = </span><span class="s5">NetAddr</span><span class="s4">(</span><span class="s6">"127.0.0.1"</span><span class="s4">, 57120); </span>// 57120 is sclang default port</p>
<p class="p7">r = <span class="s5">OSCresponder</span>(n, <span class="s7">'/good/news'</span>, { <span class="s5">arg</span> time, resp, msg; [time, msg].postln }).add;</p>
<p class="p6"><br></p>
<p class="p8"><span class="s4">n.sendMsg(</span>"/good/news"<span class="s4">, </span>"you"<span class="s4">, </span>"not you"<span class="s4">);</span></p>
<p class="p7">n.sendMsg(<span class="s6">"/good/news"</span>, 1, 1.3, 77);</p>
<p class="p6"><br></p>
<p class="p6"><br></p>
<p class="p7">n.sendBundle(0.2, [<span class="s6">"/good/news"</span>, 1, 1.3, 77]);</p>
<p class="p6"><br></p>
<p class="p7">r.remove;</p>
<p class="p7">n.disconnect;</p>
<p class="p6"><br></p>
<p class="p5">// note that different NetAddr objects with the same port and ip are independent.</p>
<p class="p6"><br></p>
<p class="p7">r = <span class="s5">OSCresponder</span>(<span class="s5">nil</span>, <span class="s7">'/x'</span>, { <span class="s6">"message arrived"</span>.postln }).add;</p>
<p class="p6"><br></p>
<p class="p7">n = <span class="s5">NetAddr</span>(<span class="s6">"127.0.0.1"</span>, 57120);</p>
<p class="p7">n.sendMsg(<span class="s6">"/x"</span>)</p>
<p class="p6"><br></p>
<p class="p6"><br></p>
<p class="p7">u = <span class="s5">NetAddr</span>(<span class="s6">"127.0.0.1"</span>, 57120);</p>
<p class="p7">u.sendMsg(<span class="s6">"/x"</span>);</p>
<p class="p6"><br></p>
<p class="p7">n.disconnect</p>
<p class="p6"><br></p>
<p class="p7">u.sendMsg(<span class="s6">"/x"</span>);</p>
<p class="p6"><br></p>
<p class="p7">r.remove;</p>
<p class="p7">u.disconnect;</p>
<p class="p6"><br></p>
<p class="p6"><br></p>
<p class="p6"><br></p>
</body>
</html>