gi-gio-2.0.11: Gio bindings

CopyrightWill Thompson, Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.Gio.Objects.InetAddress

Contents

Description

InetAddress represents an IPv4 or IPv6 internet address. Use resolverLookupByName or resolverLookupByNameAsync to look up the InetAddress for a hostname. Use resolverLookupByAddress or resolverLookupByAddressAsync to look up the hostname for a InetAddress.

To actually connect to a remote host, you will need a InetSocketAddress (which includes a InetAddress as well as a port number).

Synopsis

Exported types

Methods

equal

inetAddressEqual Source #

Arguments

:: (HasCallStack, MonadIO m, IsInetAddress a, IsInetAddress b) 
=> a

address: A InetAddress.

-> b

otherAddress: Another InetAddress.

-> m Bool

Returns: True if address and otherAddress are equal, False otherwise.

Checks if two InetAddress instances are equal, e.g. the same address.

Since: 2.30

getFamily

inetAddressGetFamily Source #

Arguments

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

address: a InetAddress

-> m SocketFamily

Returns: address's family

Gets address's family

Since: 2.22

getIsAny

inetAddressGetIsAny Source #

Arguments

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

address: a InetAddress

-> m Bool

Returns: True if address is the "any" address for its family.

Tests whether address is the "any" address for its family.

Since: 2.22

getIsLinkLocal

inetAddressGetIsLinkLocal Source #

Arguments

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

address: a InetAddress

-> m Bool

Returns: True if address is a link-local address.

Tests whether address is a link-local address (that is, if it identifies a host on a local network that is not connected to the Internet).

Since: 2.22

getIsLoopback

inetAddressGetIsLoopback Source #

Arguments

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

address: a InetAddress

-> m Bool

Returns: True if address is the loopback address for its family.

Tests whether address is the loopback address for its family.

Since: 2.22

getIsMcGlobal

inetAddressGetIsMcGlobal Source #

Arguments

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

address: a InetAddress

-> m Bool

Returns: True if address is a global multicast address.

Tests whether address is a global multicast address.

Since: 2.22

getIsMcLinkLocal

inetAddressGetIsMcLinkLocal Source #

Arguments

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

address: a InetAddress

-> m Bool

Returns: True if address is a link-local multicast address.

Tests whether address is a link-local multicast address.

Since: 2.22

getIsMcNodeLocal

inetAddressGetIsMcNodeLocal Source #

Arguments

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

address: a InetAddress

-> m Bool

Returns: True if address is a node-local multicast address.

Tests whether address is a node-local multicast address.

Since: 2.22

getIsMcOrgLocal

inetAddressGetIsMcOrgLocal Source #

Arguments

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

address: a InetAddress

-> m Bool

Returns: True if address is an organization-local multicast address.

Tests whether address is an organization-local multicast address.

Since: 2.22

getIsMcSiteLocal

inetAddressGetIsMcSiteLocal Source #

Arguments

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

address: a InetAddress

-> m Bool

Returns: True if address is a site-local multicast address.

Tests whether address is a site-local multicast address.

Since: 2.22

getIsMulticast

inetAddressGetIsMulticast Source #

Arguments

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

address: a InetAddress

-> m Bool

Returns: True if address is a multicast address.

Tests whether address is a multicast address.

Since: 2.22

getIsSiteLocal

inetAddressGetIsSiteLocal Source #

Arguments

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

address: a InetAddress

-> m Bool

Returns: True if address is a site-local address.

Tests whether address is a site-local address such as 10.0.0.1 (that is, the address identifies a host on a local network that can not be reached directly from the Internet, but which may have outgoing Internet connectivity via a NAT or firewall).

Since: 2.22

getNativeSize

inetAddressGetNativeSize Source #

Arguments

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

address: a InetAddress

-> m Word64

Returns: the number of bytes used for the native version of address.

Gets the size of the native raw binary address for address. This is the size of the data that you get from g_inet_address_to_bytes().

Since: 2.22

newAny

inetAddressNewAny Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> SocketFamily

family: the address family

-> m InetAddress

Returns: a new InetAddress corresponding to the "any" address for family. Free the returned object with objectUnref.

Creates a InetAddress for the "any" address (unassigned/"don't care") for family.

Since: 2.22

newFromBytes

inetAddressNewFromBytes Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Ptr Word8

bytes: raw address data

-> SocketFamily

family: the address family of bytes

-> m InetAddress

Returns: a new InetAddress corresponding to family and bytes. Free the returned object with objectUnref.

Creates a new InetAddress from the given family and bytes. bytes should be 4 bytes for SocketFamilyIpv4 and 16 bytes for SocketFamilyIpv6.

Since: 2.22

newFromString

inetAddressNewFromString Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Text

string: a string representation of an IP address

-> m InetAddress

Returns: a new InetAddress corresponding to string, or Nothing if string could not be parsed. Free the returned object with objectUnref.

Parses string as an IP address and creates a new InetAddress.

Since: 2.22

newLoopback

inetAddressNewLoopback Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> SocketFamily

family: the address family

-> m InetAddress

Returns: a new InetAddress corresponding to the loopback address for family. Free the returned object with objectUnref.

Creates a InetAddress for the loopback address for family.

Since: 2.22

toString

inetAddressToString Source #

Arguments

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

address: a InetAddress

-> m Text

Returns: a representation of address as a string, which should be freed after use.

Converts address to string form.

Since: 2.22

Properties

bytes

data InetAddressBytesPropertyInfo Source #

Instances

AttrInfo InetAddressBytesPropertyInfo Source # 
type AttrOrigin InetAddressBytesPropertyInfo Source # 
type AttrLabel InetAddressBytesPropertyInfo Source # 
type AttrGetType InetAddressBytesPropertyInfo Source # 
type AttrBaseTypeConstraint InetAddressBytesPropertyInfo Source # 
type AttrSetTypeConstraint InetAddressBytesPropertyInfo Source # 
type AttrAllowedOps InetAddressBytesPropertyInfo Source # 

family

data InetAddressFamilyPropertyInfo Source #

Instances

AttrInfo InetAddressFamilyPropertyInfo Source # 
type AttrOrigin InetAddressFamilyPropertyInfo Source # 
type AttrLabel InetAddressFamilyPropertyInfo Source # 
type AttrGetType InetAddressFamilyPropertyInfo Source # 
type AttrBaseTypeConstraint InetAddressFamilyPropertyInfo Source # 
type AttrSetTypeConstraint InetAddressFamilyPropertyInfo Source # 
type AttrAllowedOps InetAddressFamilyPropertyInfo Source # 

isAny

data InetAddressIsAnyPropertyInfo Source #

Instances

AttrInfo InetAddressIsAnyPropertyInfo Source # 
type AttrOrigin InetAddressIsAnyPropertyInfo Source # 
type AttrLabel InetAddressIsAnyPropertyInfo Source # 
type AttrGetType InetAddressIsAnyPropertyInfo Source # 
type AttrBaseTypeConstraint InetAddressIsAnyPropertyInfo Source # 
type AttrSetTypeConstraint InetAddressIsAnyPropertyInfo Source # 
type AttrAllowedOps InetAddressIsAnyPropertyInfo Source # 

isLinkLocal

data InetAddressIsLinkLocalPropertyInfo Source #

Instances

AttrInfo InetAddressIsLinkLocalPropertyInfo Source # 
type AttrOrigin InetAddressIsLinkLocalPropertyInfo Source # 
type AttrLabel InetAddressIsLinkLocalPropertyInfo Source # 
type AttrGetType InetAddressIsLinkLocalPropertyInfo Source # 
type AttrBaseTypeConstraint InetAddressIsLinkLocalPropertyInfo Source # 
type AttrSetTypeConstraint InetAddressIsLinkLocalPropertyInfo Source # 
type AttrAllowedOps InetAddressIsLinkLocalPropertyInfo Source # 

isLoopback

data InetAddressIsLoopbackPropertyInfo Source #

Instances

AttrInfo InetAddressIsLoopbackPropertyInfo Source # 
type AttrOrigin InetAddressIsLoopbackPropertyInfo Source # 
type AttrLabel InetAddressIsLoopbackPropertyInfo Source # 
type AttrGetType InetAddressIsLoopbackPropertyInfo Source # 
type AttrBaseTypeConstraint InetAddressIsLoopbackPropertyInfo Source # 
type AttrSetTypeConstraint InetAddressIsLoopbackPropertyInfo Source # 
type AttrAllowedOps InetAddressIsLoopbackPropertyInfo Source # 

isMcGlobal

data InetAddressIsMcGlobalPropertyInfo Source #

Instances

AttrInfo InetAddressIsMcGlobalPropertyInfo Source # 
type AttrOrigin InetAddressIsMcGlobalPropertyInfo Source # 
type AttrLabel InetAddressIsMcGlobalPropertyInfo Source # 
type AttrGetType InetAddressIsMcGlobalPropertyInfo Source # 
type AttrBaseTypeConstraint InetAddressIsMcGlobalPropertyInfo Source # 
type AttrSetTypeConstraint InetAddressIsMcGlobalPropertyInfo Source # 
type AttrAllowedOps InetAddressIsMcGlobalPropertyInfo Source # 

isMcLinkLocal

data InetAddressIsMcLinkLocalPropertyInfo Source #

Instances

AttrInfo InetAddressIsMcLinkLocalPropertyInfo Source # 
type AttrOrigin InetAddressIsMcLinkLocalPropertyInfo Source # 
type AttrLabel InetAddressIsMcLinkLocalPropertyInfo Source # 
type AttrGetType InetAddressIsMcLinkLocalPropertyInfo Source # 
type AttrBaseTypeConstraint InetAddressIsMcLinkLocalPropertyInfo Source # 
type AttrSetTypeConstraint InetAddressIsMcLinkLocalPropertyInfo Source # 
type AttrAllowedOps InetAddressIsMcLinkLocalPropertyInfo Source # 

isMcNodeLocal

data InetAddressIsMcNodeLocalPropertyInfo Source #

Instances

AttrInfo InetAddressIsMcNodeLocalPropertyInfo Source # 
type AttrOrigin InetAddressIsMcNodeLocalPropertyInfo Source # 
type AttrLabel InetAddressIsMcNodeLocalPropertyInfo Source # 
type AttrGetType InetAddressIsMcNodeLocalPropertyInfo Source # 
type AttrBaseTypeConstraint InetAddressIsMcNodeLocalPropertyInfo Source # 
type AttrSetTypeConstraint InetAddressIsMcNodeLocalPropertyInfo Source # 
type AttrAllowedOps InetAddressIsMcNodeLocalPropertyInfo Source # 

isMcOrgLocal

data InetAddressIsMcOrgLocalPropertyInfo Source #

Instances

AttrInfo InetAddressIsMcOrgLocalPropertyInfo Source # 
type AttrOrigin InetAddressIsMcOrgLocalPropertyInfo Source # 
type AttrLabel InetAddressIsMcOrgLocalPropertyInfo Source # 
type AttrGetType InetAddressIsMcOrgLocalPropertyInfo Source # 
type AttrBaseTypeConstraint InetAddressIsMcOrgLocalPropertyInfo Source # 
type AttrSetTypeConstraint InetAddressIsMcOrgLocalPropertyInfo Source # 
type AttrAllowedOps InetAddressIsMcOrgLocalPropertyInfo Source # 

isMcSiteLocal

data InetAddressIsMcSiteLocalPropertyInfo Source #

Instances

AttrInfo InetAddressIsMcSiteLocalPropertyInfo Source # 
type AttrOrigin InetAddressIsMcSiteLocalPropertyInfo Source # 
type AttrLabel InetAddressIsMcSiteLocalPropertyInfo Source # 
type AttrGetType InetAddressIsMcSiteLocalPropertyInfo Source # 
type AttrBaseTypeConstraint InetAddressIsMcSiteLocalPropertyInfo Source # 
type AttrSetTypeConstraint InetAddressIsMcSiteLocalPropertyInfo Source # 
type AttrAllowedOps InetAddressIsMcSiteLocalPropertyInfo Source # 

isMulticast

data InetAddressIsMulticastPropertyInfo Source #

Instances

AttrInfo InetAddressIsMulticastPropertyInfo Source # 
type AttrOrigin InetAddressIsMulticastPropertyInfo Source # 
type AttrLabel InetAddressIsMulticastPropertyInfo Source # 
type AttrGetType InetAddressIsMulticastPropertyInfo Source # 
type AttrBaseTypeConstraint InetAddressIsMulticastPropertyInfo Source # 
type AttrSetTypeConstraint InetAddressIsMulticastPropertyInfo Source # 
type AttrAllowedOps InetAddressIsMulticastPropertyInfo Source # 

isSiteLocal

data InetAddressIsSiteLocalPropertyInfo Source #

Instances

AttrInfo InetAddressIsSiteLocalPropertyInfo Source # 
type AttrOrigin InetAddressIsSiteLocalPropertyInfo Source # 
type AttrLabel InetAddressIsSiteLocalPropertyInfo Source # 
type AttrGetType InetAddressIsSiteLocalPropertyInfo Source # 
type AttrBaseTypeConstraint InetAddressIsSiteLocalPropertyInfo Source # 
type AttrSetTypeConstraint InetAddressIsSiteLocalPropertyInfo Source # 
type AttrAllowedOps InetAddressIsSiteLocalPropertyInfo Source #