/usr/share/doc/libghc-streaming-commons-doc/html/src/Data-Streaming-Network-Internal.html is in libghc-streaming-commons-doc 0.1.17-1build3.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://code.haskell.org/~malcolm/hscolour/ -->
<title>Data/Streaming/Network/Internal.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE CPP #-}</span>
<a name="line-2"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Streaming</span><span class='hs-varop'>.</span><span class='hs-conid'>Network</span><span class='hs-varop'>.</span><span class='hs-conid'>Internal</span>
<a name="line-3"></a> <span class='hs-layout'>(</span> <span class='hs-conid'>ServerSettings</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-4"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>ClientSettings</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-5"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>HostPreference</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-6"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>Message</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-7"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>AppData</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-8"></a><span class='hs-cpp'>#if !WINDOWS</span>
<a name="line-9"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>ServerSettingsUnix</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-10"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>ClientSettingsUnix</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-11"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>AppDataUnix</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-12"></a><span class='hs-cpp'>#endif</span>
<a name="line-13"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-14"></a>
<a name="line-15"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>String</span> <span class='hs-layout'>(</span><span class='hs-conid'>IsString</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-16"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span> <span class='hs-layout'>(</span><span class='hs-conid'>ByteString</span><span class='hs-layout'>)</span>
<a name="line-17"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Network</span><span class='hs-varop'>.</span><span class='hs-conid'>Socket</span> <span class='hs-layout'>(</span><span class='hs-conid'>Socket</span><span class='hs-layout'>,</span> <span class='hs-conid'>SockAddr</span><span class='hs-layout'>,</span> <span class='hs-conid'>Family</span><span class='hs-layout'>)</span>
<a name="line-18"></a>
<a name="line-19"></a><a name="ServerSettings"></a><span class='hs-comment'>-- | Settings for a TCP server. It takes a port to listen on, and an optional</span>
<a name="line-20"></a><a name="ServerSettings"></a><span class='hs-comment'>-- hostname to bind to.</span>
<a name="line-21"></a><a name="ServerSettings"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>ServerSettings</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>ServerSettings</span>
<a name="line-22"></a> <span class='hs-layout'>{</span> <span class='hs-varid'>serverPort</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-conid'>Int</span>
<a name="line-23"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>serverHost</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-conid'>HostPreference</span>
<a name="line-24"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>serverSocket</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-conid'>Socket</span><span class='hs-layout'>)</span> <span class='hs-comment'>-- ^ listening socket</span>
<a name="line-25"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>serverAfterBind</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-layout'>(</span><span class='hs-conid'>Socket</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span>
<a name="line-26"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>serverNeedLocalAddr</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-conid'>Bool</span>
<a name="line-27"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>serverReadBufferSize</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-conid'>Int</span>
<a name="line-28"></a> <span class='hs-layout'>}</span>
<a name="line-29"></a>
<a name="line-30"></a><a name="ClientSettings"></a><span class='hs-comment'>-- | Settings for a TCP client, specifying how to connect to the server.</span>
<a name="line-31"></a><a name="ClientSettings"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>ClientSettings</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>ClientSettings</span>
<a name="line-32"></a> <span class='hs-layout'>{</span> <span class='hs-varid'>clientPort</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-conid'>Int</span>
<a name="line-33"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>clientHost</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-conid'>ByteString</span>
<a name="line-34"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>clientAddrFamily</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-conid'>Family</span>
<a name="line-35"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>clientReadBufferSize</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-conid'>Int</span>
<a name="line-36"></a> <span class='hs-layout'>}</span>
<a name="line-37"></a>
<a name="line-38"></a><a name="HostPreference"></a><span class='hs-comment'>-- | Which host to bind.</span>
<a name="line-39"></a><a name="HostPreference"></a><span class='hs-comment'>--</span>
<a name="line-40"></a><a name="HostPreference"></a><span class='hs-comment'>-- Note: The @IsString@ instance recognizes the following special values:</span>
<a name="line-41"></a><a name="HostPreference"></a><span class='hs-comment'>--</span>
<a name="line-42"></a><a name="HostPreference"></a><span class='hs-comment'>-- * @*@ means @HostAny@ - "any IPv4 or IPv6 hostname"</span>
<a name="line-43"></a><a name="HostPreference"></a><span class='hs-comment'>--</span>
<a name="line-44"></a><a name="HostPreference"></a><span class='hs-comment'>-- * @*4@ means @HostIPv4@ - "any IPv4 or IPv6 hostname, IPv4 preferred"</span>
<a name="line-45"></a><a name="HostPreference"></a><span class='hs-comment'>--</span>
<a name="line-46"></a><a name="HostPreference"></a><span class='hs-comment'>-- * @!4@ means @HostIPv4Only@ - "any IPv4 hostname"</span>
<a name="line-47"></a><a name="HostPreference"></a><span class='hs-comment'>--</span>
<a name="line-48"></a><a name="HostPreference"></a><span class='hs-comment'>-- * @*6@ means @HostIPv6@@ - "any IPv4 or IPv6 hostname, IPv6 preferred"</span>
<a name="line-49"></a><a name="HostPreference"></a><span class='hs-comment'>--</span>
<a name="line-50"></a><a name="HostPreference"></a><span class='hs-comment'>-- * @!6@ means @HostIPv6Only@ - "any IPv6 hostname"</span>
<a name="line-51"></a><a name="HostPreference"></a><span class='hs-comment'>--</span>
<a name="line-52"></a><a name="HostPreference"></a><span class='hs-comment'>-- Note that the permissive @*@ values allow binding to an IPv4 or an</span>
<a name="line-53"></a><a name="HostPreference"></a><span class='hs-comment'>-- IPv6 hostname, which means you might be able to successfully bind</span>
<a name="line-54"></a><a name="HostPreference"></a><span class='hs-comment'>-- to a port more times than you expect (eg once on the IPv4 localhost</span>
<a name="line-55"></a><a name="HostPreference"></a><span class='hs-comment'>-- 127.0.0.1 and again on the IPv6 localhost 0:0:0:0:0:0:0:1).</span>
<a name="line-56"></a><a name="HostPreference"></a><span class='hs-comment'>--</span>
<a name="line-57"></a><a name="HostPreference"></a><span class='hs-comment'>-- Any other value is treated as a hostname. As an example, to bind to the</span>
<a name="line-58"></a><a name="HostPreference"></a><span class='hs-comment'>-- IPv4 local host only, use \"127.0.0.1\".</span>
<a name="line-59"></a><a name="HostPreference"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>HostPreference</span> <span class='hs-keyglyph'>=</span>
<a name="line-60"></a> <span class='hs-conid'>HostAny</span>
<a name="line-61"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>HostIPv4</span>
<a name="line-62"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>HostIPv4Only</span>
<a name="line-63"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>HostIPv6</span>
<a name="line-64"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>HostIPv6Only</span>
<a name="line-65"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Host</span> <span class='hs-conid'>String</span>
<a name="line-66"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Eq</span><span class='hs-layout'>,</span> <span class='hs-conid'>Ord</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span><span class='hs-layout'>,</span> <span class='hs-conid'>Read</span><span class='hs-layout'>)</span>
<a name="line-67"></a>
<a name="line-68"></a><a name="instance%20IsString%20HostPreference"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>IsString</span> <span class='hs-conid'>HostPreference</span> <span class='hs-keyword'>where</span>
<a name="line-69"></a> <span class='hs-varid'>fromString</span> <span class='hs-str'>"*"</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>HostAny</span>
<a name="line-70"></a> <span class='hs-varid'>fromString</span> <span class='hs-str'>"*4"</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>HostIPv4</span>
<a name="line-71"></a> <span class='hs-varid'>fromString</span> <span class='hs-str'>"!4"</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>HostIPv4Only</span>
<a name="line-72"></a> <span class='hs-varid'>fromString</span> <span class='hs-str'>"*6"</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>HostIPv6</span>
<a name="line-73"></a> <span class='hs-varid'>fromString</span> <span class='hs-str'>"!6"</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>HostIPv6Only</span>
<a name="line-74"></a> <span class='hs-varid'>fromString</span> <span class='hs-varid'>s</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Host</span> <span class='hs-varid'>s</span>
<a name="line-75"></a>
<a name="line-76"></a><span class='hs-cpp'>#if !WINDOWS</span>
<a name="line-77"></a><a name="ServerSettingsUnix"></a><span class='hs-comment'>-- | Settings for a Unix domain sockets server.</span>
<a name="line-78"></a><a name="ServerSettingsUnix"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>ServerSettingsUnix</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>ServerSettingsUnix</span>
<a name="line-79"></a> <span class='hs-layout'>{</span> <span class='hs-varid'>serverPath</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-conid'>FilePath</span>
<a name="line-80"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>serverAfterBindUnix</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-layout'>(</span><span class='hs-conid'>Socket</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span>
<a name="line-81"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>serverReadBufferSizeUnix</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-conid'>Int</span>
<a name="line-82"></a> <span class='hs-layout'>}</span>
<a name="line-83"></a>
<a name="line-84"></a><a name="ClientSettingsUnix"></a><span class='hs-comment'>-- | Settings for a Unix domain sockets client.</span>
<a name="line-85"></a><a name="ClientSettingsUnix"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>ClientSettingsUnix</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>ClientSettingsUnix</span>
<a name="line-86"></a> <span class='hs-layout'>{</span> <span class='hs-varid'>clientPath</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-conid'>FilePath</span>
<a name="line-87"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>clientReadBufferSizeUnix</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-conid'>Int</span>
<a name="line-88"></a> <span class='hs-layout'>}</span>
<a name="line-89"></a>
<a name="line-90"></a><a name="AppDataUnix"></a><span class='hs-comment'>-- | The data passed to a Unix domain sockets @Application@.</span>
<a name="line-91"></a><a name="AppDataUnix"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>AppDataUnix</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>AppDataUnix</span>
<a name="line-92"></a> <span class='hs-layout'>{</span> <span class='hs-varid'>appReadUnix</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-conid'>ByteString</span><span class='hs-layout'>)</span>
<a name="line-93"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>appWriteUnix</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-layout'>(</span><span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span>
<a name="line-94"></a> <span class='hs-layout'>}</span>
<a name="line-95"></a><span class='hs-cpp'>#endif</span>
<a name="line-96"></a>
<a name="line-97"></a><a name="Message"></a><span class='hs-comment'>-- | Representation of a single UDP message</span>
<a name="line-98"></a><a name="Message"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Message</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Message</span> <span class='hs-layout'>{</span> <span class='hs-varid'>msgData</span> <span class='hs-keyglyph'>::</span> <span class='hs-comment'>{-# UNPACK #-}</span> <span class='hs-varop'>!</span><span class='hs-conid'>ByteString</span>
<a name="line-99"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>msgSender</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-conid'>SockAddr</span>
<a name="line-100"></a> <span class='hs-layout'>}</span>
<a name="line-101"></a>
<a name="line-102"></a><a name="AppData"></a><span class='hs-comment'>-- | The data passed to an @Application@.</span>
<a name="line-103"></a><a name="AppData"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>AppData</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>AppData</span>
<a name="line-104"></a> <span class='hs-layout'>{</span> <span class='hs-varid'>appRead'</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-conid'>ByteString</span><span class='hs-layout'>)</span>
<a name="line-105"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>appWrite'</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-layout'>(</span><span class='hs-conid'>ByteString</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span>
<a name="line-106"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>appSockAddr'</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-conid'>SockAddr</span>
<a name="line-107"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>appLocalAddr'</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-conid'>SockAddr</span><span class='hs-layout'>)</span>
<a name="line-108"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>appCloseConnection'</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>!</span><span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span>
<a name="line-109"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>appRawSocket'</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>Socket</span>
<a name="line-110"></a> <span class='hs-layout'>}</span>
</pre></body>
</html>
|