:right-sidebar: True

NetworkAddress
===================================================================

.. currentmodule:: gi.repository.Gio





.. class:: NetworkAddress(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.GObject.Object`



Implemented Interfaces: :class:`~gi.repository.Gio.SocketConnectable`



``GNetworkAddress`` provides an easy way to resolve a hostname and
then attempt to connect to that host, handling the possibility of
multiple IP addresses and multiple address families.

The enumeration results of resolved addresses *may* be cached as long
as this object is kept alive which may have unexpected results if
alive for too long.

See :obj:`~gi.repository.Gio.SocketConnectable` for an example of using the connectable
interface.


Constructors
------------

.. rst-class:: interim-class

.. class:: NetworkAddress
   :no-index:


   .. classmethod:: new(hostname: str, port: int) -> ~gi.repository.Gio.NetworkAddress

      Creates a new :obj:`~gi.repository.Gio.SocketConnectable` for connecting to the given
      ``hostname`` and ``port``\.

      Note that depending on the configuration of the machine, a
      ``hostname`` of ``localhost`` may refer to the IPv4 loopback address
      only, or to both IPv4 and IPv6; use
      :func:`~gi.repository.Gio.NetworkAddress.new_loopback` to create a :obj:`~gi.repository.Gio.NetworkAddress` that
      is guaranteed to resolve to both addresses.


      .. versionadded:: 2.22





      :param hostname: the hostname

      :param port: the port




   .. classmethod:: new_loopback(port: int) -> ~gi.repository.Gio.NetworkAddress

      Creates a new :obj:`~gi.repository.Gio.SocketConnectable` for connecting to the local host
      over a loopback connection to the given ``port``\. This is intended for
      use in connecting to local services which may be running on IPv4 or
      IPv6.

      The connectable will return IPv4 and IPv6 loopback addresses,
      regardless of how the host resolves ``localhost``\. By contrast,
      :func:`~gi.repository.Gio.NetworkAddress.new` will often only return an IPv4 address when
      resolving ``localhost``\, and an IPv6 address for ``localhost6``\.

      :func:`~gi.repository.Gio.NetworkAddress.get_hostname` will always return ``localhost`` for
      a :obj:`~gi.repository.Gio.NetworkAddress` created with this constructor.


      .. versionadded:: 2.44





      :param port: the port








Methods
-------

.. rst-class:: interim-class

.. class:: NetworkAddress
   :no-index:


   .. method:: get_hostname() -> str

      Gets ``addr``\'s hostname. This might be either UTF-8 or ASCII-encoded,
      depending on what ``addr`` was created with.


      .. versionadded:: 2.22








   .. method:: get_port() -> int

      Gets ``addr``\'s port number


      .. versionadded:: 2.22








   .. method:: get_scheme() -> str | None

      Gets ``addr``\'s scheme


      .. versionadded:: 2.26








   .. classmethod:: parse(default_port: int) -> ~gi.repository.Gio.NetworkAddress

      Creates a new :obj:`~gi.repository.Gio.SocketConnectable` for connecting to the given
      ``hostname`` and ``port``\. May fail and return :const:`None` in case
      parsing ``host_and_port`` fails.

      ``host_and_port`` may be in any of a number of recognised formats; an IPv6
      address, an IPv4 address, or a domain name (in which case a DNS
      lookup is performed). Quoting with [] is supported for all address
      types. A port override may be specified in the usual way with a
      colon.

      If no port is specified in ``host_and_port`` then ``default_port`` will be
      used as the port number to connect to.

      In general, ``host_and_port`` is expected to be provided by the user
      (allowing them to give the hostname, and a port override if necessary)
      and ``default_port`` is expected to be provided by the application.

      (The port component of ``host_and_port`` can also be specified as a
      service name rather than as a numeric port, but this functionality
      is deprecated, because it depends on the contents of /etc/services,
      which is generally quite sparse on platforms other than Linux.)


      .. versionadded:: 2.22





      :param default_port: the default port if not in ``host_and_port``




   .. classmethod:: parse_uri(default_port: int) -> ~gi.repository.Gio.NetworkAddress

      Creates a new :obj:`~gi.repository.Gio.SocketConnectable` for connecting to the given
      ``uri``\. May fail and return :const:`None` in case parsing ``uri`` fails.

      Using this rather than :func:`~gi.repository.Gio.NetworkAddress.new` or
      :func:`~gi.repository.Gio.NetworkAddress.parse` allows :obj:`~gi.repository.Gio.SocketClient` to determine
      when to use application-specific proxy protocols.


      .. versionadded:: 2.26





      :param default_port: The default port if none is found in the URI








Properties
----------

.. rst-class:: interim-class

.. class:: NetworkAddress
   :no-index:
   

   .. attribute:: props.hostname
      :type: str

      The type of the None singleton.



      .. versionadded:: 2.22





   .. attribute:: props.port
      :type: int

      The type of the None singleton.



      .. versionadded:: 2.22





   .. attribute:: props.scheme
      :type: str

      The type of the None singleton.



      .. versionadded:: 2.22













Fields
------

.. rst-class:: interim-class

.. class:: NetworkAddress
   :no-index:
   

   .. attribute:: parent_instance

      






   .. attribute:: priv