minimal documentation for David's port clause

This commit is contained in:
Matthias Felleisen 2014-05-04 18:32:24 -04:00
parent 19e068f1c6
commit 16956c3daf

View File

@ -199,6 +199,7 @@ The design of a world program demands that you come up with a data
(state boolean-expr) (state boolean-expr)
(on-receive rec-expr) (on-receive rec-expr)
(register IP-expr) (register IP-expr)
(port Port-expr)
(name name-expr) (name name-expr)
])]{ ])]{
@ -981,6 +982,12 @@ following shapes:
@racket[(name SomeString)] or @racket[(name SomeSymbol)], the name of the @racket[(name SomeString)] or @racket[(name SomeSymbol)], the name of the
world is sent along to the server. world is sent along to the server.
}} }}
@item{
@defform[(port port-expr) #:contracts ([port-expr natural-number/c])]{
specifies port on which a world wishes to receive and send messages. A
port number is an integer between @racket[0] and @racket[65536].
}}
] ]
When a world program registers with a universe program and the universe program When a world program registers with a universe program and the universe program
@ -1154,7 +1161,7 @@ The @tech{server} itself is created with a description that includes the
@defform/subs[#:id universe @defform/subs[#:id universe
#:literals #:literals
(on-new on-msg on-tick on-disconnect to-string check-with state) (on-new on-msg on-tick on-disconnect to-string check-with port state)
(universe state-expr clause ...) (universe state-expr clause ...)
([clause ([clause
(on-new new-expr) (on-new new-expr)
@ -1165,6 +1172,7 @@ The @tech{server} itself is created with a description that includes the
(on-disconnect dis-expr) (on-disconnect dis-expr)
(state boolean-expr) (state boolean-expr)
(to-string render-expr) (to-string render-expr)
(port port-expr)
(check-with universe?-expr) (check-with universe?-expr)
])]{ ])]{
@ -1255,7 +1263,8 @@ optional handlers:
@item{ @item{
@defform[(on-disconnect dis-expr) @defform[#:literals (on-disconnect)
(on-disconnect dis-expr)
#:contracts #:contracts
([dis-expr (-> (unsyntax @tech{UniverseState}) iworld? bundle?)])]{ ([dis-expr (-> (unsyntax @tech{UniverseState}) iworld? bundle?)])]{
tells DrRacket to invoke @racket[dis-expr] every time a participating tells DrRacket to invoke @racket[dis-expr] every time a participating
@ -1266,6 +1275,15 @@ optional handlers:
DrRacket not to wait for messages from this world anymore.} DrRacket not to wait for messages from this world anymore.}
} }
@item{
@defform/none[#:literals (port)
(port port-expr)
#:contracts
([port-expr natural-number/c])]{
specifies port on which a universe wishes to receive and send messages. A
port number is an integer between @racket[0] and @racket[65536].
}}
@item{ @item{
@defform[(to-string render-expr) @defform[(to-string render-expr)
#:contracts #:contracts