-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Domain Name Service (DNS) lookup via the <windns.h>/dnsapi.dll standard library
--   
--   This package implements an API for accessing the <a>Domain Name
--   Service (DNS)</a> resolver service via the standard
--   <a>&lt;windns.h&gt;/dnsapi.dll</a> system library on Win32 systems.
--   
--   This package provides the high-level API-subset of the <a>resolv</a>
--   package.
@package windns
@version 0.1.0.0


-- | This module implements an API for accessing the <a>Domain Name Service
--   (DNS)</a> resolver service via the standard
--   <a>&lt;windns.h&gt;/dnsapi.dll</a> system library on Win32 systems.
module Network.DNS

-- | Query <tt>A</tt> record (see <a>RFC 1035, section 3.4.1</a>).
--   
--   This query returns only exact matches (modulo <tt>foldCaseName</tt>).
--   E.g. in case of <tt>CNAME</tt> responses even if the answer section
--   would contain <tt>A</tt> records for the hostnames pointed to by the
--   <tt>CNAME</tt>.
--   
--   <pre>
--   &gt;&gt;&gt; queryA (Name "www.google.com")
--   [(TTL 72,IPv4 0xd83acde4)]
--   </pre>
queryA :: Name -> IO [(TTL, IPv4)]

-- | Query <tt>AAAA</tt> records (see <a>RFC 3596</a>).
--   
--   This query returns only exact matches (modulo <tt>foldCaseName</tt>).
--   E.g. in case of <tt>CNAME</tt> responses even if the answer section
--   would contain <tt>A</tt> records for the hostnames pointed to by the
--   <tt>CNAME</tt>.
--   
--   <pre>
--   &gt;&gt;&gt; queryAAAA (Name "www.google.com")
--   [(TTL 299,IPv6 0x2a0014504001081e 0x2004)]
--   </pre>
queryAAAA :: Name -> IO [(TTL, IPv6)]

-- | Query <tt>CNAME</tt> records (see <a>RFC 1035, section 3.3.1</a>).
--   
--   <pre>
--   &gt;&gt;&gt; queryCNAME (Name "hackage.haskell.org")
--   [(TTL 299,Name "j.global-ssl.fastly.net.")]
--   </pre>
queryCNAME :: Name -> IO [(TTL, Name)]

-- | Query <tt>SRV</tt> records (see <a>RFC 2782</a>).
--   
--   <pre>
--   &gt;&gt;&gt; querySRV (Name "_imap._tcp.gmail.com")
--   [(TTL 21599,SRV {srvPriority = 0, srvWeight = 0, srvPort = 0, srvTarget = Name "."})]
--   </pre>
querySRV :: Name -> IO [(TTL, SRV Name)]

-- | Query <tt>TXT</tt> records (see <a>RFC 1035, section 3.3.14</a>).
--   
--   <pre>
--   &gt;&gt;&gt; queryTXT (Name "_mirrors.hackage.haskell.org")
--   [(TTL 299,["0.urlbase=http://hackage.fpcomplete.com/",
--              "1.urlbase=http://objects-us-west-1.dream.io/hackage-mirror/"])]
--   </pre>
queryTXT :: Name -> IO [(TTL, [CharStr])]

-- | <tt>&lt;domain-name&gt;</tt> as per <a>RFC 1035, section 3.3</a>.
--   
--   A domain-name represented as a series of labels separated by dots.
newtype Name
Name :: ByteString -> Name

-- | <tt>&lt;character-string&gt;</tt> as per <a>RFC 1035, section 3.3</a>.
--   
--   A sequence of up to 255 octets
--   
--   The limit of 255 octets is caused by the encoding which uses by a
--   prefixed octet denoting the length.
newtype CharStr
CharStr :: ByteString -> CharStr

-- | An IPv4 address
--   
--   The IP address is represented in network order, i.e.
--   <tt>127.0.0.1</tt> is represented as <tt>(IPv4 0x7f000001)</tt>.
data IPv4
IPv4 :: !Word32 -> IPv4

-- | An IPv6 address
--   
--   The IP address is represented in network order, i.e.
--   <tt>2606:2800:220:1:248:1893:25c8:1946</tt> is represented as
--   <tt>(IPv6 0x2606280002200001 0x248189325c81946)</tt>.
data IPv6
IPv6 :: !Word64 -> !Word64 -> IPv6

-- | Cache time-to-live expressed in seconds
newtype TTL
TTL :: Int32 -> TTL

-- | <tt>SRV</tt> Record data as per <a>RFC 2782</a>
data SRV l
SRV :: !Word16 -> !Word16 -> !Word16 -> !l -> SRV l
[srvPriority] :: SRV l -> !Word16
[srvWeight] :: SRV l -> !Word16
[srvPort] :: SRV l -> !Word16
[srvTarget] :: SRV l -> !l