libsoup-2.2 Reference Manual

Synopsis

public class Message : Object  {
    public    weak string               method ;
    public    uint                      status_code ;
    public    weak string               reason_phrase ;
    public    DataBuffer                request ;
    public    weak GLib.HashTable       request_headers ;
    public    DataBuffer                response ;
    public    weak GLib.HashTable       response_headers ;
    public    MessageStatus             status ;


    public                              Message                   ( string              method,
                                                                    string              uri_string ) ;
    public                              Message.from_uri          ( string              method,
                                                                    Uri                 uri ) ;


    public    signal void               finished                  (  )  ;
    public    signal void               got_body                  (  )  ;
    public    signal void               got_chunk                 (  )  ;
    public    signal void               got_headers               (  )  ;
    public    signal void               got_informational         (  )  ;
    public    signal void               restarted                 (  )  ;
    public    signal void               wrote_body                (  )  ;
    public    signal void               wrote_chunk               (  )  ;
    public    signal void               wrote_headers             (  )  ;
    public    signal void               wrote_informational       (  )  ;


    public    void                      add_chunk                 ( Ownership           owner,
                                                                    string              body,
                                                                    uint                length ) ;
    public    void                      add_final_chunk           (  ) ;
    public    void                      add_handler               ( HandlerPhase        phase,
                                                                    MessageCallbackFn   handler_cb ) ;
    public    static void               add_header                ( GLib.HashTable      hash,
                                                                    string              name,
                                                                    string              value ) ;
    public    void                      add_header_handler        ( string              header,
                                                                    HandlerPhase        phase,
                                                                    MessageCallbackFn   handler_cb ) ;
    public    void                      add_status_class_handler  ( StatusClass         status_class,
                                                                    HandlerPhase        phase,
                                                                    MessageCallbackFn   handler_cb ) ;
    public    void                      add_status_code_handler   ( uint                status_code,
                                                                    HandlerPhase        phase,
                                                                    MessageCallbackFn   handler_cb ) ;
    public    static void               clear_headers             ( GLib.HashTable      hash ) ;
    public    uint                      get_flags                 (  ) ;
    public    static weak string        get_header                ( GLib.HashTable      hash,
                                                                    string              name ) ;
    public    static weak GLib.SList    get_header_list           ( GLib.HashTable      hash,
                                                                    string              name ) ;
    public    HttpVersion               get_http_version          (  ) ;
    public    TransferEncoding          get_request_encoding      ( uint                content_length ) ;
    public    TransferEncoding          get_response_encoding     ( uint                content_length ) ;
    public    weak Uri                  get_uri                   (  ) ;
    public    bool                      io_in_progress            (  ) ;
    public    void                      io_pause                  (  ) ;
    public    void                      io_stop                   (  ) ;
    public    void                      io_unpause                (  ) ;
    public    bool                      is_keepalive              (  ) ;
    public    void                      read_request              ( Socket              sock ) ;
    public    void                      remove_handler            ( HandlerPhase        phase,
                                                                    MessageCallbackFn   handler_cb ) ;
    public    static void               remove_header             ( GLib.HashTable      hash,
                                                                    string              name ) ;
    public    void                      send_request              ( Socket              sock,
                                                                    bool                is_via_proxy ) ;
    public    void                      set_flags                 ( uint                flags ) ;
    public    void                      set_http_version          ( HttpVersion         version ) ;
    public    void                      set_request               ( string              content_type,
                                                                    Ownership           req_owner,
                                                                    string              req_body,
                                                                    ulong               req_length ) ;
    public    void                      set_response              ( string              content_type,
                                                                    Ownership           resp_owner,
                                                                    string              resp_body,
                                                                    ulong               resp_length ) ;
    public    void                      set_status                ( uint                status_code ) ;
    public    void                      set_status_full           ( uint                status_code,
                                                                    string              reason_phrase ) ;
    public    void                      set_uri                   ( Uri                 uri ) ;
}

Message Description

Details

Constructor Details

Message ()
    public                              Message                   ( string              method,
                                                                    string              uri_string ) ;		

Message.from_uri ()
    public                              Message.from_uri          ( string              method,
                                                                    Uri                 uri ) ;		

Field Details

method
    public    weak string               method ;		

status_code
    public    uint                      status_code ;		

reason_phrase
    public    weak string               reason_phrase ;		

request
    public    DataBuffer                request ;		

request_headers
    public    weak GLib.HashTable       request_headers ;		

response
    public    DataBuffer                response ;		

response_headers
    public    weak GLib.HashTable       response_headers ;		

status
    public    MessageStatus             status ;		

Signal Details

finished
    public    signal void               finished                  (  )  ;		

got_body
    public    signal void               got_body                  (  )  ;		

got_chunk
    public    signal void               got_chunk                 (  )  ;		

got_headers
    public    signal void               got_headers               (  )  ;		

got_informational
    public    signal void               got_informational         (  )  ;		

restarted
    public    signal void               restarted                 (  )  ;		

wrote_body
    public    signal void               wrote_body                (  )  ;		

wrote_chunk
    public    signal void               wrote_chunk               (  )  ;		

wrote_headers
    public    signal void               wrote_headers             (  )  ;		

wrote_informational
    public    signal void               wrote_informational       (  )  ;		

Property Details

Method Details

add_chunk ()
    public    void                      add_chunk                 ( Ownership           owner,
                                                                    string              body,
                                                                    uint                length ) ;		

add_final_chunk ()
    public    void                      add_final_chunk           (  ) ;		

add_handler ()
    public    void                      add_handler               ( HandlerPhase        phase,
                                                                    MessageCallbackFn   handler_cb ) ;		

add_header ()
    public    static void               add_header                ( GLib.HashTable      hash,
                                                                    string              name,
                                                                    string              value ) ;		

add_header_handler ()
    public    void                      add_header_handler        ( string              header,
                                                                    HandlerPhase        phase,
                                                                    MessageCallbackFn   handler_cb ) ;		

add_status_class_handler ()
    public    void                      add_status_class_handler  ( StatusClass         status_class,
                                                                    HandlerPhase        phase,
                                                                    MessageCallbackFn   handler_cb ) ;		

add_status_code_handler ()
    public    void                      add_status_code_handler   ( uint                status_code,
                                                                    HandlerPhase        phase,
                                                                    MessageCallbackFn   handler_cb ) ;		

clear_headers ()
    public    static void               clear_headers             ( GLib.HashTable      hash ) ;		

get_flags ()
    public    uint                      get_flags                 (  ) ;		

get_header ()
    public    static weak string        get_header                ( GLib.HashTable      hash,
                                                                    string              name ) ;		

get_header_list ()
    public    static weak GLib.SList    get_header_list           ( GLib.HashTable      hash,
                                                                    string              name ) ;		

get_http_version ()
    public    HttpVersion               get_http_version          (  ) ;		

get_request_encoding ()
    public    TransferEncoding          get_request_encoding      ( uint                content_length ) ;		

get_response_encoding ()
    public    TransferEncoding          get_response_encoding     ( uint                content_length ) ;		

get_uri ()
    public    weak Uri                  get_uri                   (  ) ;		

io_in_progress ()
    public    bool                      io_in_progress            (  ) ;		

io_pause ()
    public    void                      io_pause                  (  ) ;		

io_stop ()
    public    void                      io_stop                   (  ) ;		

io_unpause ()
    public    void                      io_unpause                (  ) ;		

is_keepalive ()
    public    bool                      is_keepalive              (  ) ;		

read_request ()
    public    void                      read_request              ( Socket              sock ) ;		

remove_handler ()
    public    void                      remove_handler            ( HandlerPhase        phase,
                                                                    MessageCallbackFn   handler_cb ) ;		

remove_header ()
    public    static void               remove_header             ( GLib.HashTable      hash,
                                                                    string              name ) ;		

send_request ()
    public    void                      send_request              ( Socket              sock,
                                                                    bool                is_via_proxy ) ;		

set_flags ()
    public    void                      set_flags                 ( uint                flags ) ;		

set_http_version ()
    public    void                      set_http_version          ( HttpVersion         version ) ;		

set_request ()
    public    void                      set_request               ( string              content_type,
                                                                    Ownership           req_owner,
                                                                    string              req_body,
                                                                    ulong               req_length ) ;		

set_response ()
    public    void                      set_response              ( string              content_type,
                                                                    Ownership           resp_owner,
                                                                    string              resp_body,
                                                                    ulong               resp_length ) ;		

set_status ()
    public    void                      set_status                ( uint                status_code ) ;		

set_status_full ()
    public    void                      set_status_full           ( uint                status_code,
                                                                    string              reason_phrase ) ;		

set_uri ()
    public    void                      set_uri                   ( Uri                 uri ) ;		


Created by Valadoc