diff options
author | Kartik K. Agaram <vc@akkartik.com> | 2016-10-22 16:56:07 -0700 |
---|---|---|
committer | Kartik K. Agaram <vc@akkartik.com> | 2016-10-22 16:56:07 -0700 |
commit | 9a81d7460fdb16f4e77712e5381d9db8781f5ae6 (patch) | |
tree | 43b05169535fe33e65ecbf61f3fb3ada5f75ed52 /html/092socket.mu.html | |
parent | 22f4b76344b2d639cbfcaad56ed681670d436548 (diff) | |
download | mu-9a81d7460fdb16f4e77712e5381d9db8781f5ae6.tar.gz |
3561
Diffstat (limited to 'html/092socket.mu.html')
-rw-r--r-- | html/092socket.mu.html | 230 |
1 files changed, 125 insertions, 105 deletions
diff --git a/html/092socket.mu.html b/html/092socket.mu.html index 186c7c3b..72ffa17c 100644 --- a/html/092socket.mu.html +++ b/html/092socket.mu.html @@ -33,72 +33,90 @@ body { font-size: 12pt; font-family: monospace; color: #eeeeee; background-color </head> <body> <pre id='vimCodeElement'> -<span class="Comment"># Wrappers around socket primitives that take a 'local-network' object and are</span> -<span class="Comment"># thus easier to test.</span> +<span class="Comment"># Wrappers around socket primitives that are easier to test.</span> <span class="Comment">#</span> -<span class="Comment"># The current semantics of fake port-connections don't match UNIX socket ones,</span> -<span class="Comment"># but we'll improve them as we learn more.</span> - -<span class="muData">container</span> local-network [ - data:&:@:port-connection -] - -<span class="Comment"># Port connections represent connections to ports on localhost.</span> -<span class="Comment"># Before passing a local-network object to network functions</span> -<span class="Comment"># `start-reading-socket` and `start-writing-socket`, add port-connections to</span> -<span class="Comment"># the local-network.</span> -<span class="Comment">#</span> -<span class="Comment"># For reading, `receive-from-socket` will check for a</span> -<span class="Comment"># port-connection on the port parameter that's been passed in. If there's</span> -<span class="Comment"># no port-connection for that port, it will return nothing and log an error.</span> -<span class="Comment"># If there is a port-connection for that port, it will transmit the contents</span> -<span class="Comment"># to the provided sink.</span> +<span class="Comment"># To test client operations, use `assume-resources` with a filename that</span> +<span class="Comment"># begins with a hostname. (Filenames starting with '/' are assumed to be</span> +<span class="Comment"># local.)</span> <span class="Comment">#</span> -<span class="Comment"># For writing, `start-writing-socket` returns a sink connecting the</span> -<span class="Comment"># caller to the socket on the passed-in port.</span> -<span class="muData">container</span> port-connection [ - port:num - contents:text -] +<span class="Comment"># To test server operations, just run a real client against localhost.</span> -<span class="muRecipe">def</span> new-port-connection port:num, contents:text<span class="muRecipe"> -> </span>p:&:port-connection [ +<span class="muScenario">scenario</span> example-server-test [ <span class="Constant">local-scope</span> - <span class="Constant">load-ingredients</span> - p:&:port-connection<span class="Special"> <- </span>new <span class="Constant">port-connection:type</span> - *p<span class="Special"> <- </span>merge port, contents + <span class="Comment"># test server without a fake on a random (real) port</span> + <span class="Comment"># that way repeatedly running the test will give ports time to timeout and</span> + <span class="Comment"># close before reusing them</span> + make-random-nondeterministic + port:num<span class="Special"> <- </span>random-in-range <span class="Constant">0/real-random-numbers</span>, <span class="Constant">8000</span>, <span class="Constant">8100</span> + run [ + socket:num<span class="Special"> <- </span>$open-server-socket port + $print <span class="Constant">[server socket: ]</span>, socket, <span class="Constant">10/newline</span> + assert socket, <span class="Constant">[ </span> +<span class="Constant">F - example-server-test: $open-server-socket failed]</span> + $print <span class="Constant">[starting up server routine]</span>, <span class="Constant">10/newline</span> + handler-routine:number<span class="Special"> <- </span>start-running serve-one-request socket, example-handler + ] + $print <span class="Constant">[starting to read from port ]</span>, port, <span class="Constant">10/newline</span> + source:&:source:char<span class="Special"> <- </span>start-reading-from-network <span class="Constant">0/real-resources</span>, <span class="Constant">[localhost]</span>, <span class="Constant">[/]</span>, port + response:text<span class="Special"> <- </span>drain source + <span class="Constant">10</span>:@:char/<span class="Special">raw <- </span>copy *response + memory-should-contain [ + <span class="Constant">10</span>:array:character<span class="Special"> <- </span><span class="Constant">[abc]</span> + ] ] - -<span class="muRecipe">def</span> new-fake-network<span class="muRecipe"> -> </span>n:&:local-network [ +<span class="Comment"># helper just for this scenario</span> +<span class="muRecipe">def</span> example-handler query:text<span class="muRecipe"> -> </span>response:text [ <span class="Constant">local-scope</span> <span class="Constant">load-ingredients</span> - n:&:local-network<span class="Special"> <- </span>new <span class="Constant">local-network:type</span> - local-network-ports:&:@:port-connection<span class="Special"> <- </span>new <span class="Constant">port-connection:type</span>, <span class="Constant">0</span> - *n<span class="Special"> <- </span>put *n, <span class="Constant">data:offset</span>, local-network-ports + <span class="muControl">reply</span> <span class="Constant">[abc]</span> ] -<span class="muScenario">scenario</span> write-to-fake-socket [ +<span class="CommentedCode">#? scenario example-client-test [</span> +<span class="CommentedCode">#? local-scope</span> +<span class="CommentedCode">#? assume-resources [</span> +<span class="CommentedCode">#? [example.com/] -> [abc]</span> +<span class="CommentedCode">#? ]</span> +<span class="CommentedCode">#? run [</span> +<span class="CommentedCode">#? source:&:source:char <- start-reading-from-network resources, [example.com], [/]</span> +<span class="CommentedCode">#? ]</span> +<span class="CommentedCode">#? contents:text <- drain source</span> +<span class="CommentedCode">#? 10:@:char/raw <- copy *contents</span> +<span class="CommentedCode">#? memory-should-contain [</span> +<span class="CommentedCode">#? 10:address:character <- [abc]</span> +<span class="CommentedCode">#? ]</span> +<span class="CommentedCode">#? ]</span> + +<span class="muData">type</span> request-handler = (recipe text<span class="muRecipe"> -> </span>text) + +<span class="muRecipe">def</span> serve-one-request socket:num, request-handler:request-handler [ <span class="Constant">local-scope</span> - single-port-network:&:local-network<span class="Special"> <- </span>new-fake-network - sink:&:sink:char, writer:num/routine<span class="Special"> <- </span>start-writing-socket single-port-network, <span class="Constant">8080</span> - sink<span class="Special"> <- </span>write sink, <span class="Constant">120/x</span> - close sink - wait-for-routine writer - tested-port-connections:&:@:port-connection<span class="Special"> <- </span>get *single-port-network, <span class="Constant">data:offset</span> - tested-port-connection:port-connection<span class="Special"> <- </span>index *tested-port-connections, <span class="Constant">0</span> - contents:text<span class="Special"> <- </span>get tested-port-connection, <span class="Constant">contents:offset</span> - <span class="Constant">10</span>:@:char/<span class="Special">raw <- </span>copy *contents - memory-should-contain [ - <span class="Constant">10</span>:array:character<span class="Special"> <- </span><span class="Constant">[x]</span> - ] + <span class="Constant">load-ingredients</span> + session:num<span class="Special"> <- </span>$accept socket + $print <span class="Constant">[server session socket: ]</span>, session, <span class="Constant">10/newline</span> + assert session, <span class="Constant">[ </span> +<span class="Constant">F - example-server-test: $accept failed]</span> + contents:&:source:char, sink:&:sink:char<span class="Special"> <- </span>new-channel <span class="Constant">30</span> + sink<span class="Special"> <- </span>start-running receive-from-socket session, sink + query:text<span class="Special"> <- </span>drain contents + response:text<span class="Special"> <- </span>call request-handler, query + write-to-socket session, response + $close-socket session ] <span class="muRecipe">def</span> start-reading-from-network resources:&:resources, host:text, path:text<span class="muRecipe"> -> </span>contents:&:source:char [ <span class="Constant">local-scope</span> <span class="Constant">load-ingredients</span> + $print <span class="Constant">[running start-reading-from-network]</span>, <span class="Constant">10/newline</span> + <span class="Delimiter">{</span> + port:num, port-found?:boolean<span class="Special"> <- </span><span class="Constant">next-ingredient</span> + <span class="muControl">break-if</span> port-found? + port<span class="Special"> <- </span>copy <span class="Constant">80/http-port</span> + <span class="Delimiter">}</span> <span class="Delimiter">{</span> <span class="muControl">break-if</span> resources <span class="Comment"># real network</span> - socket:num<span class="Special"> <- </span>$open-client-socket host, <span class="Constant">80/http-port</span> + socket:num<span class="Special"> <- </span>$open-client-socket host, port + $print <span class="Constant">[client socket: ]</span>, socket, <span class="Constant">10/newline</span> assert socket, <span class="Constant">[contents]</span> req:text<span class="Special"> <- </span>interpolate <span class="Constant">[GET _ HTTP/1.1]</span>, path request-socket socket, req @@ -137,70 +155,72 @@ body { font-size: 12pt; font-family: monospace; color: #eeeeee; background-color $write-to-socket socket, <span class="Constant">10/lf</span> ] -<span class="muRecipe">def</span> start-writing-socket network:&:local-network, port:num<span class="muRecipe"> -> </span>sink:&:sink:char, routine-id:num [ - <span class="Constant">local-scope</span> - <span class="Constant">load-ingredients</span> - source:&:source:char, sink:&:sink:char<span class="Special"> <- </span>new-channel <span class="Constant">30</span> - <span class="Delimiter">{</span> - <span class="muControl">break-if</span> network - socket:num<span class="Special"> <- </span>$open-server-socket port - session:num<span class="Special"> <- </span>$accept socket - <span class="Comment"># TODO Create channel implementation of write-to-socket.</span> - <span class="muControl">return</span> sink, <span class="Constant">0/routine-id</span> - <span class="Delimiter">}</span> - <span class="Comment"># fake network</span> - routine-id<span class="Special"> <- </span>start-running transmit-to-fake-socket network, port, source -] +<span class="CommentedCode">#? def start-writing-socket network:&:local-network, port:num -> sink:&:sink:char, routine-id:num [</span> +<span class="CommentedCode">#? local-scope</span> +<span class="CommentedCode">#? load-ingredients</span> +<span class="CommentedCode">#? source:&:source:char, sink:&:sink:char <- new-channel 30</span> +<span class="CommentedCode">#? {</span> +<span class="CommentedCode">#? break-if network</span> +<span class="CommentedCode">#? socket:num <- $open-server-socket port</span> +<span class="CommentedCode">#? session:num <- $accept socket</span> +<span class="CommentedCode">#? # TODO Create channel implementation of write-to-socket.</span> +<span class="CommentedCode">#? return sink, 0/routine-id</span> +<span class="CommentedCode">#? }</span> +<span class="CommentedCode">#? # fake network</span> +<span class="CommentedCode">#? routine-id <- start-running transmit-to-fake-socket network, port, source</span> +<span class="CommentedCode">#? ]</span> -<span class="muRecipe">def</span> transmit-to-fake-socket network:&:local-network, port:num, source:&:source:char<span class="muRecipe"> -> </span>network:&:local-network, source:&:source:char [ - <span class="Constant">local-scope</span> - <span class="Constant">load-ingredients</span> - <span class="Comment"># compute new port connection contents</span> - buf:&:buffer<span class="Special"> <- </span>new-buffer <span class="Constant">30</span> - <span class="Delimiter">{</span> - c:char, done?:bool, source<span class="Special"> <- </span>read source - <span class="muControl">break-unless</span> c - buf<span class="Special"> <- </span>append buf, c - <span class="muControl">break-if</span> done? - <span class="muControl">loop</span> - <span class="Delimiter">}</span> - contents:text<span class="Special"> <- </span>buffer-to-array buf - new-port-connection:&:port-connection<span class="Special"> <- </span>new-port-connection port, contents - <span class="Comment"># Got the contents of the channel, time to write to fake port.</span> - i:num<span class="Special"> <- </span>copy <span class="Constant">0</span> - port-connections:&:@:port-connection<span class="Special"> <- </span>get *network, <span class="Constant">data:offset</span> - len:num<span class="Special"> <- </span>length *port-connections - <span class="Delimiter">{</span> - done?:bool<span class="Special"> <- </span>greater-or-equal i, len - <span class="muControl">break-if</span> done? - current:port-connection<span class="Special"> <- </span>index *port-connections, i - current-port:num<span class="Special"> <- </span>get current, <span class="Constant">port:offset</span> - ports-match?:bool<span class="Special"> <- </span>equal current-port, port - i<span class="Special"> <- </span>add i, <span class="Constant">1</span> - <span class="muControl">loop-unless</span> ports-match? - <span class="Comment"># Found an existing connection on this port, overwrite.</span> - put-index *port-connections, i, *new-port-connection - <span class="muControl">reply</span> - <span class="Delimiter">}</span> - <span class="Comment"># Couldn't find an existing connection on this port, initialize a new one.</span> - new-len:num<span class="Special"> <- </span>add len, <span class="Constant">1</span> - new-port-connections:&:@:port-connection<span class="Special"> <- </span>new <span class="Constant">port-connection:type</span>, new-len - put *network, <span class="Constant">data:offset</span>, new-port-connections - i:num<span class="Special"> <- </span>copy <span class="Constant">0</span> - <span class="Delimiter">{</span> - done?:bool<span class="Special"> <- </span>greater-or-equal i, len - <span class="muControl">break-if</span> done? - tmp:port-connection<span class="Special"> <- </span>index *port-connections, i - put-index *new-port-connections, i, tmp - <span class="Delimiter">}</span> - put-index *new-port-connections, len, *new-port-connection -] +<span class="CommentedCode">#? def transmit-to-fake-socket network:&:local-network, port:num, source:&:source:char -> network:&:local-network, source:&:source:char [</span> +<span class="CommentedCode">#? local-scope</span> +<span class="CommentedCode">#? load-ingredients</span> +<span class="CommentedCode">#? # compute new port connection contents</span> +<span class="CommentedCode">#? buf:&:buffer <- new-buffer 30</span> +<span class="CommentedCode">#? {</span> +<span class="CommentedCode">#? c:char, done?:bool, source <- read source</span> +<span class="CommentedCode">#? break-unless c</span> +<span class="CommentedCode">#? buf <- append buf, c</span> +<span class="CommentedCode">#? break-if done?</span> +<span class="CommentedCode">#? loop</span> +<span class="CommentedCode">#? }</span> +<span class="CommentedCode">#? contents:text <- buffer-to-array buf</span> +<span class="CommentedCode">#? new-port-connection:&:port-connection <- new-port-connection port, contents</span> +<span class="CommentedCode">#? # Got the contents of the channel, time to write to fake port.</span> +<span class="CommentedCode">#? i:num <- copy 0</span> +<span class="CommentedCode">#? port-connections:&:@:port-connection <- get *network, data:offset</span> +<span class="CommentedCode">#? len:num <- length *port-connections</span> +<span class="CommentedCode">#? {</span> +<span class="CommentedCode">#? done?:bool <- greater-or-equal i, len</span> +<span class="CommentedCode">#? break-if done?</span> +<span class="CommentedCode">#? current:port-connection <- index *port-connections, i</span> +<span class="CommentedCode">#? current-port:num <- get current, port:offset</span> +<span class="CommentedCode">#? ports-match?:bool <- equal current-port, port</span> +<span class="CommentedCode">#? i <- add i, 1</span> +<span class="CommentedCode">#? loop-unless ports-match?</span> +<span class="CommentedCode">#? # Found an existing connection on this port, overwrite.</span> +<span class="CommentedCode">#? put-index *port-connections, i, *new-port-connection</span> +<span class="CommentedCode">#? reply</span> +<span class="CommentedCode">#? }</span> +<span class="CommentedCode">#? # Couldn't find an existing connection on this port, initialize a new one.</span> +<span class="CommentedCode">#? new-len:num <- add len, 1</span> +<span class="CommentedCode">#? new-port-connections:&:@:port-connection <- new port-connection:type, new-len</span> +<span class="CommentedCode">#? put *network, data:offset, new-port-connections</span> +<span class="CommentedCode">#? i:num <- copy 0</span> +<span class="CommentedCode">#? {</span> +<span class="CommentedCode">#? done?:bool <- greater-or-equal i, len</span> +<span class="CommentedCode">#? break-if done?</span> +<span class="CommentedCode">#? tmp:port-connection <- index *port-connections, i</span> +<span class="CommentedCode">#? put-index *new-port-connections, i, tmp</span> +<span class="CommentedCode">#? }</span> +<span class="CommentedCode">#? put-index *new-port-connections, len, *new-port-connection</span> +<span class="CommentedCode">#? ]</span> <span class="muRecipe">def</span> receive-from-socket socket:num, sink:&:sink:char<span class="muRecipe"> -> </span>sink:&:sink:char [ <span class="Constant">local-scope</span> <span class="Constant">load-ingredients</span> <span class="Delimiter">{</span> + $print <span class="Constant">[read-from-socket ]</span>, socket, <span class="Constant">10/newline</span> req:text, eof?:bool<span class="Special"> <- </span>$read-from-socket socket, <span class="Constant">4096/bytes</span> + <span class="muControl">loop-unless</span> req bytes-read:num<span class="Special"> <- </span>length *req i:num<span class="Special"> <- </span>copy <span class="Constant">0</span> <span class="Delimiter">{</span> |