@ciao-lang/ts-ciao-interface

<!DOCTYPE HTML><html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><meta name="viewport" content="width=device-width, initial-scale=1"/><meta name="theme-color" content="#273f79"/><link rel="stylesheet" href="lpdoc.css" type="text/css"/><script type="text/javascript" src="lpdoc.js"></script><title>The socket interface — The Ciao System v1.22</title></head><body><div class="lpdoc-page fixleftbar"><a href="#" id="sidebar-toggle-button" class="lpdoc-navbutton">☰</a><div id="sidebar" class="lpdoc-sidebar"><div style="height: 40px; margin-left: auto; margin-right: auto"><img src="ciao-logo_autofig.png" width=auto height=100%></div><div class="lpdoc-nav"><a class="lpdoc-navbutton" href="ExtraLibs.html">↑</a><a class="lpdoc-navbutton" href="random_aggregates.html">←</a><a class="lpdoc-navbutton" href="sockets_io.html">→</a><a class="lpdoc-navbutton" href="ciaosearch.html">🔍</a><a href="ciaofulltoc.html">TOC</a></div><hr></hr><ul class="lpdoc-itemize-sectpath"><li><a href="ciao.html">The Ciao System</a> » </li><li><a href="ExtraLibs.html">PART VIII - Additional libraries</a> » </li><li><a href="">The socket interface</a></li></ul><hr></hr>ON THIS PAGE<ul><li><a href="#Usage and interface">Usage and interface</a></li><li><a href="#Documentation on exports">Documentation on exports</a></li><li><a href="#Documentation on imports">Documentation on imports</a></li></ul></div><div class="lpdoc-main"><div id=""><h1>The socket interface</h1><a class="lpdoc-idx-anchor" href="ciaosearch.html#sockets"></a> Author(s): <a class="lpdoc-idx-anchor" id="Manuel Carro" href="ciaosearch.html#Manuel Carro">Manuel Carro</a>, <a class="lpdoc-idx-anchor" id="Daniel Cabeza" href="ciaosearch.html#Daniel Cabeza">Daniel Cabeza</a>. This module defines primitives to open sockets, send, and receive data from them. This allows communicating with other processes, on the same machine or across the Internet. The reader should also consult standard bibliography on the topic for a proper use of these primitives. <div id="Usage and interface"><h2>Usage and interface</h2><div class="lpdoc-cartouche"><ul><li>Library usage: <tt>:- use_module(library(sockets)).</tt><li>Exports: <ul class="lpdoc-itemize-minus"><li>Predicates: <a class="lpdoc-idx-anchor" id="0" href="#connect_to_socket_type/4"><tt>connect_to_socket_type/4</tt></a>, <a class="lpdoc-idx-anchor" id="1" href="#connect_to_socket/3"><tt>connect_to_socket/3</tt></a>, <a class="lpdoc-idx-anchor" id="2" href="#bind_socket/3"><tt>bind_socket/3</tt></a>, <a class="lpdoc-idx-anchor" id="3" href="#socket_accept/2"><tt>socket_accept/2</tt></a>, <a class="lpdoc-idx-anchor" id="4" href="#select_socket/5"><tt>select_socket/5</tt></a>, <a class="lpdoc-idx-anchor" id="5" href="#socket_send/3"><tt>socket_send/3</tt></a>, <a class="lpdoc-idx-anchor" id="6" href="#socket_sendall/2"><tt>socket_sendall/2</tt></a>, <a class="lpdoc-idx-anchor" id="7" href="#socket_send_stream/2"><tt>socket_send_stream/2</tt></a>, <a class="lpdoc-idx-anchor" id="8" href="#socket_recv/3"><tt>socket_recv/3</tt></a>, <a class="lpdoc-idx-anchor" id="9" href="#socket_shutdown/2"><tt>socket_shutdown/2</tt></a>, <a class="lpdoc-idx-anchor" id="10" href="#hostname_address/2"><tt>hostname_address/2</tt></a>, <a class="lpdoc-idx-anchor" id="11" href="#socket_getpeername/2"><tt>socket_getpeername/2</tt></a>. <li>Regular Types: <a class="lpdoc-idx-anchor" id="12" href="#socket_type/1"><tt>socket_type/1</tt></a>, <a class="lpdoc-idx-anchor" id="13" href="#shutdown_type/1"><tt>shutdown_type/1</tt></a>. </ul></ul></div></div><div id="Documentation on exports"><h2>Documentation on exports</h2><div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="connect_to_socket_type/4" href="ciaosearch.html#connect_to_socket_type/4">connect_to_socket_type/4</a></div><div class="lpdoc-deftext">Usage:<tt>connect_to_socket_type(Hostname,Port,Type,Stream)</tt> Returns a Stream which connects to Hostname. The Type of connection can be defined. A Stream is returned, which can be used to <a class="lpdoc-idx-anchor" id="14" href="iso_incomplete.html#write/2"><tt>write/2</tt></a> to, to <a class="lpdoc-idx-anchor" id="15" href="iso_incomplete.html#read/2"><tt>read/2</tt></a>, to <a class="lpdoc-idx-anchor" id="16" href="#socket_send/3"><tt>socket_send/3</tt></a> to, or to <a class="lpdoc-idx-anchor" id="17" href="#socket_recv/3"><tt>socket_recv/3</tt></a> from the socket.<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="18" href="term_typing.html#atom/1"><tt>term_typing:atom/1</tt></a>)Hostname is currently instantiated to an atom. (<a class="lpdoc-idx-anchor" id="19" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Port is an integer. (<a class="lpdoc-idx-anchor" id="20" href="#socket_type/1"><tt>sockets:socket_type/1</tt></a>)Type is a valid socket type. (<a class="lpdoc-idx-anchor" id="21" href="stream_basic.html#stream/1"><tt>stream_basic:stream/1</tt></a>)Stream is an open stream. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="22" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)Hostname is currently a term which is not a free variable. (<a class="lpdoc-idx-anchor" id="23" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)Port is currently a term which is not a free variable. (<a class="lpdoc-idx-anchor" id="24" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)Type is currently a term which is not a free variable. (<a class="lpdoc-idx-anchor" id="25" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Stream is a free variable. <li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="27" href="foreign_interface_properties.html#foreign_low/2"><tt>foreign_interface_properties:foreign_low/2</tt></a>)The Prolog predicate <a class="lpdoc-idx-anchor" id="26" href="ciaosearch.html#PrologName"><tt>PrologName</tt></a> is implemented using the function <tt>ForeignName</tt>. The same considerations as above example are to be applied. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="connect_to_socket/3" href="ciaosearch.html#connect_to_socket/3">connect_to_socket/3</a></div><div class="lpdoc-deftext">Usage:<tt>connect_to_socket(Hostname,Port,Stream)</tt> Calls <a class="lpdoc-idx-anchor" id="28" href="#connect_to_socket_type/4"><tt>connect_to_socket_type/4</tt></a> with SOCK_STREAM connection type. This is the connection type you want in order to use the <a class="lpdoc-idx-anchor" id="29" href="iso_incomplete.html#write/2"><tt>write/2</tt></a> and <a class="lpdoc-idx-anchor" id="30" href="iso_incomplete.html#read/2"><tt>read/2</tt></a> predicates (and other stream IO related predicates).<ul class="lpdoc-itemize-minus"><li>Call and exit should be compatible with: (<a class="lpdoc-idx-anchor" id="31" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Hostname is an atom. (<a class="lpdoc-idx-anchor" id="32" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Port is an integer. (<a class="lpdoc-idx-anchor" id="33" href="stream_basic.html#stream/1"><tt>stream_basic:stream/1</tt></a>)Stream is an open stream. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="34" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)Hostname is currently a term which is not a free variable. (<a class="lpdoc-idx-anchor" id="35" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)Port is currently a term which is not a free variable. (<a class="lpdoc-idx-anchor" id="36" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Stream is a free variable. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="bind_socket/3" href="ciaosearch.html#bind_socket/3">bind_socket/3</a></div><div class="lpdoc-deftext">Usage:<tt>bind_socket(Port,Length,Socket)</tt> Returns an AF_INET Socket bound to Port (which may be assigned by the OS or defined by the caller), and listens to it (hence no listen call in this set of primitives). Length specifies the maximum number of pending connections.<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="37" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Port is an integer. (<a class="lpdoc-idx-anchor" id="38" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Length is an integer. (<a class="lpdoc-idx-anchor" id="39" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Socket is an integer. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="40" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)Length is currently a term which is not a free variable. (<a class="lpdoc-idx-anchor" id="41" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Socket is a free variable. <li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="43" href="foreign_interface_properties.html#foreign_low/2"><tt>foreign_interface_properties:foreign_low/2</tt></a>)The Prolog predicate <a class="lpdoc-idx-anchor" id="42" href="ciaosearch.html#PrologName"><tt>PrologName</tt></a> is implemented using the function <tt>ForeignName</tt>. The same considerations as above example are to be applied. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="socket_accept/2" href="ciaosearch.html#socket_accept/2">socket_accept/2</a></div><div class="lpdoc-deftext">Usage:<tt>socket_accept(Sock,Stream)</tt> Creates a new Stream connected to Sock.<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="44" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Sock is an integer. (<a class="lpdoc-idx-anchor" id="45" href="stream_basic.html#stream/1"><tt>stream_basic:stream/1</tt></a>)Stream is an open stream. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="46" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)Sock is currently a term which is not a free variable. (<a class="lpdoc-idx-anchor" id="47" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Stream is a free variable. <li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="49" href="foreign_interface_properties.html#foreign_low/2"><tt>foreign_interface_properties:foreign_low/2</tt></a>)The Prolog predicate <a class="lpdoc-idx-anchor" id="48" href="ciaosearch.html#PrologName"><tt>PrologName</tt></a> is implemented using the function <tt>ForeignName</tt>. The same considerations as above example are to be applied. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="select_socket/5" href="ciaosearch.html#select_socket/5">select_socket/5</a></div><div class="lpdoc-deftext">Usage:<tt>select_socket(Socket,NewStream,TO_ms,Streams,ReadStreams)</tt> Wait for data available in a list of Streams and in a Socket. Streams is a list of Prolog streams which will be tested for reading. Socket is a socket (i.e., an integer denoting the O.S. port number) or a <a class="lpdoc-idx-anchor" id="50" href="ciaosearch.html#free variable">free variable</a>. TO_ms is a number denoting a timeout. Within this timeout the Streams and the Socket are checked for the availability of data to be read. ReadStreams is the list of streams belonging to Streams which have data pending to be read. If Socket was a free variable, it is ignored, and NewStream is not checked. If Socket was instantiated to a port number and there are connections pending, a connection is accepted and connected with the Prolog stream in NewStream.<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="51" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Socket is an integer. (<a class="lpdoc-idx-anchor" id="52" href="stream_basic.html#stream/1"><tt>stream_basic:stream/1</tt></a>)NewStream is an open stream. (<a class="lpdoc-idx-anchor" id="53" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)TO_ms is an integer. (<a class="lpdoc-idx-anchor" id="54" href="basic_props.html#list/2"><tt>basic_props:list/2</tt></a>)Streams is a list of streams. (<a class="lpdoc-idx-anchor" id="55" href="basic_props.html#list/2"><tt>basic_props:list/2</tt></a>)ReadStreams is a list of streams. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="56" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)Socket is currently a term which is not a free variable. (<a class="lpdoc-idx-anchor" id="57" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)NewStream is a free variable. (<a class="lpdoc-idx-anchor" id="58" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)TO_ms is currently a term which is not a free variable. (<a class="lpdoc-idx-anchor" id="59" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)Streams is currently a term which is not a free variable. (<a class="lpdoc-idx-anchor" id="60" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)ReadStreams is a free variable. <li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="62" href="foreign_interface_properties.html#foreign_low/2"><tt>foreign_interface_properties:foreign_low/2</tt></a>)The Prolog predicate <a class="lpdoc-idx-anchor" id="61" href="ciaosearch.html#PrologName"><tt>PrologName</tt></a> is implemented using the function <tt>ForeignName</tt>. The same considerations as above example are to be applied. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="socket_send/3" href="ciaosearch.html#socket_send/3">socket_send/3</a></div><div class="lpdoc-deftext">Usage:<tt>socket_send(Stream,Bytes,Sent)</tt> Sends Bytes to the socket associated to Stream, return in Sent the number of sent bytes. The socket has to be in connected state.<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="63" href="stream_basic.html#stream/1"><tt>stream_basic:stream/1</tt></a>)Stream is an open stream. (<a class="lpdoc-idx-anchor" id="64" href="basic_props.html#bytelist/1"><tt>basic_props:bytelist/1</tt></a>)Bytes is list of bytes. (<a class="lpdoc-idx-anchor" id="65" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Sent is an integer. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="66" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)Stream is currently a term which is not a free variable. (<a class="lpdoc-idx-anchor" id="67" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)Bytes is currently a term which is not a free variable. <li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="69" href="foreign_interface_properties.html#foreign_low/2"><tt>foreign_interface_properties:foreign_low/2</tt></a>)The Prolog predicate <a class="lpdoc-idx-anchor" id="68" href="ciaosearch.html#PrologName"><tt>PrologName</tt></a> is implemented using the function <tt>ForeignName</tt>. The same considerations as above example are to be applied. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="socket_sendall/2" href="ciaosearch.html#socket_sendall/2">socket_sendall/2</a></div><div class="lpdoc-deftext">Usage:<tt>socket_sendall(Stream,Bytes)</tt> Sends all Bytes to the socket associated to Stream. The socket has to be in connected state.<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="70" href="stream_basic.html#stream/1"><tt>stream_basic:stream/1</tt></a>)Stream is an open stream. (<a class="lpdoc-idx-anchor" id="71" href="basic_props.html#bytelist/1"><tt>basic_props:bytelist/1</tt></a>)Bytes is list of bytes. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="72" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)Stream is currently a term which is not a free variable. (<a class="lpdoc-idx-anchor" id="73" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)Bytes is currently a term which is not a free variable. <li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="75" href="foreign_interface_properties.html#foreign_low/2"><tt>foreign_interface_properties:foreign_low/2</tt></a>)The Prolog predicate <a class="lpdoc-idx-anchor" id="74" href="ciaosearch.html#PrologName"><tt>PrologName</tt></a> is implemented using the function <tt>ForeignName</tt>. The same considerations as above example are to be applied. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="socket_send_stream/2" href="ciaosearch.html#socket_send_stream/2">socket_send_stream/2</a></div><div class="lpdoc-deftext">Usage:<tt>socket_send_stream(Stream,FromStream)</tt> Sends all bytes from stream FromStream to the socket associated to Stream. The socket has to be in connected state. FromStream cannot be a socket stream<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="76" href="stream_basic.html#stream/1"><tt>stream_basic:stream/1</tt></a>)Stream is an open stream. (<a class="lpdoc-idx-anchor" id="77" href="stream_basic.html#stream/1"><tt>stream_basic:stream/1</tt></a>)FromStream is an open stream. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="78" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)Stream is currently a term which is not a free variable. (<a class="lpdoc-idx-anchor" id="79" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)FromStream is currently a term which is not a free variable. <li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="81" href="foreign_interface_properties.html#foreign_low/2"><tt>foreign_interface_properties:foreign_low/2</tt></a>)The Prolog predicate <a class="lpdoc-idx-anchor" id="80" href="ciaosearch.html#PrologName"><tt>PrologName</tt></a> is implemented using the function <tt>ForeignName</tt>. The same considerations as above example are to be applied. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="socket_recv/3" href="ciaosearch.html#socket_recv/3">socket_recv/3</a></div><div class="lpdoc-deftext">Usage:<tt>socket_recv(Stream,Bytes,Length)</tt> Receives a byte list Bytes from the socket associated to Stream, and returns its Length. For TCP, Length is 0 if the peer has performed an orderly shutdown on the socket.<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="82" href="stream_basic.html#stream/1"><tt>stream_basic:stream/1</tt></a>)Stream is an open stream. (<a class="lpdoc-idx-anchor" id="83" href="basic_props.html#bytelist/1"><tt>basic_props:bytelist/1</tt></a>)Bytes is list of bytes. (<a class="lpdoc-idx-anchor" id="84" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Length is an integer. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="85" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)Stream is currently a term which is not a free variable. <li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="87" href="foreign_interface_properties.html#foreign_low/2"><tt>foreign_interface_properties:foreign_low/2</tt></a>)The Prolog predicate <a class="lpdoc-idx-anchor" id="86" href="ciaosearch.html#PrologName"><tt>PrologName</tt></a> is implemented using the function <tt>ForeignName</tt>. The same considerations as above example are to be applied. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="socket_shutdown/2" href="ciaosearch.html#socket_shutdown/2">socket_shutdown/2</a></div><div class="lpdoc-deftext">Usage:<tt>socket_shutdown(Stream,How)</tt> Shut down a duplex communication socket with which Stream is associated. All or part of the communication can be shutdown, depending on the value of How. The atoms <tt>read</tt>, <tt>write</tt>, or read_write should be used to denote the type of closing required.<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="88" href="stream_basic.html#stream/1"><tt>stream_basic:stream/1</tt></a>)Stream is an open stream. (<a class="lpdoc-idx-anchor" id="89" href="#shutdown_type/1"><tt>sockets:shutdown_type/1</tt></a>)How is a valid shutdown type. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="90" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)Stream is currently a term which is not a free variable. (<a class="lpdoc-idx-anchor" id="91" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)How is currently a term which is not a free variable. <li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="93" href="foreign_interface_properties.html#foreign_low/2"><tt>foreign_interface_properties:foreign_low/2</tt></a>)The Prolog predicate <a class="lpdoc-idx-anchor" id="92" href="ciaosearch.html#PrologName"><tt>PrologName</tt></a> is implemented using the function <tt>ForeignName</tt>. The same considerations as above example are to be applied. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="hostname_address/2" href="ciaosearch.html#hostname_address/2">hostname_address/2</a></div><div class="lpdoc-deftext">Usage:<tt>hostname_address(Hostname,Address)</tt> Address is unified with the atom representing the address (in AF_INET format) corresponding to Hostname.<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="94" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Hostname is an atom. (<a class="lpdoc-idx-anchor" id="95" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Address is an atom. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="96" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)Hostname is currently a term which is not a free variable. <li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="98" href="foreign_interface_properties.html#foreign_low/2"><tt>foreign_interface_properties:foreign_low/2</tt></a>)The Prolog predicate <a class="lpdoc-idx-anchor" id="97" href="ciaosearch.html#PrologName"><tt>PrologName</tt></a> is implemented using the function <tt>ForeignName</tt>. The same considerations as above example are to be applied. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="socket_getpeername/2" href="ciaosearch.html#socket_getpeername/2">socket_getpeername/2</a></div><div class="lpdoc-deftext">Usage:<tt>socket_getpeername(Stream,Address)</tt> Address is unified with the atom representing the address (in AF_INET or AF_INET6 format) of the peer connected to the socket associated to Stream.<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="99" href="stream_basic.html#stream/1"><tt>stream_basic:stream/1</tt></a>)Stream is an open stream. (<a class="lpdoc-idx-anchor" id="100" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Address is an atom. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="101" href="term_typing.html#nonvar/1"><tt>term_typing:nonvar/1</tt></a>)Stream is currently a term which is not a free variable. <li>The following properties hold globally: (<a class="lpdoc-idx-anchor" id="103" href="foreign_interface_properties.html#foreign_low/2"><tt>foreign_interface_properties:foreign_low/2</tt></a>)The Prolog predicate <a class="lpdoc-idx-anchor" id="102" href="ciaosearch.html#PrologName"><tt>PrologName</tt></a> is implemented using the function <tt>ForeignName</tt>. The same considerations as above example are to be applied. </ul></div></div> <div><div class="lpdoc-defname">REGTYPE<a class="lpdoc-idx-anchor" id="socket_type/1" href="ciaosearch.html#socket_type/1">socket_type/1</a></div><div class="lpdoc-deftext">Defines the atoms which can be used to specify the socket type recognized by <a class="lpdoc-idx-anchor" id="104" href="#connect_to_socket_type/4"><tt>connect_to_socket_type/4</tt></a>. Defined as follows: <pre class="lpdoc-codeblock">socket_type(stream). socket_type(dgram). socket_type(raw). socket_type(seqpacket). socket_type(rdm). </pre>Usage:<tt>socket_type(T)</tt> T is a valid socket type.<ul class="lpdoc-itemize-minus"></ul></div></div> <div><div class="lpdoc-defname">REGTYPE<a class="lpdoc-idx-anchor" id="shutdown_type/1" href="ciaosearch.html#shutdown_type/1">shutdown_type/1</a></div><div class="lpdoc-deftext">Usage:<tt>shutdown_type(T)</tt> T is a valid shutdown type.<ul class="lpdoc-itemize-minus"></ul></div></div> </div><div id="Documentation on imports"><h2>Documentation on imports</h2>This module has the following direct dependencies:<ul class="lpdoc-itemize-minus"><li>System library modules: <a class="lpdoc-idx-anchor" id="105" href="foreign_interface_properties.html"><tt>foreign_interface_properties</tt></a>. <li>Packages: <a class="lpdoc-idx-anchor" id="106" href="ciaosearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="107" href="ciaosearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="108" href="condcomp_doc.html"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="109" href="assertions_doc.html"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="110" href="ciaosearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>, <a class="lpdoc-idx-anchor" id="111" href="isomodes_doc.html"><tt>isomodes</tt></a>, <a class="lpdoc-idx-anchor" id="112" href="regtypes_doc.html"><tt>regtypes</tt></a>, <a class="lpdoc-idx-anchor" id="113" href="foreign_interface_doc.html"><tt>foreign_interface</tt></a>, <a class="lpdoc-idx-anchor" id="114" href="basicmodes_doc.html"><tt>basicmodes</tt></a>, <a class="lpdoc-idx-anchor" id="115" href="ciaosearch.html#engine(foreign_types)"><tt>engine(foreign_types)</tt></a>. </ul></div></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>