hs-GeoIP-0.3: Haskell bindings to the MaxMind GeoIPCity database via the C library

Safe HaskellNone

Data.Geolocation.GeoIP

Contents

Synopsis

Types

data GeoDB Source

Type representing an established connection to a GeoIPCity database

data GeoIPOption Source

combineOptions :: [GeoIPOption] -> GeoIPOptionSource

Collapse & combine multiple GeoIPOptions into one

standard :: GeoIPOptionSource

memory_cache :: GeoIPOptionSource

check_cache :: GeoIPOptionSource

index_cache :: GeoIPOptionSource

mmap_cache :: GeoIPOptionSource

Geolocation Result Type

data GeoIPRecord Source

Return data for a geolocation lookup

Constructors

GeoIPRecord 

Fields

geoCountryCode :: !ByteString
 
geoCountryCode3 :: !ByteString
 
geoCountryName :: !ByteString
 
geoRegion :: !ByteString
 
geoCity :: !ByteString
 
geoPostalCode :: !ByteString
 
geoLatitude :: !Double
 
geoLongitude :: !Double
 
geoAreaCode :: !Int
 
geoContinentCode :: !ByteString
 
geoAccuracyRadius :: !Int
 

Instances

Data Operations

openGeoDB :: GeoIPOption -> String -> IO GeoDBSource

Open the binary GeoIP data file with the given options.

This would open a file and cache in memory: 

 openGeoDB "GeoCity.dat" memory_cache

The memory on the C side is automatically freed by the Haskell GC when appropriate.

geoLocateByIPAddress :: GeoDB -> ByteString -> IO (Maybe GeoIPRecord)Source

Geo-locate by given IP Adress 

 geoLocateByIPAddress db "123.123.123.123"

geoLocateByIPNum :: GeoDB -> Integer -> IO (Maybe GeoIPRecord)Source

Geo-locate by given IP number. Call mkIpNum on a String ip address to convert to IP number. 

 geoLocateByIPNum db 12336939327338

geoStringByIPAddress :: GeoDB -> ByteString -> IO (Maybe ByteString)Source

geoStringByIPNum :: GeoDB -> Integer -> IO (Maybe ByteString)Source

mkIpNum :: ByteString -> Maybe IntegerSource

Convert a string IP adress to IPNum