Basis/unix-sock.html

<!-- HTML/unix-sock.html -->

<!-- COPYRIGHT (c) 1998 Bell Labs, Lucent Technologies. -->

<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3.2//EN">
<HTML>
<HEAD>
<TITLE>The UnixSock structure</TITLE>
<META NAME=generator CONTENT="ML-Doc::html-gen">
</HEAD>
<BODY BGCOLOR="#FFFFFF"><A NAME="top"></A>
<H1 align=CENTER>The Standard ML Basis Library</H1>
<HR>


<H2><A NAME="section:0"></A>The <CODE>UnixSock</CODE> structure</H2>
<HR>
<H4>Synopsis</H4>
<BLOCKQUOTE>
<CODE><B>signature</B>&nbsp;<A NAME="UNIX_SOCK:SIG:SPEC"></A><CODE>UNIX_SOCK</CODE>&nbsp;&nbsp;<FONT COLOR="#FF0000"><CODE><I>(* OPTIONAL *)</I></CODE></FONT><BR>
<B>structure</B>&nbsp;<A NAME="UnixSock:STR:SPEC"></A><CODE>UnixSock</CODE><B> :> </B>UNIX_SOCK&nbsp;&nbsp;<FONT COLOR="#FF0000"><CODE><I>(* OPTIONAL *)</I></CODE></FONT><BR>
</CODE>
</BLOCKQUOTE>
<P>
This structure is used to create sockets in the Unix address family. This structure is only present when the underlying operating system supports Unix-domain sockets.
<P>
 Binding a name to a Unix-domain socket with  <CODE><A HREF="socket.html#SIG:SOCKET.bind:VAL:SPEC">bind</A></CODE> causes a socket file to be created in the filesystem. This file is not removed when the socket is closed; <CODE><A HREF="os-file-sys.html#SIG:OS_FILE_SYS.remove:VAL:SPEC">OS.FileSys.remove</A></CODE> must be used to remove the file. The usual filesystem access-control mechanisms are applied when referencing Unix-domain sockets; <I>e.g.</I>, the file representing the destination of a <CODE><A HREF="socket.html#SIG:SOCKET.connect:VAL:SPEC">connect</A></CODE> or <CODE><A HREF="socket.html#SIG:SOCKET.sendVec:VAL:SPEC">sendVec</A></CODE> must be writable. 
<HR>
<H4>Interface</H4>
<BLOCKQUOTE>
<CODE><B>type</B>&nbsp;<A NAME="SIG:UNIX_SOCK.unix:TY:SPEC" HREF="#SIG:UNIX_SOCK.unix:TY">unix</A><BR>
<B>type</B>&nbsp;<I>'sock_type</I>&nbsp;<A NAME="SIG:UNIX_SOCK.sock:TY:SPEC" HREF="#SIG:UNIX_SOCK.sock:TY">sock</A>&nbsp;=&nbsp;(unix,&nbsp;<I>'sock_type</I>)&nbsp;Socket.sock<BR>
<B>type</B>&nbsp;<I>'mode</I>&nbsp;<A NAME="SIG:UNIX_SOCK.stream_sock:TY:SPEC" HREF="#SIG:UNIX_SOCK.stream_sock:TY">stream_sock</A>&nbsp;=&nbsp;<I>'mode</I>&nbsp;Socket.stream&nbsp;sock<BR>
<B>type</B>&nbsp;<A NAME="SIG:UNIX_SOCK.dgram_sock:TY:SPEC" HREF="#SIG:UNIX_SOCK.dgram_sock:TY">dgram_sock</A>&nbsp;=&nbsp;Socket.dgram&nbsp;sock<BR>
<B>type</B>&nbsp;<A NAME="SIG:UNIX_SOCK.sock_addr:TY:SPEC" HREF="#SIG:UNIX_SOCK.sock_addr:TY">sock_addr</A>&nbsp;=&nbsp;unix&nbsp;Socket.sock_addr<BR>
<B>val</B>&nbsp;<A NAME="SIG:UNIX_SOCK.unixAF:VAL:SPEC" HREF="#SIG:UNIX_SOCK.unixAF:VAL">unixAF</A>&nbsp;<B>:</B>&nbsp;Socket.AF.addr_family<BR>
<B>val</B>&nbsp;<A NAME="SIG:UNIX_SOCK.toAddr:VAL:SPEC" HREF="#SIG:UNIX_SOCK.toAddr:VAL">toAddr</A>&nbsp;<B>:</B>&nbsp;string&nbsp;<B>-&gt;</B>&nbsp;sock_addr<BR>
<B>val</B>&nbsp;<A NAME="SIG:UNIX_SOCK.fromAddr:VAL:SPEC" HREF="#SIG:UNIX_SOCK.fromAddr:VAL">fromAddr</A>&nbsp;<B>:</B>&nbsp;sock_addr&nbsp;<B>-&gt;</B>&nbsp;string<BR>
<B>structure</B>&nbsp;Strm&nbsp;<B>:</B>&nbsp;<B>sig</B><BR>
&nbsp;&nbsp;&nbsp;&nbsp;<B>val</B>&nbsp;<A NAME="SIG:UNIX_SOCK.socket:VAL:SPEC" HREF="#SIG:UNIX_SOCK.socket:VAL">socket</A>&nbsp;<B>:</B>&nbsp;unit&nbsp;<B>-&gt;</B>&nbsp;<I>'mode</I>&nbsp;stream_sock<BR>
&nbsp;&nbsp;&nbsp;&nbsp;<B>val</B>&nbsp;<A NAME="SIG:UNIX_SOCK.socketPair:VAL:SPEC" HREF="#SIG:UNIX_SOCK.socketPair:VAL">socketPair</A>&nbsp;<B>:</B>&nbsp;unit<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>-&gt;</B>&nbsp;<I>'mode</I>&nbsp;stream_sock<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>*</B>&nbsp;<I>'mode</I>&nbsp;stream_sock<BR>
&nbsp;&nbsp;<B>end</B><BR>
<B>structure</B>&nbsp;DGrm&nbsp;<B>:</B>&nbsp;<B>sig</B><BR>
&nbsp;&nbsp;&nbsp;&nbsp;<B>val</B>&nbsp;<A NAME="SIG:UNIX_SOCK.socket:VAL:SPEC" HREF="#SIG:UNIX_SOCK.socket:VAL">socket</A>&nbsp;<B>:</B>&nbsp;unit&nbsp;<B>-&gt;</B>&nbsp;dgram_sock<BR>
&nbsp;&nbsp;&nbsp;&nbsp;<B>val</B>&nbsp;<A NAME="SIG:UNIX_SOCK.socketPair:VAL:SPEC" HREF="#SIG:UNIX_SOCK.socketPair:VAL">socketPair</A>&nbsp;<B>:</B>&nbsp;unit&nbsp;<B>-&gt;</B>&nbsp;dgram_sock&nbsp;<B>*</B>&nbsp;dgram_sock<BR>
&nbsp;&nbsp;<B>end</B></CODE>
</BLOCKQUOTE>
<H4>Description</H4>
<DL>
<DT> <A NAME="SIG:UNIX_SOCK.unix:TY"></A><CODE><B>type</B>&nbsp;unix</CODE>
<DD>
The witness type of the Unix address family. 
<BR>
<BR>

<DT> <A NAME="SIG:UNIX_SOCK.sock:TY"></A><CODE><B>type</B>&nbsp;<I>'sock_type</I>&nbsp;sock&nbsp;=&nbsp;(unix,&nbsp;<I>'sock_type</I>)&nbsp;Socket.sock</CODE>
<DD>
The type-scheme for all Unix-domain sockets. 
<BR>
<BR>

<DT> <A NAME="SIG:UNIX_SOCK.stream_sock:TY"></A><CODE><B>type</B>&nbsp;<I>'mode</I>&nbsp;stream_sock&nbsp;=&nbsp;<I>'mode</I>&nbsp;Socket.stream&nbsp;sock</CODE>
<DD>
The type-scheme of Unix-domain (passive or active) stream sockets. 
<BR>
<BR>

<DT> <A NAME="SIG:UNIX_SOCK.dgram_sock:TY"></A><CODE><B>type</B>&nbsp;dgram_sock&nbsp;=&nbsp;Socket.dgram&nbsp;sock</CODE>
<DD>
The type of Unix-domain datagram sockets. 
<BR>
<BR>

<DT> <A NAME="SIG:UNIX_SOCK.sock_addr:TY"></A><CODE><B>type</B>&nbsp;sock_addr&nbsp;=&nbsp;unix&nbsp;Socket.sock_addr</CODE>
<DD>
The type of a Unix-domain socket address. 
<BR>
<BR>

<DT> <A NAME="SIG:UNIX_SOCK.unixAF:VAL"></A><CODE><B>val</B>&nbsp;unixAF&nbsp;<B>:</B>&nbsp;Socket.AF.addr_family</CODE>
<DD>
The Unix address family value. 
<BR>
<BR>

<DT> <A NAME="SIG:UNIX_SOCK.toAddr:VAL"></A>
<DT> <CODE>toAddr <VAR>s</VAR> </CODE>
<DD>
converts a pathname <VAR>s</VAR> into a socket address (in the Unix address family); it does not check the validity of the path <VAR>s</VAR>. 
<BR>
<BR>

<DT> <A NAME="SIG:UNIX_SOCK.fromAddr:VAL"></A>
<DT> <CODE>fromAddr <VAR>addr</VAR> </CODE>
<DD>
returns the Unix file system path corresponding to the  Unix-domain socket address <VAR>addr</VAR>. 
<BR>
<BR>

<DT> <A NAME="SIG:UNIX_SOCK.Strm:STR"></A>
<DT> <CODE><B>structure</B>&nbsp;Strm</CODE>
<DD>
<BR>

<DL>
<DT> <A NAME="SIG:UNIX_SOCK.Strm.socket:VAL"></A><CODE><B>val</B>&nbsp;socket&nbsp;<B>:</B>&nbsp;unit&nbsp;<B>-&gt;</B>&nbsp;<I>'mode</I>&nbsp;stream_sock</CODE>
<DD>
 This function creates a stream socket in the Unix address family.  It raises <CODE><A HREF="os.html#SIG:OS.SysErr:EXN:SPEC">SysErr</A></CODE> if there are  too many sockets in use. 
<BR>
<BR>

<DT> <A NAME="SIG:UNIX_SOCK.Strm.socketPair:VAL"></A><CODE><B>val</B>&nbsp;socketPair&nbsp;<B>:</B>&nbsp;unit<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>-&gt;</B>&nbsp;<I>'mode</I>&nbsp;stream_sock&nbsp;<B>*</B>&nbsp;<I>'mode</I>&nbsp;stream_sock</CODE>
<DD>
 This function creates an unnamed pair of connected stream sockets in  the Unix address family.  It is similar to the <CODE><A HREF="posix-io.html#SIG:POSIX_IO.pipe:VAL:SPEC">Posix.IO.pipe</A></CODE>  function in that the returned sockets are connected, but unlike  <CODE><A HREF="posix-io.html#SIG:POSIX_IO.pipe:VAL:SPEC">pipe</A></CODE>, the sockets are bidirectional.  It raises <CODE><A HREF="os.html#SIG:OS.SysErr:EXN:SPEC">SysErr</A></CODE> if there are  too many sockets in use. 
<BR>
<BR>

</DL>
<DT> <A NAME="SIG:UNIX_SOCK.DGrm:STR"></A>
<DT> <CODE><B>structure</B>&nbsp;DGrm</CODE>
<DD>
<BR>

<DL>
<DT> <A NAME="SIG:UNIX_SOCK.DGrm.socket:VAL"></A><CODE><B>val</B>&nbsp;socket&nbsp;<B>:</B>&nbsp;unit&nbsp;<B>-&gt;</B>&nbsp;dgram_sock</CODE>
<DD>
This function creates a datagram socket in the Unix address family.  It raises <CODE><A HREF="os.html#SIG:OS.SysErr:EXN:SPEC">SysErr</A></CODE> if there are  too many sockets in use. 
<BR>
<BR>

<DT> <A NAME="SIG:UNIX_SOCK.DGrm.socketPair:VAL"></A><CODE><B>val</B>&nbsp;socketPair&nbsp;<B>:</B>&nbsp;unit&nbsp;<B>-&gt;</B>&nbsp;dgram_sock&nbsp;<B>*</B>&nbsp;dgram_sock</CODE>
<DD>
This function creates an unnamed pair of connected datagram sockets in the Unix address family.  It raises <CODE><A HREF="os.html#SIG:OS.SysErr:EXN:SPEC">SysErr</A></CODE> if there are  too many sockets in use. 
<BR>
<BR>

</DL>
</DL>
<H4>See Also</H4>
<BLOCKQUOTE>
<CODE><A HREF="generic-sock.html#GenericSock:STR:SPEC">GenericSock</A></CODE>, <CODE><A HREF="inet-sock.html#INetSock:STR:SPEC">INetSock</A></CODE>, <CODE><A HREF="socket.html#Socket:STR:SPEC">Socket</A></CODE>
</BLOCKQUOTE>


<HR>
<CENTER>
<B>[ <A HREF="#top">Top</A>
   | <A HREF="manpages.html">Parent</A>
   | <A HREF="toc.html">Contents</A>
   | <A HREF="index-all.html">Index</A>
   | <A HREF="index.html">Root</A>
   ]</B>
</CENTER>
<P>
<I>Generated April 12, 2004</I><BR>
<I>Last Modified June 5, 1998</I><BR>
<I>Comments to <A HREF="http://www.cs.uchicago.edu/people/jhr">John Reppy.</A></I><BR>

<HR>
<P>

This document may be distributed freely over the internet as long as the
copyright notice and license terms below are prominently displayed within
every machine-readable copy.  

<P>

<TABLE ALIGN=CENTER WIDTH="80%" BORDER="2" CELLPADDING="5">
<TR>
<TD>
<P>

Copyright &copy; 2004 AT&amp;T and Lucent Technologies.
All rights reserved.

<P>

Permission is granted for internet users to make one paper copy for their
own personal use.  Further hardcopy reproduction is strictly prohibited. 
Permission to distribute the HTML document electronically on any medium
other than the internet must be requested from the copyright holders by
contacting the editors.
Printed versions of the SML Basis Manual are available from Cambridge
University Press.
To order, please visit
<A HREF="http://www.cup.org">www.cup.org</A> (North America) or
<A HREF="http://www.cup.cam.ac.uk">www.cup.cam.ac.uk</A> (outside North America).<BR>

</TABLE>
<P>

<HR>
</BODY></HTML>