<!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">

<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 20051202</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>
      &nbsp;<a href = "Index">Index</a>
      &nbsp;
</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><FONT COLOR="#228B22"><B> t </FONT></B>=<FONT COLOR="#228B22"><B> word
         </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: ('a, 'b) Socket.sock -&gt; (string * int 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><FONT COLOR="#228B22"><B> t </FONT></B>=<FONT COLOR="#228B22"><B> {name: string}

            </FONT></B><B><FONT COLOR="#A020F0">val</FONT></B> getByAddress: Address.t -&gt; t option
            <B><FONT COLOR="#A020F0">val</FONT></B> getByName: string -&gt; 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><FONT COLOR="#228B22"><B> t </FONT></B>=<FONT COLOR="#228B22"><B> int
         </FONT></B><B><FONT COLOR="#0000FF">end</FONT></B>

      <B><FONT COLOR="#A020F0">type</FONT></B><FONT COLOR="#228B22"><B> t

      </FONT></B><B><FONT COLOR="#A020F0">val</FONT></B> accept: t -&gt; Address.t * Port.t * TextIO.instream * TextIO.outstream
      <B><FONT COLOR="#A020F0">val</FONT></B> connect: string * Port.t -&gt; TextIO.instream * TextIO.outstream
      <B><FONT COLOR="#A020F0">val</FONT></B> fdToSock: Posix.FileSys.file_desc -&gt; ('a, 'b) Socket.sock
      <B><FONT COLOR="#A020F0">val</FONT></B> listen: unit -&gt; Port.t * t
      <B><FONT COLOR="#A020F0">val</FONT></B> listenAt: Port.t -&gt; t
      <B><FONT COLOR="#A020F0">val</FONT></B> shutdownRead: TextIO.instream -&gt; unit
      <B><FONT COLOR="#A020F0">val</FONT></B> shutdownWrite: TextIO.outstream -&gt; unit
   <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 Standard Basis Library.  We encourage you to use the standard <tt>Socket</tt> module, since we may eliminate <tt>MLton.Socket</tt> some day. 
</p>

    <ul>

    <li>
<p>
 <tt>type&nbsp;Address.t</tt> 
</p>
</li>

        <ul>

  the type of IP addresses. 
        </ul>


    <li class="gap">
<p>
 <tt>Ctl.getERROR&nbsp;s</tt> 
</p>
</li>

        <ul>

  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. 
        </ul>


    <li class="gap">
<p>
 <tt>Host.getByAddress&nbsp;a</tt> 
</p>
</li>

        <ul>

  looks up the hostname (using <tt>gethostbyaddr</tt>) corresponding to   <tt>a</tt>.  
        </ul>


    <li class="gap">
<p>
 <tt>Host.getByName&nbsp;s</tt> 
</p>
</li>

        <ul>

  looks up the hostname (using <tt>gethostbyname</tt>) corresponding to   <tt>s</tt>.  
        </ul>


    <li class="gap">
<p>
 <tt>type&nbsp;Port.t</tt> 
</p>
</li>

        <ul>

  the type of TCP ports. 
        </ul>


    <li class="gap">
<p>
 <tt>type&nbsp;t</tt> 
</p>
</li>

        <ul>

  the type of sockets. 
        </ul>


    <li class="gap">
<p>
 <tt>accept&nbsp;s</tt> 
</p>
</li>

        <ul>

  accepts a connection on socket <tt>s</tt> and return the address and   port of the connecting socket, as well as streams corresponding to   the connection. 
        </ul>


    <li class="gap">
<p>
 <tt>connect&nbsp;(h,&nbsp;p)</tt> 
</p>
</li>

        <ul>

  connects to host <tt>h</tt> on port <tt>p</tt>, returning the streams   corresponding to the connection. 
        </ul>


    <li class="gap">
<p>
 <tt>fdToSock&nbsp;fd</tt> 
</p>
</li>

        <ul>

  coerces a file descriptor to a socket. 
        </ul>


    <li class="gap">
<p>
 <tt>listen&nbsp;()</tt> 
</p>
</li>

        <ul>

  listens to a port chosen by the system.  Returns the port and the   socket. 
        </ul>


    <li class="gap">
<p>
 <tt>listenAt&nbsp;p</tt> 
</p>
</li>

        <ul>

  listens to port <tt>p</tt>.  Returns the socket. 
        </ul>


    <li class="gap">
<p>
 <tt>shutdownRead&nbsp;ins</tt> 
</p>
</li>

        <ul>

  causes the read part of the socket associated with <tt>ins</tt> to be   shutdown.  
        </ul>


    <li class="gap">
<p>
 <tt>shutdownWrite&nbsp;out</tt> 
</p>
</li>

        <ul>

  causes the write part of the socket associated with <tt>out</tt> to be   shutdown.  </ul>

</ul>

</div>



<p>
<hr>
Last edited on 2005-12-01 23:07:28 by <span title="ppp-71-139-183-221.dsl.snfc21.pacbell.net"><a href="StephenWeeks">StephenWeeks</a></span>.
</body></html>
