Session

---

Object Hierarchy:

Description:

Content:

Properties:

• public string accept_language { set; owned get; }
  If non-%NULL, the value to use for the "Accept-Language" header on Messages sent from this session.
• public bool accept_language_auto { set; get; }
  If true, Session will automatically set the string for the "Accept-Language" header on every Message sent, based on the return value of get_language_names.
• public SessionFeature add_feature { set; owned get; }
  Add a feature object to the session. (Shortcut for calling soup_session_add_feature.)
• public Type add_feature_by_type { set; get; }
  Add a feature object of the given type to the session. (Shortcut for calling soup_session_add_feature_by_type.)
• public MainContext async_context { construct set; get; }
• public uint idle_timeout { set; get; }
  Connection lifetime when idle
• public int max_conns { set; get; }
• public int max_conns_per_host { set; get; }
• public URI proxy_uri { set; owned get; }
• public Type remove_feature_by_type { set; get; }
  Remove feature objects from the session. (Shortcut for calling soup_session_remove_feature_by_type.)
• public string ssl_ca_file { set; owned get; }
• public bool ssl_strict { set; get; }
• public uint timeout { set; get; }
• public bool use_ntlm { set; get; }
  Whether or not to use NTLM authentication.
• public string user_agent { set; owned get; }
  If non-%NULL, the value to use for the "User-Agent" header on Messages sent from this session.

Creation methods:

• protected Session ()

Methods:

• public void abort ()
  Cancels all pending requests in session.
• public virtual void auth_required (Message msg, Auth auth, bool retrying)
• public virtual void cancel_message (Message msg, uint status_code)
  Causes session to immediately finish processing msg (regardless of its current state) with a final status_code of status_code. You may call this at any time after handing msg off to session; if session has started sending the request but has not yet received the complete response, then it will close the request's connection. Note that with non-idempotent requests (eg, POST, PUT, DELETE) it is possible that you might cancel the request after the server acts on it, but before it returns a response, leaving the remote resource in an unknown state.
• public weak MainContext get_async_context ()
  Gets session's async_context. This does not add a ref to the context, so you will need to ref it yourself if you want it to outlive its session.
• public weak SessionFeature get_feature (Type feature_type)
  Gets the first feature in session of type feature_type. For features where there may be more than one feature of a given type, use get_features.
• public weak SessionFeature get_feature_for_message (Type feature_type, Message msg)
  Gets the first feature in session of type feature_type, provided that it is not disabled for msg. As with get_feature, this should only be used for features where feature_type is only expected to match a single feature. In particular, if there are two matching features, and the first is disabled on msg, and the second is not, then this will return null, not the second feature.
• public SList<SessionFeature> get_features (Type feature_type)
  Generates a list of session's features of type feature_type. (If you want to see all features, you can pass SOUP_TYPE_SESSION_FEATURE for feature_type.)
• public void pause_message (Message msg)
  Pauses HTTP I/O on msg. Call unpause_message to resume I/O.
• public void prepare_for_uri (URI uri)
• public virtual void queue_message (owned Message msg, SessionCallback? callback)
  Queues the message msg for sending. All messages are processed while the glib main loop runs. If msg has been processed before, any resources related to the time it was last sent are freed.
• public void remove_feature (SessionFeature feature)
  Removes feature's functionality from session.
• public virtual void requeue_message (Message msg)
  This causes msg to be placed back on the queue to be attempted again.
• public virtual uint send_message (Message msg)
  Synchronously send msg. This call will not return until the transfer is finished successfully or there is an unrecoverable error.
• public void unpause_message (Message msg)
  Resumes HTTP I/O on msg. Use this to resume after calling pause_message.

Signals:

• public virtual void authenticate (Message msg, Auth auth, bool retrying)
  Emitted when the session requires authentication. If credentials are available call authenticate on auth. If these credentials fail, the signal will be emitted again, with retrying set to true, which will continue until you return without calling authenticate on auth.
• public void connection_created (Object object)
  Emitted when a new connection is created. This is an internal signal intended only to be used for debugging purposes, and may go away in the future.
• public void request_queued (Message object)
  Emitted when a request is queued on session. (Note that "queued" doesn't just mean queue_message; send_message implicitly queues the message as well.)
• public virtual void request_started (Message msg, Socket socket)
  Emitted just before a request is sent. See request_queued for a detailed description of the message lifecycle within a session.
• public void request_unqueued (Message object)
  Emitted when a request is removed from session's queue, indicating that session is done with it. See request_queued for a detailed description of the message lifecycle within a session.
• public void tunneling (Object object)
  Emitted when an SSL tunnel is being created on a proxy connection. This is an internal signal intended only to be used for debugging purposes, and may go away in the future.