suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

ffi docs: clarification on unsafe-socket->port

Browse Source 
Thanks to Hong Feng for suggesting the clarification.
This commit is contained in:
Matthew Flatt 2018-03-06 08:51:49 -07:00
parent c5653b5bdd
commit efb9a919fc
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
pkgs/racket-doc/scribblings/foreign/port.scrbl
View File

@ -1,6 +1,7 @@
#lang scribble/doc #lang scribble/doc
@(require "utils.rkt" @(require "utils.rkt"
(for-label ffi/unsafe/port)) (for-label ffi/unsafe/port
racket/tcp))
@title{Ports} @title{Ports}
@ -26,9 +27,10 @@ objects.}
Returns an input port and/or output port for the given file descriptor Returns an input port and/or output port for the given file descriptor
or socket. On Windows, a ``file descriptor'' corresponds to a file or socket. On Windows, a ``file descriptor'' corresponds to a file
@tt{HANDLE}, while a socket corresponds to a @tt{SOCKET}. One Unix, a @tt{HANDLE}, while a socket corresponds to a @tt{SOCKET}. On Unix, a
socket is a file descriptor, but using socket-specific functions may socket is a file descriptor, but using the socket-specific
enable socket-specific functionality. @racket[unsafe-socket->port] may enable socket-specific functionality,
such as address reporting via @racket[tcp-addresses].
The @racket[name] argument determines the port's name as reported by The @racket[name] argument determines the port's name as reported by
@racket[object-name]. The @racket[name] must be a UTF-8 encoding that @racket[object-name]. The @racket[name] must be a UTF-8 encoding that