Safe Haskell	None
Language	Haskell2010

Network.Tox.C.Options

Synopsis

data Options = Options {
- ipv6Enabled :: Bool
- udpEnabled :: Bool
- proxyType :: ProxyType
- proxyHost :: String
- proxyPort :: Word16
- startPort :: Word16
- endPort :: Word16
- tcpPort :: Word16
- savedataType :: SavedataType
- savedataData :: ByteString
}
defaultOptions :: Options
logLevelName :: LogLevel -> Char
logHandler :: LogCb
data ErrOptionsNew = ErrOptionsNewMalloc
tox_options_new :: CErr ErrOptionsNew -> IO OptionsPtr
toxOptionsNew :: IO (Either ErrOptionsNew OptionsPtr)
toxOptionsFree :: OptionsPtr -> IO ()
withToxOptions :: (OptionsPtr -> IO r) -> IO (Either ErrOptionsNew r)
peekToxOptions :: OptionsPtr -> IO Options
withOptions :: Options -> (OptionsPtr -> IO r) -> IO (Either ErrOptionsNew r)

Documentation

data Options Source #

Constructors

Options
Fields ipv6Enabled :: Bool udpEnabled :: Bool proxyType :: ProxyType proxyHost :: String proxyPort :: Word16 startPort :: Word16 endPort :: Word16 tcpPort :: Word16 savedataType :: SavedataType savedataData :: ByteString

Instances

Instances details

Eq Options Source #
Instance details Defined in Network.Tox.C.Options Methods (==) :: Options -> Options -> Bool # (/=) :: Options -> Options -> Bool #
Read Options Source #
Instance details Defined in Network.Tox.C.Options Methods readsPrec :: Int -> ReadS Options # readList :: ReadS [Options] # readPrec :: ReadPrec Options # readListPrec :: ReadPrec [Options] #
Show Options Source #
Instance details Defined in Network.Tox.C.Options Methods showsPrec :: Int -> Options -> ShowS # show :: Options -> String # showList :: [Options] -> ShowS #
Generic Options Source #
Instance details Defined in Network.Tox.C.Options Associated Types type Rep Options :: Type -> Type # Methods from :: Options -> Rep Options x # to :: Rep Options x -> Options #
type Rep Options Source #
Instance details Defined in Network.Tox.C.Options type Rep Options = D1 ('MetaData "Options" "Network.Tox.C.Options" "toxcore-c-0.2.12-inplace" 'False) (C1 ('MetaCons "Options" 'PrefixI 'True) (((S1 ('MetaSel ('Just "ipv6Enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "udpEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "proxyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ProxyType) :: (S1 ('MetaSel ('Just "proxyHost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 String) :: S1 ('MetaSel ('Just "proxyPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word16)))) :: ((S1 ('MetaSel ('Just "startPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word16) :: S1 ('MetaSel ('Just "endPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word16)) :: (S1 ('MetaSel ('Just "tcpPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word16) :: (S1 ('MetaSel ('Just "savedataType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SavedataType) :*: S1 ('MetaSel ('Just "savedataData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString))))))

defaultOptions :: Options Source #

logLevelName :: LogLevel -> Char Source #

logHandler :: LogCb Source #

data ErrOptionsNew Source #

Constructors

ErrOptionsNewMalloc

Instances

Instances details

Bounded ErrOptionsNew Source #
Instance details Defined in Network.Tox.C.Options Methods minBound :: ErrOptionsNew # maxBound :: ErrOptionsNew #
Enum ErrOptionsNew Source #
Instance details Defined in Network.Tox.C.Options Methods succ :: ErrOptionsNew -> ErrOptionsNew # pred :: ErrOptionsNew -> ErrOptionsNew # toEnum :: Int -> ErrOptionsNew # fromEnum :: ErrOptionsNew -> Int # enumFrom :: ErrOptionsNew -> [ErrOptionsNew] # enumFromThen :: ErrOptionsNew -> ErrOptionsNew -> [ErrOptionsNew] # enumFromTo :: ErrOptionsNew -> ErrOptionsNew -> [ErrOptionsNew] # enumFromThenTo :: ErrOptionsNew -> ErrOptionsNew -> ErrOptionsNew -> [ErrOptionsNew] #
Eq ErrOptionsNew Source #
Instance details Defined in Network.Tox.C.Options Methods (==) :: ErrOptionsNew -> ErrOptionsNew -> Bool # (/=) :: ErrOptionsNew -> ErrOptionsNew -> Bool #
Ord ErrOptionsNew Source #
Instance details Defined in Network.Tox.C.Options Methods compare :: ErrOptionsNew -> ErrOptionsNew -> Ordering # (<) :: ErrOptionsNew -> ErrOptionsNew -> Bool # (<=) :: ErrOptionsNew -> ErrOptionsNew -> Bool # (>) :: ErrOptionsNew -> ErrOptionsNew -> Bool # (>=) :: ErrOptionsNew -> ErrOptionsNew -> Bool # max :: ErrOptionsNew -> ErrOptionsNew -> ErrOptionsNew # min :: ErrOptionsNew -> ErrOptionsNew -> ErrOptionsNew #
Read ErrOptionsNew Source #
Instance details Defined in Network.Tox.C.Options Methods readsPrec :: Int -> ReadS ErrOptionsNew # readList :: ReadS [ErrOptionsNew] # readPrec :: ReadPrec ErrOptionsNew # readListPrec :: ReadPrec [ErrOptionsNew] #
Show ErrOptionsNew Source #
Instance details Defined in Network.Tox.C.Options Methods showsPrec :: Int -> ErrOptionsNew -> ShowS # show :: ErrOptionsNew -> String # showList :: [ErrOptionsNew] -> ShowS #

tox_options_new :: CErr ErrOptionsNew -> IO OptionsPtr Source #

Allocates a new Tox_Options object and initialises it with the default options. This function can be used to preserve long term ABI compatibility by giving the responsibility of allocation and deallocation to the Tox library.

Objects returned from this function must be freed using the tox_options_free function.

@return A new OptionsPtr with default options or nullPtr on failure.

toxOptionsNew :: IO (Either ErrOptionsNew OptionsPtr) Source #

toxOptionsFree :: OptionsPtr -> IO () Source #

Releases all resources associated with an options objects.

Passing a pointer that was not returned by tox_options_new results in undefined behaviour.

withToxOptions :: (OptionsPtr -> IO r) -> IO (Either ErrOptionsNew r) Source #

peekToxOptions :: OptionsPtr -> IO Options Source #

Read Options from an OptionsPtr.

If the passed pointer is nullPtr, the behaviour is undefined.

withOptions :: Options -> (OptionsPtr -> IO r) -> IO (Either ErrOptionsNew r) Source #

Allocate a new C options pointer, fills in the values from Options, calls the processor function, and deallocates the options pointer.

The OptionsPtr passed to the processor function is never nullPtr. If allocation fails, the IO action evaluates to Left with an appropriate error code.