Server

---

Object Hierarchy:

Description:

Content:

Properties:

• public string address { get; }
  Address of the local mock server if it's running, or null otherwise.
• public bool enable_logging { get; set; }
  true if network traffic should be logged to a trace file (specified by calling start_trace).
• public bool enable_online { get; set; }
  true if network traffic should reach the Internet as normal; false to redirect it to the local mock server.
• public uint port { get; }
  Port of the local mock server if it's running, or <code class="literal">0</code> otherwise.
• public Resolver resolver { get; }
  Mock resolver used to redirect HTTP requests from specified domain names to the local mock server instance.
• public TlsCertificate tls_certificate { get; set; }
  TLS certificate for the mock server to use when serving HTTPS pages.
• public File trace_directory { get; set; }
  Directory relative to which all trace files specified in calls to start_trace will be resolved.

Static methods:

• public static Quark error_quark ()
• public static void received_message_chunk_from_soup (Logger logger, LoggerLogLevel level, char direction, string data, void* user_data)
  Convenience version of received_message_chunk which can be passed directly to set_printer to forward all libsoup traffic logging to a Server.

Creation methods:

• public Server ()
  Creates a new Server with default properties.

Methods:

• public void compare_messages_remove_filter (ulong filter_id)
  Remove a UhmServer:compare-messagess filter function installed previously by calling something like filter_ignore_parameter_values.
• public void end_trace ()
  Convenience function to finish logging to or reading from a trace file previously passed to start_trace or start_trace_full.
• public ulong filter_ignore_parameter_values (string[] parameter_names)
  Install a UhmServer:compare-messagess filter function which will override the default comparison function to one which ignores differences in the values of the given query parameter_names.
• public unowned string? get_address ()
  Gets the value of the address property.
• public bool get_enable_logging ()
  Gets the value of the enable_logging property.
• public bool get_enable_online ()
  Gets the value of the enable_online property.
• public uint get_port ()
  Gets the value of the port property.
• public unowned Resolver? get_resolver ()
  Gets the value of the resolver property.
• public unowned TlsCertificate? get_tls_certificate ()
  Gets the value of the tls_certificate property.
• public unowned File? get_trace_directory ()
  Gets the value of the trace_directory property.
• public void load_trace (File trace_file, Cancellable? cancellable = null) throws Error
  Synchronously loads the given trace_file of network messages, ready to simulate a network conversation by matching requests against the file and returning the associated responses.
• public async void load_trace_async (File trace_file, Cancellable? cancellable) throws Error
  Asynchronous version of load_trace.
• public void received_message_chunk (string message_chunk, int64 message_chunk_length) throws Error
  Indicates to the mock server that a single new line of a message was received from the real server.
• public void received_message_chunk_with_direction (char direction, string data, int64 data_length) throws Error
  Convenience version of received_message_chunk which takes the message direction and data separately, as provided by libsoup in a LoggerPrinter callback.
• public void run ()
  Runs the mock server, binding to a loopback TCP/IP interface and preparing a HTTPS server which is ready to accept requests.
• public unowned TlsCertificate set_default_tls_certificate ()
  Sets the value of the tls_certificate property to the default TLS certificate built in to libuhttpmock.
• public void set_enable_logging (bool enable_logging)
  Sets the value of the enable_logging property.
• public void set_enable_online (bool enable_online)
  Sets the value of the enable_online property.
• public void set_expected_domain_names (string[]? domain_names)
  Set the domain names which are expected to have requests made of them by the client code interacting with this Server.
• public void set_tls_certificate (TlsCertificate? tls_certificate)
  Sets the value of the tls_certificate property.
• public void set_trace_directory (File? trace_directory)
  Sets the value of the trace_directory property.
• public void start_trace (string trace_name) throws Error
  Starts a mock server which follows the trace file of filename trace_name in the trace_directory directory.
• public void start_trace_full (File trace_file) throws Error
  Convenience function to start logging to or reading from the given trace_file, depending on the values of enable_logging and enable_online.
• public void stop ()
  Stops a mock server started by calling run.
• public void unload_trace ()
  Unloads the current trace file of network messages, as loaded by load_trace or load_trace_async.

Signals:

• public virtual signal bool compare_messages (Message expected_message, Message actual_message, ClientContext actual_client)
  Emitted whenever the mock server must compare two Message<!-- -->s for equality; e.
• public virtual signal bool handle_message (Message message, ClientContext client)
  Emitted whenever the mock server is running and receives a request from a client.

Inherited Members: