{-# LANGUAGE TypeApplications #-}


-- | Copyright  : Will Thompson, Iñaki García Etxebarria and Jonas Platte
-- License    : LGPL-2.1
-- Maintainer : Iñaki García Etxebarria
-- 
-- SRV (service) records are used by some network protocols to provide
-- service-specific aliasing and load-balancing. For example, XMPP
-- (Jabber) uses SRV records to locate the XMPP server for a domain;
-- rather than connecting directly to \"example.com\" or assuming a
-- specific server hostname like \"xmpp.example.com\", an XMPP client
-- would look up the \"xmpp-client\" SRV record for \"example.com\", and
-- then connect to whatever host was pointed to by that record.
-- 
-- You can use 'GI.Gio.Objects.Resolver.resolverLookupService' or
-- 'GI.Gio.Objects.Resolver.resolverLookupServiceAsync' to find the @/GSrvTargets/@
-- for a given service. However, if you are simply planning to connect
-- to the remote service, you can use t'GI.Gio.Objects.NetworkService.NetworkService'\'s
-- t'GI.Gio.Interfaces.SocketConnectable.SocketConnectable' interface and not need to worry about
-- t'GI.Gio.Structs.SrvTarget.SrvTarget' at all.

#if (MIN_VERSION_haskell_gi_overloading(1,0,0) && !defined(__HADDOCK_VERSION__))
#define ENABLE_OVERLOADING
#endif

module GI.Gio.Structs.SrvTarget
    (

-- * Exported types
    SrvTarget(..)                           ,
    noSrvTarget                             ,


 -- * Methods
-- ** Overloaded methods #method:Overloaded methods#

#if defined(ENABLE_OVERLOADING)
    ResolveSrvTargetMethod                  ,
#endif


-- ** copy #method:copy#

#if defined(ENABLE_OVERLOADING)
    SrvTargetCopyMethodInfo                 ,
#endif
    srvTargetCopy                           ,


-- ** free #method:free#

#if defined(ENABLE_OVERLOADING)
    SrvTargetFreeMethodInfo                 ,
#endif
    srvTargetFree                           ,


-- ** getHostname #method:getHostname#

#if defined(ENABLE_OVERLOADING)
    SrvTargetGetHostnameMethodInfo          ,
#endif
    srvTargetGetHostname                    ,


-- ** getPort #method:getPort#

#if defined(ENABLE_OVERLOADING)
    SrvTargetGetPortMethodInfo              ,
#endif
    srvTargetGetPort                        ,


-- ** getPriority #method:getPriority#

#if defined(ENABLE_OVERLOADING)
    SrvTargetGetPriorityMethodInfo          ,
#endif
    srvTargetGetPriority                    ,


-- ** getWeight #method:getWeight#

#if defined(ENABLE_OVERLOADING)
    SrvTargetGetWeightMethodInfo            ,
#endif
    srvTargetGetWeight                      ,


-- ** new #method:new#

    srvTargetNew                            ,




    ) where

import Data.GI.Base.ShortPrelude
import qualified Data.GI.Base.ShortPrelude as SP
import qualified Data.GI.Base.Overloading as O
import qualified Prelude as P

import qualified Data.GI.Base.Attributes as GI.Attributes
import qualified Data.GI.Base.ManagedPtr as B.ManagedPtr
import qualified Data.GI.Base.GClosure as B.GClosure
import qualified Data.GI.Base.GError as B.GError
import qualified Data.GI.Base.GVariant as B.GVariant
import qualified Data.GI.Base.GValue as B.GValue
import qualified Data.GI.Base.GParamSpec as B.GParamSpec
import qualified Data.GI.Base.CallStack as B.CallStack
import qualified Data.GI.Base.Properties as B.Properties
import qualified Data.GI.Base.Signals as B.Signals
import qualified Data.Text as T
import qualified Data.ByteString.Char8 as B
import qualified Data.Map as Map
import qualified Foreign.Ptr as FP
import qualified GHC.OverloadedLabels as OL


-- | Memory-managed wrapper type.
newtype SrvTarget = SrvTarget (ManagedPtr SrvTarget)
    deriving (Eq)
foreign import ccall "g_srv_target_get_type" c_g_srv_target_get_type ::
    IO GType

instance BoxedObject SrvTarget where
    boxedType _ = c_g_srv_target_get_type

-- | Convert 'SrvTarget' to and from 'Data.GI.Base.GValue.GValue' with 'Data.GI.Base.GValue.toGValue' and 'Data.GI.Base.GValue.fromGValue'.
instance B.GValue.IsGValue SrvTarget where
    toGValue o = do
        gtype <- c_g_srv_target_get_type
        B.ManagedPtr.withManagedPtr o (B.GValue.buildGValue gtype B.GValue.set_boxed)

    fromGValue gv = do
        ptr <- B.GValue.get_boxed gv :: IO (Ptr SrvTarget)
        B.ManagedPtr.newBoxed SrvTarget ptr



-- | A convenience alias for `Nothing` :: `Maybe` `SrvTarget`.
noSrvTarget :: Maybe SrvTarget
noSrvTarget = Nothing


#if defined(ENABLE_OVERLOADING)
instance O.HasAttributeList SrvTarget
type instance O.AttributeList SrvTarget = SrvTargetAttributeList
type SrvTargetAttributeList = ('[ ] :: [(Symbol, *)])
#endif

-- method SrvTarget::new
-- method type : Constructor
-- Args: [ Arg
--           { argCName = "hostname"
--           , argType = TBasicType TUTF8
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "the host that the service is running on"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       , Arg
--           { argCName = "port"
--           , argType = TBasicType TUInt16
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "the port that the service is running on"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       , Arg
--           { argCName = "priority"
--           , argType = TBasicType TUInt16
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "the target's priority"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       , Arg
--           { argCName = "weight"
--           , argType = TBasicType TUInt16
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "the target's weight"
--                 , sinceVersion = Nothing
--                 }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Just (TInterface Name { namespace = "Gio" , name = "SrvTarget" })
-- throws : False
-- Skip return : False

foreign import ccall "g_srv_target_new" g_srv_target_new ::
    CString ->                              -- hostname : TBasicType TUTF8
    Word16 ->                               -- port : TBasicType TUInt16
    Word16 ->                               -- priority : TBasicType TUInt16
    Word16 ->                               -- weight : TBasicType TUInt16
    IO (Ptr SrvTarget)

-- | Creates a new t'GI.Gio.Structs.SrvTarget.SrvTarget' with the given parameters.
-- 
-- You should not need to use this; normally @/GSrvTargets/@ are
-- created by t'GI.Gio.Objects.Resolver.Resolver'.
-- 
-- /Since: 2.22/
srvTargetNew ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    T.Text
    -- ^ /@hostname@/: the host that the service is running on
    -> Word16
    -- ^ /@port@/: the port that the service is running on
    -> Word16
    -- ^ /@priority@/: the target\'s priority
    -> Word16
    -- ^ /@weight@/: the target\'s weight
    -> m SrvTarget
    -- ^ __Returns:__ a new t'GI.Gio.Structs.SrvTarget.SrvTarget'.
srvTargetNew hostname port priority weight = liftIO $ do
    hostname' <- textToCString hostname
    result <- g_srv_target_new hostname' port priority weight
    checkUnexpectedReturnNULL "srvTargetNew" result
    result' <- (wrapBoxed SrvTarget) result
    freeMem hostname'
    return result'

#if defined(ENABLE_OVERLOADING)
#endif

-- method SrvTarget::copy
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "target"
--           , argType =
--               TInterface Name { namespace = "Gio" , name = "SrvTarget" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "a #GSrvTarget" , sinceVersion = Nothing }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Just (TInterface Name { namespace = "Gio" , name = "SrvTarget" })
-- throws : False
-- Skip return : False

foreign import ccall "g_srv_target_copy" g_srv_target_copy ::
    Ptr SrvTarget ->                        -- target : TInterface (Name {namespace = "Gio", name = "SrvTarget"})
    IO (Ptr SrvTarget)

-- | Copies /@target@/
-- 
-- /Since: 2.22/
srvTargetCopy ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    SrvTarget
    -- ^ /@target@/: a t'GI.Gio.Structs.SrvTarget.SrvTarget'
    -> m SrvTarget
    -- ^ __Returns:__ a copy of /@target@/
srvTargetCopy target = liftIO $ do
    target' <- unsafeManagedPtrGetPtr target
    result <- g_srv_target_copy target'
    checkUnexpectedReturnNULL "srvTargetCopy" result
    result' <- (wrapBoxed SrvTarget) result
    touchManagedPtr target
    return result'

#if defined(ENABLE_OVERLOADING)
data SrvTargetCopyMethodInfo
instance (signature ~ (m SrvTarget), MonadIO m) => O.MethodInfo SrvTargetCopyMethodInfo SrvTarget signature where
    overloadedMethod = srvTargetCopy

#endif

-- method SrvTarget::free
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "target"
--           , argType =
--               TInterface Name { namespace = "Gio" , name = "SrvTarget" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "a #GSrvTarget" , sinceVersion = Nothing }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Nothing
-- throws : False
-- Skip return : False

foreign import ccall "g_srv_target_free" g_srv_target_free ::
    Ptr SrvTarget ->                        -- target : TInterface (Name {namespace = "Gio", name = "SrvTarget"})
    IO ()

-- | Frees /@target@/
-- 
-- /Since: 2.22/
srvTargetFree ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    SrvTarget
    -- ^ /@target@/: a t'GI.Gio.Structs.SrvTarget.SrvTarget'
    -> m ()
srvTargetFree target = liftIO $ do
    target' <- unsafeManagedPtrGetPtr target
    g_srv_target_free target'
    touchManagedPtr target
    return ()

#if defined(ENABLE_OVERLOADING)
data SrvTargetFreeMethodInfo
instance (signature ~ (m ()), MonadIO m) => O.MethodInfo SrvTargetFreeMethodInfo SrvTarget signature where
    overloadedMethod = srvTargetFree

#endif

-- method SrvTarget::get_hostname
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "target"
--           , argType =
--               TInterface Name { namespace = "Gio" , name = "SrvTarget" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "a #GSrvTarget" , sinceVersion = Nothing }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Just (TBasicType TUTF8)
-- throws : False
-- Skip return : False

foreign import ccall "g_srv_target_get_hostname" g_srv_target_get_hostname ::
    Ptr SrvTarget ->                        -- target : TInterface (Name {namespace = "Gio", name = "SrvTarget"})
    IO CString

-- | Gets /@target@/\'s hostname (in ASCII form; if you are going to present
-- this to the user, you should use 'GI.GLib.Functions.hostnameIsAsciiEncoded' to
-- check if it contains encoded Unicode segments, and use
-- 'GI.GLib.Functions.hostnameToUnicode' to convert it if it does.)
-- 
-- /Since: 2.22/
srvTargetGetHostname ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    SrvTarget
    -- ^ /@target@/: a t'GI.Gio.Structs.SrvTarget.SrvTarget'
    -> m T.Text
    -- ^ __Returns:__ /@target@/\'s hostname
srvTargetGetHostname target = liftIO $ do
    target' <- unsafeManagedPtrGetPtr target
    result <- g_srv_target_get_hostname target'
    checkUnexpectedReturnNULL "srvTargetGetHostname" result
    result' <- cstringToText result
    touchManagedPtr target
    return result'

#if defined(ENABLE_OVERLOADING)
data SrvTargetGetHostnameMethodInfo
instance (signature ~ (m T.Text), MonadIO m) => O.MethodInfo SrvTargetGetHostnameMethodInfo SrvTarget signature where
    overloadedMethod = srvTargetGetHostname

#endif

-- method SrvTarget::get_port
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "target"
--           , argType =
--               TInterface Name { namespace = "Gio" , name = "SrvTarget" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "a #GSrvTarget" , sinceVersion = Nothing }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Just (TBasicType TUInt16)
-- throws : False
-- Skip return : False

foreign import ccall "g_srv_target_get_port" g_srv_target_get_port ::
    Ptr SrvTarget ->                        -- target : TInterface (Name {namespace = "Gio", name = "SrvTarget"})
    IO Word16

-- | Gets /@target@/\'s port
-- 
-- /Since: 2.22/
srvTargetGetPort ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    SrvTarget
    -- ^ /@target@/: a t'GI.Gio.Structs.SrvTarget.SrvTarget'
    -> m Word16
    -- ^ __Returns:__ /@target@/\'s port
srvTargetGetPort target = liftIO $ do
    target' <- unsafeManagedPtrGetPtr target
    result <- g_srv_target_get_port target'
    touchManagedPtr target
    return result

#if defined(ENABLE_OVERLOADING)
data SrvTargetGetPortMethodInfo
instance (signature ~ (m Word16), MonadIO m) => O.MethodInfo SrvTargetGetPortMethodInfo SrvTarget signature where
    overloadedMethod = srvTargetGetPort

#endif

-- method SrvTarget::get_priority
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "target"
--           , argType =
--               TInterface Name { namespace = "Gio" , name = "SrvTarget" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "a #GSrvTarget" , sinceVersion = Nothing }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Just (TBasicType TUInt16)
-- throws : False
-- Skip return : False

foreign import ccall "g_srv_target_get_priority" g_srv_target_get_priority ::
    Ptr SrvTarget ->                        -- target : TInterface (Name {namespace = "Gio", name = "SrvTarget"})
    IO Word16

-- | Gets /@target@/\'s priority. You should not need to look at this;
-- t'GI.Gio.Objects.Resolver.Resolver' already sorts the targets according to the algorithm in
-- RFC 2782.
-- 
-- /Since: 2.22/
srvTargetGetPriority ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    SrvTarget
    -- ^ /@target@/: a t'GI.Gio.Structs.SrvTarget.SrvTarget'
    -> m Word16
    -- ^ __Returns:__ /@target@/\'s priority
srvTargetGetPriority target = liftIO $ do
    target' <- unsafeManagedPtrGetPtr target
    result <- g_srv_target_get_priority target'
    touchManagedPtr target
    return result

#if defined(ENABLE_OVERLOADING)
data SrvTargetGetPriorityMethodInfo
instance (signature ~ (m Word16), MonadIO m) => O.MethodInfo SrvTargetGetPriorityMethodInfo SrvTarget signature where
    overloadedMethod = srvTargetGetPriority

#endif

-- method SrvTarget::get_weight
-- method type : OrdinaryMethod
-- Args: [ Arg
--           { argCName = "target"
--           , argType =
--               TInterface Name { namespace = "Gio" , name = "SrvTarget" }
--           , direction = DirectionIn
--           , mayBeNull = False
--           , argDoc =
--               Documentation
--                 { rawDocText = Just "a #GSrvTarget" , sinceVersion = Nothing }
--           , argScope = ScopeTypeInvalid
--           , argClosure = -1
--           , argDestroy = -1
--           , argCallerAllocates = False
--           , transfer = TransferNothing
--           }
--       ]
-- Lengths: []
-- returnType: Just (TBasicType TUInt16)
-- throws : False
-- Skip return : False

foreign import ccall "g_srv_target_get_weight" g_srv_target_get_weight ::
    Ptr SrvTarget ->                        -- target : TInterface (Name {namespace = "Gio", name = "SrvTarget"})
    IO Word16

-- | Gets /@target@/\'s weight. You should not need to look at this;
-- t'GI.Gio.Objects.Resolver.Resolver' already sorts the targets according to the algorithm in
-- RFC 2782.
-- 
-- /Since: 2.22/
srvTargetGetWeight ::
    (B.CallStack.HasCallStack, MonadIO m) =>
    SrvTarget
    -- ^ /@target@/: a t'GI.Gio.Structs.SrvTarget.SrvTarget'
    -> m Word16
    -- ^ __Returns:__ /@target@/\'s weight
srvTargetGetWeight target = liftIO $ do
    target' <- unsafeManagedPtrGetPtr target
    result <- g_srv_target_get_weight target'
    touchManagedPtr target
    return result

#if defined(ENABLE_OVERLOADING)
data SrvTargetGetWeightMethodInfo
instance (signature ~ (m Word16), MonadIO m) => O.MethodInfo SrvTargetGetWeightMethodInfo SrvTarget signature where
    overloadedMethod = srvTargetGetWeight

#endif

#if defined(ENABLE_OVERLOADING)
type family ResolveSrvTargetMethod (t :: Symbol) (o :: *) :: * where
    ResolveSrvTargetMethod "copy" o = SrvTargetCopyMethodInfo
    ResolveSrvTargetMethod "free" o = SrvTargetFreeMethodInfo
    ResolveSrvTargetMethod "getHostname" o = SrvTargetGetHostnameMethodInfo
    ResolveSrvTargetMethod "getPort" o = SrvTargetGetPortMethodInfo
    ResolveSrvTargetMethod "getPriority" o = SrvTargetGetPriorityMethodInfo
    ResolveSrvTargetMethod "getWeight" o = SrvTargetGetWeightMethodInfo
    ResolveSrvTargetMethod l o = O.MethodResolutionFailed l o

instance (info ~ ResolveSrvTargetMethod t SrvTarget, O.MethodInfo info SrvTarget p) => OL.IsLabel t (SrvTarget -> p) where
#if MIN_VERSION_base(4,10,0)
    fromLabel = O.overloadedMethod @info
#else
    fromLabel _ = O.overloadedMethod @info
#endif

#endif