Fred Drake | 295da24 | 1998-08-10 19:42:37 +0000 | [diff] [blame] | 1 | \section{\module{gopherlib} --- |
Fred Drake | bcd5454 | 1999-04-22 16:17:45 +0000 | [diff] [blame] | 2 | Gopher protocol client} |
Fred Drake | b91e934 | 1998-07-23 17:59:49 +0000 | [diff] [blame] | 3 | |
Fred Drake | bcd5454 | 1999-04-22 16:17:45 +0000 | [diff] [blame] | 4 | \declaremodule{standard}{gopherlib} |
Fred Drake | b91e934 | 1998-07-23 17:59:49 +0000 | [diff] [blame] | 5 | \modulesynopsis{Gopher protocol client (requires sockets).} |
| 6 | |
Fred Drake | 1566a1d | 1998-01-07 13:17:20 +0000 | [diff] [blame] | 7 | \indexii{Gopher}{protocol} |
Guido van Rossum | 8675115 | 1995-02-28 17:14:32 +0000 | [diff] [blame] | 8 | |
Guido van Rossum | cca8d2b | 1995-03-22 15:48:46 +0000 | [diff] [blame] | 9 | This module provides a minimal implementation of client side of the |
Raymond Hettinger | 7e43110 | 2003-09-22 15:00:55 +0000 | [diff] [blame] | 10 | Gopher protocol. It is used by the module \refmodule{urllib} to |
Fred Drake | bcd5454 | 1999-04-22 16:17:45 +0000 | [diff] [blame] | 11 | handle URLs that use the Gopher protocol. |
Guido van Rossum | cca8d2b | 1995-03-22 15:48:46 +0000 | [diff] [blame] | 12 | |
| 13 | The module defines the following functions: |
| 14 | |
Fred Drake | 1566a1d | 1998-01-07 13:17:20 +0000 | [diff] [blame] | 15 | \begin{funcdesc}{send_selector}{selector, host\optional{, port}} |
Guido van Rossum | cca8d2b | 1995-03-22 15:48:46 +0000 | [diff] [blame] | 16 | Send a \var{selector} string to the gopher server at \var{host} and |
Fred Drake | 1566a1d | 1998-01-07 13:17:20 +0000 | [diff] [blame] | 17 | \var{port} (default \code{70}). Returns an open file object from |
| 18 | which the returned document can be read. |
Guido van Rossum | cca8d2b | 1995-03-22 15:48:46 +0000 | [diff] [blame] | 19 | \end{funcdesc} |
| 20 | |
Fred Drake | 1566a1d | 1998-01-07 13:17:20 +0000 | [diff] [blame] | 21 | \begin{funcdesc}{send_query}{selector, query, host\optional{, port}} |
Guido van Rossum | cca8d2b | 1995-03-22 15:48:46 +0000 | [diff] [blame] | 22 | Send a \var{selector} string and a \var{query} string to a gopher |
Fred Drake | 1566a1d | 1998-01-07 13:17:20 +0000 | [diff] [blame] | 23 | server at \var{host} and \var{port} (default \code{70}). Returns an |
| 24 | open file object from which the returned document can be read. |
Guido van Rossum | cca8d2b | 1995-03-22 15:48:46 +0000 | [diff] [blame] | 25 | \end{funcdesc} |
| 26 | |
| 27 | Note that the data returned by the Gopher server can be of any type, |
| 28 | depending on the first character of the selector string. If the data |
| 29 | is text (first character of the selector is \samp{0}), lines are |
| 30 | terminated by CRLF, and the data is terminated by a line consisting of |
| 31 | a single \samp{.}, and a leading \samp{.} should be stripped from |
Fred Drake | 1566a1d | 1998-01-07 13:17:20 +0000 | [diff] [blame] | 32 | lines that begin with \samp{..}. Directory listings (first character |
Guido van Rossum | cca8d2b | 1995-03-22 15:48:46 +0000 | [diff] [blame] | 33 | of the selector is \samp{1}) are transferred using the same protocol. |