Client

---

Object Hierarchy:

Description:

Content:

Properties:

• public string @interface { get; construct; }
  The name of the network interface this client is associated with.
• public bool active { get; set; }
  Whether this client is active or not (passive).
• public InetAddress address { owned get; construct; }
  The network address this client is bound to.
• public SocketFamily address_family { get; construct; }
  The IP protocol address family this client works on.
• public bool allocate_tcp_socket { get; set construct; }
  The whether to allocate a TCP socket.
• public int boot_id { get; set construct; }
  The value of the BOOTID.
• public int config_id { get; set construct; }
  The value of the CONFIGID.
• public string host_ip { get; construct; }
  The IP address of the assoicated network interface.
• public InetAddressMask host_mask { owned get; construct; }
  The network mask of the assoicated network interface.
• public uint msearch_port { get; construct; }
  UDP port to use for sending multicast M-SEARCH requests on the network.
• public string network { get; construct; }
  The network this client is currently connected to.
• public uint port { get; construct; }
  UDP port to use for sending multicast M-SEARCH requests on the network.
• public string server_id { get; set; }
  The SSDP server's identifier.
• public uint socket_ttl { get; construct; }
  Time-to-live value to use for all sockets created by this client.
• public Socket tcp_socket { owned get; }
  The allocated TCP socket bound to the same port as [property@GSSDP.
• public UDAVersion uda_version { get; construct; }
  The UPnP version the client adheres to.

Creation methods:

• public Client (string? iface) throws Error
  Creates a GSSDP client on iface.
• public Client.for_address (InetAddress? addr, uint16 port, UDAVersion uda_version) throws Error
  Creates a GSSDP client with address addr.
• public Client.full (string? iface, InetAddress? addr, uint16 port, UDAVersion uda_version) throws Error
  Creates a GSSDP client with address addr.
• public Client.with_port (string? iface, uint16 msearch_port) throws Error
  Creates a GSSDP client on iface.

Methods:

• public void add_cache_entry (string ip_address, string user_agent)
  Add user_agent for ip_address.
• public void append_header (string name, string? value)
  Adds a header field to the messages sent by this this.
• public bool can_reach (InetSocketAddress address)
  Check if the peer at address is reachable using this this.
• public void clear_headers ()
  Removes all the headers for this this .
• public bool get_active ()
  Get the current state of the client.
• public InetAddress get_address ()
  The IP address this client works on.
• public InetAddressMask get_address_mask ()
• public SocketFamily get_family ()
• public unowned string get_host_ip ()
  Get the IP address we advertise ourselves as using.
• public uint get_index ()
• public unowned string get_interface ()
  Get the name of the network interface associated to this.
• public unowned string get_network ()
  Get the network identifier of the client.
• public uint get_port ()
• public unowned string get_server_id ()
• public Socket get_tcp_socket ()
  Get the associated TCP socket.
• public UDAVersion get_uda_version ()
• public unowned string guess_user_agent (string ip_address)
  Try to get a User-Agent for ip_address.
• public void remove_header (string name)
  Removes name from the list of headers.
• public void set_boot_id (int32 boot_id)
  Will set the new boot-id for this SSDP client.
• public void set_config_id (int32 config_id)
  The config-id is used to allow caching of the device or service description.
• public void set_network (string network)
  Sets the network identification of this to network.
• public void set_server_id (string server_id)
  Sets the server ID of this to server_id.

Inherited Members: