gi-nm-1.0.1: NM bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.NM.Objects.IPConfig

Description

No description available in the introspection data.

Synopsis

Exported types

newtype IPConfig Source #

Memory-managed wrapper type.

Constructors

IPConfig (ManagedPtr IPConfig) 

Instances

Instances details
Eq IPConfig Source # 
Instance details

Defined in GI.NM.Objects.IPConfig

GObject IPConfig Source # 
Instance details

Defined in GI.NM.Objects.IPConfig

ManagedPtrNewtype IPConfig Source # 
Instance details

Defined in GI.NM.Objects.IPConfig

TypedObject IPConfig Source # 
Instance details

Defined in GI.NM.Objects.IPConfig

Methods

glibType :: IO GType #

HasParentTypes IPConfig Source # 
Instance details

Defined in GI.NM.Objects.IPConfig

IsGValue (Maybe IPConfig) Source #

Convert IPConfig to and from GValue. See toGValue and fromGValue.

Instance details

Defined in GI.NM.Objects.IPConfig

type ParentTypes IPConfig Source # 
Instance details

Defined in GI.NM.Objects.IPConfig

class (GObject o, IsDescendantOf IPConfig o) => IsIPConfig o Source #

Type class for types which can be safely cast to IPConfig, for instance with toIPConfig.

Instances

Instances details
(GObject o, IsDescendantOf IPConfig o) => IsIPConfig o Source # 
Instance details

Defined in GI.NM.Objects.IPConfig

toIPConfig :: (MonadIO m, IsIPConfig o) => o -> m IPConfig Source #

Cast to IPConfig, for types for which this is known to be safe. For general casts, use castTo.

Methods

getAddresses

iPConfigGetAddresses Source #

Arguments

:: (HasCallStack, MonadIO m, IsIPConfig a) 
=> a

config: a IPConfig

-> m [IPAddress]

Returns: the PtrArray containing IPAddresses. This is the internal copy used by the configuration and must not be modified. The library never modifies the returned array and thus it is safe for callers to reference and keep using it.

Gets the IP addresses (containing the address, prefix, and gateway).

getDomains

iPConfigGetDomains Source #

Arguments

:: (HasCallStack, MonadIO m, IsIPConfig a) 
=> a

config: a IPConfig

-> m [Text]

Returns: the array of domains. (This is never Nothing, though it may be 0-length).

Gets the domain names.

getFamily

iPConfigGetFamily Source #

Arguments

:: (HasCallStack, MonadIO m, IsIPConfig a) 
=> a

config: a IPConfig

-> m Int32

Returns: the IP address family; either <literal>AF_INET</literal> or <literal>AF_INET6</literal>

Gets the IP address family

getGateway

iPConfigGetGateway Source #

Arguments

:: (HasCallStack, MonadIO m, IsIPConfig a) 
=> a

config: a IPConfig

-> m Text

Returns: the IP address of the gateway.

Gets the IP gateway address.

getNameservers

iPConfigGetNameservers Source #

Arguments

:: (HasCallStack, MonadIO m, IsIPConfig a) 
=> a

config: a IPConfig

-> m [Text]

Returns: the array of nameserver IP addresses

Gets the domain name servers (DNS).

getRoutes

iPConfigGetRoutes Source #

Arguments

:: (HasCallStack, MonadIO m, IsIPConfig a) 
=> a

config: a IPConfig

-> m [IPRoute]

Returns: the PtrArray containing IPRoutes. This is the internal copy used by the configuration, and must not be modified. The library never modifies the returned array and thus it is safe for callers to reference and keep using it.

Gets the routes.

getSearches

iPConfigGetSearches Source #

Arguments

:: (HasCallStack, MonadIO m, IsIPConfig a) 
=> a

config: a IPConfig

-> m [Text]

Returns: the array of DNS search strings. (This is never Nothing, though it may be 0-length).

Gets the DNS searches.

getWinsServers

iPConfigGetWinsServers Source #

Arguments

:: (HasCallStack, MonadIO m, IsIPConfig a) 
=> a

config: a IPConfig

-> m [Text]

Returns: the arry of WINS server IP address strings. (This is never Nothing, though it may be 0-length.)

Gets the Windows Internet Name Service servers (WINS).

Properties

addresses

domains

The array containing domain strings of the configuration.

getIPConfigDomains :: (MonadIO m, IsIPConfig o) => o -> m [Text] Source #

Get the value of the “domains” property. When overloading is enabled, this is equivalent to

get iPConfig #domains

family

The IP address family of the configuration; either <literal>AF_INET</literal> or <literal>AF_INET6</literal>.

getIPConfigFamily :: (MonadIO m, IsIPConfig o) => o -> m Int32 Source #

Get the value of the “family” property. When overloading is enabled, this is equivalent to

get iPConfig #family

gateway

The IP gateway address of the configuration as string.

getIPConfigGateway :: (MonadIO m, IsIPConfig o) => o -> m Text Source #

Get the value of the “gateway” property. When overloading is enabled, this is equivalent to

get iPConfig #gateway

nameservers

The array containing name server IP addresses of the configuration.

getIPConfigNameservers :: (MonadIO m, IsIPConfig o) => o -> m [Text] Source #

Get the value of the “nameservers” property. When overloading is enabled, this is equivalent to

get iPConfig #nameservers

routes

searches

The array containing DNS search strings of the configuration.

getIPConfigSearches :: (MonadIO m, IsIPConfig o) => o -> m [Text] Source #

Get the value of the “searches” property. When overloading is enabled, this is equivalent to

get iPConfig #searches

winsServers

The array containing WINS server IP addresses of the configuration. (This will always be empty for IPv6 configurations.)

getIPConfigWinsServers :: (MonadIO m, IsIPConfig o) => o -> m [Text] Source #

Get the value of the “wins-servers” property. When overloading is enabled, this is equivalent to

get iPConfig #winsServers