changeset 52596:f277840b17b2

(Network, Network Servers): Fix typos. (Low-Level Network): Add timeout value for :server keyword. Add new option keywords to make-network-process. Add set-network-process-options. Explain how to test availability of network options.

--- a/lispref/processes.texi	Tue Sep 23 22:05:14 2003 +0000
+++ b/lispref/processes.texi	Tue Sep 23 22:05:38 2003 +0000
@@ -1473,10 +1473,11 @@
 @section Network Connections
 @cindex network connection
 @cindex TCP
+@cindex UDP
 
-  Emacs Lisp programs can open TCP and datagram network connections to
-other processes on the same machine or other machines.  A network
-connection is handled by Lisp much like a subprocess, and is
+  Emacs Lisp programs can open stream (TCP) and datagram (UDP) network
+connections to other processes on the same machine or other machines.
+A network connection is handled by Lisp much like a subprocess, and is
 represented by a process object.  However, the process you are
 communicating with is not a child of the Emacs process, so it has no
 process @sc{id}, and you can't kill it or send it signals.  All you
@@ -1504,12 +1505,13 @@
   You can stop and resume operation of a network processes by calling
 @code{stop-process} and @code{continue-process}.  For a server
 process, being stopped means not accepting new connections.  (Up to 5
-connection requests will be queued for when you resume the server;
-this limit is imposed by the operating system.)  For a network
-connection, being stopped means not processing input (any arriving
-input waits until you resume the connection).  You can use the
-function @code{process-command} to determine whether a network
-connection or server is stopped; a non-@code{nil} value means yes.
+connection requests will be queued for when you resume the server; you
+can increase this limit, unless it is imposed by the operating
+systems.)  For a network connection, being stopped means not
+processing input (any arriving input waits until you resume the
+connection).  You can use the function @code{process-command} to
+determine whether a network connection or server is stopped; a
+non-@code{nil} value means yes.
 
 @defun open-network-stream name buffer-or-name host service
 This function opens a TCP connection, and returns a process object
@@ -1565,7 +1567,7 @@
 @item :filter
 The associated value is the process filter function.
 @item :sentinel
-The associated value is the process filter function.
+The associated value is the process sentinel function.
 @item :remote
 In a connection, this is the address in internal format of the remote peer.
 @item :local
@@ -1599,12 +1601,12 @@
 server process' @var{name} with a client identification string.  The
 client identification string for an IPv4 connection looks like
 @samp{<@var{a}.@var{b}.@var{c}.@var{d}:@var{p}>}.  Otherwise, it is a
-unique number in brackets, as in @samp{<@var{nnn>}}.  The number
+unique number in brackets, as in @samp{<@var{nnn}>}.  The number
 is unique for each connection in the Emacs session.
 
 @item
 If the server's filter is non-@code{nil}, the connection process does
-not get a separate process buffer; otherwise, Emacs creates a bew
+not get a separate process buffer; otherwise, Emacs creates a new
 buffer for the purpose.  The buffer name is the server's buffer name
 or process name, concatenated with the client identification string.
 
@@ -1691,8 +1693,8 @@
 process object that represents it.  The arguments @var{args} are a
 list of keyword/argument pairs.  Omitting a keyword is always
 equivalent to specifying it with value @code{nil}, except for
-@code{:coding} and @code{:filter-multibyte}.  Here are the meaningful
-keywords:
+@code{:coding}, @code{:filter-multibyte}, and @code{:reuseaddr}.  Here
+are the meaningful keywords:
 
 @table @asis
 @item :name name
@@ -1706,7 +1708,9 @@
 
 @item :server @var{server-flag}
 If @var{server-flag} is non-@code{nil}, create a server.  Otherwise,
-create a connection.
+create a connection.  For a stream type server, @var{server-flag} may
+be an integer which then specifies the length of the queue of pending
+connections to the server.  The default queue length is 5.
 
 @item :host @var{host}
 Specify the host to connect to.  @var{host} should be a host name or
@@ -1785,14 +1789,10 @@
 @var{encoding})} for @var{coding}.
 
 If you don't specify this keyword at all, the default
-is to determine the coding systemx from the data.
-
-@item :options @var{options}
-Set the specified options for the network process.  See
-@code{set-network-process-options} for details.
+is to determine the coding systems from the data.
 
 @item :noquery @var{query-flag}
-Initialize the process query flag to @var{query-flag}.
+Initialize the process query flag to @var{query-flag}.  @xref{Query Before Exit}.
 
 @item :filter @var{filter}
 Initialize the process filter to @var{filter}.
@@ -1819,10 +1819,84 @@
 Initialize the process plist to @var{plist}.
 @end table
 
+The following network options can be specified for the network
+process.  Except for @code{:reuseaddr}, you can set or modify these
+options later using @code{set-network-process-option}.
+
+For a server process, the options specified with
+@code{make-network-process} are not inherited by the client
+connections, so you will need to set the necessary options for each
+child connection as they are created.
+
+@table asis
+@item :bindtodevice @var{device-name}
+If @var{device-name} is a non-empty string identifying a network
+interface name (see @code{network-interface-list}), only handle
+packets received on that interface.  If @var{device-name} is nil (the
+default), handle packets received on any interface.
+
+Using this option may require special privileges on some systems.
+
+@item :broadcast @var{broadcast-flag}
+If @var{broadcast-flag} is non-@code{nil} for a datagram process, the
+process will receive datagram packet sent to a broadcast address, and
+be able to send packets to a broadcast address.  Ignored for a stream
+connection.
+
+@item :dontroute @var{dontroute-flag}
+If @var{dontroute-flag} is non-@code{nil}, the process can only send
+to hosts on the same network as the local host.
+
+@item :keepalive @var{keepalive-flag}
+If @var{keepalive-flag} is non-@code{nil} for a stream connection,
+enable exchange of low-level keep-alive messa
+
+@item :linger @var{linger-arg}
+If @var{linger-arg} is non-@code{nil}, wait for successful
+transmission of all queued packets on the connection before it is
+deleted (see @code{delete-process}).  If @var{linger-arg} is an
+integer, it specifies the maximum time in seconds to wait for queued
+packets to be sent before closing the connection.  Default is
+@code{nil} which means to discard unsent queued packets when the
+process is deleted.
+
+@item :oobinline @var{oobinline-flag}
+If @var{oobinline-flag} is non-@code{nil} for a stream connection,
+receive out-of-band data in the normal data stream.  Otherwise, ignore
+out-of-band data.
+
+@item :priority @var{priority}
+Set the priority for packets sent on this connection to the integer
+@var{priority}.  The interpretation of this number is protocol
+specific, such as setting the TOS (type of service) field on IP
+packets sent on this connection.  It may also have system dependent
+effects, such as selecting a specific output queue on the network
+interface.
+
+@item :reuseaddr @var{reuseaddr-flag}
+If @var{reuseaddr-flag} is non-@code{nil} (the default) for a stream
+server process, allow this server to reuse a specific port number (see
+@code{:service}) unless another process on this host is already
+listening on that port.  If @var{reuseaddr-flag} is @code{nil}, there
+may be a period of time after the last use of that port (by any
+process on the host), where it is not possible to make a new server on
+that port.
+
+@end table
+
 The original argument list, modified with the actual connection
 information, is available via the `process-contact' function.
 @end defun
 
+@defun set-network-process-option process option value
+This function sets or modifies a network option for network process
+@var{process}.  See @code{make-network-process} for details of options
+@var{option} and their corresponding values @var{value}.
+
+The current setting of an option is available via the
+`process-contact' function.
+@end defun
+
 @defun network-interface-list
 This function returns a list describing the network interfaces
 of the machine you are using.  The value is an alist whose
@@ -1869,9 +1943,12 @@
 @end example 
 
 @noindent
-The result is @code{t} if it works to specify @var{keyword} with value
-@var{value} in @code{make-network-process}.  Here are some of the
-@var{keyword}---@var{value} pairs you can test in this way.
+The result of the first form is @code{t} if it works to specify
+@var{keyword} with value @var{value} in @code{make-network-process}.
+The result of the second form is @code{t} if @var{keyword} is
+supported by @code{make-network-process}.  Here are some of the
+@var{keyword}---@var{value} pairs you can test in
+this way.
 
 @table @code
 @item (:nowait t)
@@ -1882,15 +1959,29 @@
 Non-@code{nil} if local (aka ``UNIX domain'') sockets are supported.
 @item (:service t)
 Non-@code{nil} if the system can select the port for a server.
-@item (:options bindtodevice)
-@itemx (:options broadcast)
-@itemx (:options dontroute)
-@itemx (:options keepalive)
-@itemx (:options linger)
-@itemx (:options oobinline)
-@itemx (:options priority)
-@itemx (:options reuseaddr)
-That particular socket option is supported.
+@end table
+
+  To test for the availability of a given network option, use
+@code{featurep} like this:
+
+@example
+(featurep 'make-network-process '@var{keyword})
+@end example 
+
+Here are some of the option @var{keyword}s you can test in
+this way.
+
+@table @code
+@item :bindtodevice
+@itemx :broadcast
+@itemx :dontroute
+@itemx :keepalive
+@itemx :linger
+@itemx :oobinline
+@itemx :priority
+@itemx :reuseaddr
+That particular network option is supported by
+@code{make-network-process} and @code{set-network-process-option}.
 @end table
 
 @ignore