SocketClient

---

Object Hierarchy:

Description:

Content:

Properties:

• public bool enable_proxy { get; set construct; }
  Enable proxy support.
• public SocketFamily family { get; set construct; }
  The address family to use for socket construction.
• public SocketAddress local_address { get; set construct; }
  The local address constructed sockets will be bound to.
• public SocketProtocol protocol { get; set construct; }
  The protocol to use for socket construction, or `0` for default.
• public ProxyResolver proxy_resolver { get; set construct; }
  The proxy resolver to use
• public uint timeout { get; set construct; }
  The I/O timeout for sockets, in seconds, or `0` for none.
• public bool tls { get; set construct; }
  Whether to create TLS connections.
• public TlsCertificateFlags tls_validation_flags { get; set construct; }
  The TLS validation flags used when creating TLS connections.
• public SocketType type { get; set construct; }
  The type to use for socket construction.

Creation methods:

• public SocketClient ()
  Creates a new SocketClient with the default options.

Methods:

• public void add_application_proxy (string protocol)
  Enable proxy protocols to be handled by the application.
• public SocketConnection connect (SocketConnectable connectable, Cancellable? cancellable = null) throws Error
  Tries to resolve the connectable and make a network connection to it.
• public async SocketConnection connect_async (SocketConnectable connectable, Cancellable? cancellable = null) throws Error
  This is the asynchronous version of connect.
• public SocketConnection connect_to_host (string host_and_port, uint16 default_port, Cancellable? cancellable = null) throws Error
  This is a helper function for connect.
• public async SocketConnection connect_to_host_async (string host_and_port, uint16 default_port, Cancellable? cancellable = null) throws Error
  This is the asynchronous version of connect_to_host.
• public SocketConnection connect_to_service (string domain, string service, Cancellable? cancellable = null) throws Error
  Attempts to create a TCP connection to a service.
• public async SocketConnection connect_to_service_async (string domain, string service, Cancellable? cancellable = null) throws Error
  This is the asynchronous version of connect_to_service.
• public SocketConnection connect_to_uri (string uri, uint16 default_port, Cancellable? cancellable = null) throws Error
  This is a helper function for connect.
• public async SocketConnection connect_to_uri_async (string uri, uint16 default_port, Cancellable? cancellable = null) throws Error
  This is the asynchronous version of connect_to_uri.
• public bool get_enable_proxy ()
  Gets the proxy enable state; see set_enable_proxy
• public SocketFamily get_family ()
  Gets the socket family of the socket client.
• public unowned SocketAddress? get_local_address ()
  Gets the local address of the socket client.
• public SocketProtocol get_protocol ()
  Gets the protocol name type of the socket client.
• public unowned ProxyResolver get_proxy_resolver ()
  Gets the ProxyResolver being used by this.
• public SocketType get_socket_type ()
  Gets the socket type of the socket client.
• public uint get_timeout ()
  Gets the I/O timeout time for sockets created by this.
• public bool get_tls ()
  Gets whether this creates TLS connections.
• public TlsCertificateFlags get_tls_validation_flags ()
  Gets the TLS validation flags used creating TLS connections via this.
• public void set_enable_proxy (bool enable)
  Sets whether or not this attempts to make connections via a proxy server.
• public void set_family (SocketFamily family)
  Sets the socket family of the socket client.
• public void set_local_address (SocketAddress? address)
  Sets the local address of the socket client.
• public void set_protocol (SocketProtocol protocol)
  Sets the protocol of the socket client.
• public void set_proxy_resolver (ProxyResolver? proxy_resolver)
  Overrides the ProxyResolver used by this.
• public void set_socket_type (SocketType type)
  Sets the socket type of the socket client.
• public void set_timeout (uint timeout)
  Sets the I/O timeout for sockets created by this.
• public void set_tls (bool tls)
  Sets whether this creates TLS (aka SSL) connections.
• public void set_tls_validation_flags (TlsCertificateFlags flags)
  Sets the TLS validation flags used when creating TLS connections via this.

Signals:

• public virtual signal void event (SocketClientEvent event, SocketConnectable connectable, IOStream? connection)
  Emitted when client's activity on connectable changes state.

Inherited Members: