racket/collects/unstable/scribblings/socket.scrbl
2013-02-14 17:19:08 -05:00

28 lines
800 B
Racket

#lang scribble/manual
@(require "utils.rkt"
(for-label racket/base
racket/contract
unstable/socket))
@title[#:tag "unix-socket"]{Unix Domain Sockets}
@unstable-header[]
@defmodule[unstable/socket]
@defthing[unix-socket-available?
boolean?]{
A boolean value that indicates whether unix domain sockets are
available and supported on the current platform. The supported
platforms are Linux and Mac OS X; unix domain sockets are not
supported on Windows and other Unix variants.
}
@defproc[(unix-socket-connect [socket-path path-string?])
(values input-port? output-port?)]{
Connects to the unix domain socket associated with
@racket[socket-path] and returns an input port and output port for
communicating with the socket.
}