/usr/share/doc/mlton/guide/MLtonSocket is in mlton-doc 20100608-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta name="robots" content="index,nofollow">
<title>MLtonSocket - MLton Standard ML Compiler (SML Compiler)</title>
<link rel="stylesheet" type="text/css" charset="iso-8859-1" media="all" href="common.css">
<link rel="stylesheet" type="text/css" charset="iso-8859-1" media="screen" href="screen.css">
<link rel="stylesheet" type="text/css" charset="iso-8859-1" media="print" href="print.css">
<link rel="Start" href="Home">
</head>
<body lang="en" dir="ltr">
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
</script>
<script type="text/javascript">
_uacct = "UA-833377-1";
urchinTracker();
</script>
<table bgcolor = lightblue cellspacing = 0 style = "border: 0px;" width = 100%>
<tr>
<td style = "
border: 0px;
color: darkblue;
font-size: 150%;
text-align: left;">
<a class = mltona href="Home">MLton MLTONWIKIVERSION</a>
<td style = "
border: 0px;
font-size: 150%;
text-align: center;
width: 50%;">
MLtonSocket
<td style = "
border: 0px;
text-align: right;">
<table cellspacing = 0 style = "border: 0px">
<tr style = "vertical-align: middle;">
</table>
<tr style = "background-color: white;">
<td colspan = 3
style = "
border: 0px;
font-size:70%;
text-align: right;">
<a href = "Home">Home</a>
<a href = "TitleIndex">Index</a>
</table>
<div id="content" lang="en" dir="ltr">
<pre class=code>
<B><FONT COLOR="#0000FF">signature</FONT></B> MLTON_SOCKET =
<B><FONT COLOR="#0000FF">sig</FONT></B>
<B><FONT COLOR="#0000FF">structure</FONT></B> Address:
<B><FONT COLOR="#0000FF">sig</FONT></B>
<B><FONT COLOR="#A020F0">type</FONT></B><B><FONT COLOR="#228B22"> t </FONT></B>=<B><FONT COLOR="#228B22"> NetHostDB.in_addr
</FONT></B><B><FONT COLOR="#0000FF">end</FONT></B>
<B><FONT COLOR="#0000FF">structure</FONT></B> Ctl:
<B><FONT COLOR="#0000FF">sig</FONT></B>
<B><FONT COLOR="#A020F0">val</FONT></B> getERROR: ('af, 'sock_type) Socket.sock -> (string * Posix.Error.syserror option) option
<B><FONT COLOR="#0000FF">end</FONT></B>
<B><FONT COLOR="#0000FF">structure</FONT></B> Host:
<B><FONT COLOR="#0000FF">sig</FONT></B>
<B><FONT COLOR="#A020F0">type</FONT></B><B><FONT COLOR="#228B22"> t </FONT></B>=<B><FONT COLOR="#228B22"> {name: string}
</FONT></B><B><FONT COLOR="#A020F0">val</FONT></B> getByAddress: Address.t -> t option
<B><FONT COLOR="#A020F0">val</FONT></B> getByName: string -> t option
<B><FONT COLOR="#0000FF">end</FONT></B>
<B><FONT COLOR="#0000FF">structure</FONT></B> Port:
<B><FONT COLOR="#0000FF">sig</FONT></B>
<B><FONT COLOR="#A020F0">type</FONT></B><B><FONT COLOR="#228B22"> t </FONT></B>=<B><FONT COLOR="#228B22"> int
</FONT></B><B><FONT COLOR="#0000FF">end</FONT></B>
<B><FONT COLOR="#A020F0">type</FONT></B><B><FONT COLOR="#228B22"> t
</FONT></B><B><FONT COLOR="#A020F0">val</FONT></B> accept: t -> Address.t * Port.t * TextIO.instream * TextIO.outstream
<B><FONT COLOR="#A020F0">val</FONT></B> connect: string * Port.t -> TextIO.instream * TextIO.outstream
<B><FONT COLOR="#A020F0">val</FONT></B> listen: unit -> Port.t * t
<B><FONT COLOR="#A020F0">val</FONT></B> listenAt: Port.t -> t
<B><FONT COLOR="#A020F0">val</FONT></B> shutdownRead: TextIO.instream -> unit
<B><FONT COLOR="#A020F0">val</FONT></B> shutdownWrite: TextIO.outstream -> unit
<B><FONT COLOR="#A020F0">val</FONT></B> fdToSock: Posix.FileSys.file_desc -> ('a, 'b) Socket.sock
<B><FONT COLOR="#0000FF">end</FONT></B>
</PRE>
<p>
</p>
<p>
This module contains a bare minimum of functionality to do TCP/IP programming. This module is implemented on top of the <tt>Socket</tt> module of the <a href="BasisLibrary">Basis Library</a>. We encourage you to use the standard <tt>Socket</tt> module, since <tt>MLton.Socket</tt> is deprecated.
</p>
<ul>
<li>
<p>
<tt>type Address.t</tt> <br>
the type of IP addresses.
</p>
</li>
<li class="gap">
<p>
<tt>Ctl.getERROR s</tt> <br>
like the Basis Library's <tt>Socket.Ctl.getERROR</tt>, except that it returns more information. <tt>NONE</tt> means that there was no error, and <tt>SOME</tt> means that there was an error, and provides the error message and error code, if any.
</p>
</li>
<li class="gap">
<p>
<tt>Host.getByAddress a</tt> <br>
looks up the hostname (using <tt>gethostbyaddr</tt>) corresponding to <tt>a</tt>.
</p>
</li>
<li class="gap">
<p>
<tt>Host.getByName s</tt> <br>
looks up the hostname (using <tt>gethostbyname</tt>) corresponding to <tt>s</tt>.
</p>
</li>
<li class="gap">
<p>
<tt>type Port.t</tt> <br>
the type of TCP ports.
</p>
</li>
<li class="gap">
<p>
<tt>type t</tt> <br>
the type of sockets.
</p>
</li>
<li class="gap">
<p>
<tt>accept s</tt> <br>
accepts a connection on socket <tt>s</tt> and return the address port of the connecting socket, as well as streams corresponding to the connection.
</p>
</li>
<li class="gap">
<p>
<tt>connect (h, p)</tt> <br>
connects to host <tt>h</tt> on port <tt>p</tt>, returning the streams corresponding to the connection.
</p>
</li>
<li class="gap">
<p>
<tt>listen ()</tt> <br>
listens to a port chosen by the system. Returns the port and the socket.
</p>
</li>
<li class="gap">
<p>
<tt>listenAt p</tt> <br>
listens to port <tt>p</tt>. Returns the socket.
</p>
</li>
<li class="gap">
<p>
<tt>shutdownRead ins</tt> <br>
causes the read part of the socket associated with <tt>ins</tt> to be shutdown.
</p>
</li>
<li class="gap">
<p>
<tt>shutdownWrite out</tt> <br>
causes the write part of the socket associated with <tt>out</tt> to be shutdown.
</p>
</li>
<li class="gap">
<p>
<tt>fdToSock fd</tt> <br>
coerces a file descriptor to a socket.
</p>
</li>
</ul>
</div>
<p>
<hr>
Last edited on 2007-08-23 03:45:24 by <span title="c-71-57-91-146.hsd1.il.comcast.net"><a href="MatthewFluet">MatthewFluet</a></span>.
</body></html>
|