HTTP::Soup::Message(3pm)

1HTTP::Soup::Message(3)User Contributed Perl DocumentationHTTP::Soup::Message(3)
2
3
4

NAME

6       HTTP::Soup::Message
7

HIERARCHY

9         Glib::Object
10         +----HTTP::Soup::Message
11

METHODS

13   string = $message->method ($val=undef)
14       •   $val (string)
15
16   string = $message->reason_phrase ($val=undef)
17       •   $val (string)
18
19   messagebody = $message->request_body ($val=undef)
20       •   $val (HTTP::Soup::MessageBody)
21
22   messageheaders = $message->request_headers ($val=undef)
23       •   $val (HTTP::Soup::MessageHeaders)
24
25   messagebody = $message->response_body ($val=undef)
26       •   $val (HTTP::Soup::MessageBody)
27
28   messageheaders = $message->response_headers ($val=undef)
29       •   $val (HTTP::Soup::MessageHeaders)
30
31   integer = $message->status_code ($val=0)
32       •   $val (integer)
33

PROPERTIES

35       'first-party' (HTTP::Soup::URI : default undef : readable / writable /
36       private / static-nick / static-blurb)
37           The URI loaded in the application when the message was requested.
38
39       'flags' (HTTP::Soup::MessageFlags : default  : readable / writable /
40       private / static-nick / static-blurb)
41           Various message options
42
43       'http-version' (HTTP::Soup::HTTPVersion : default "http-1-1" : readable
44       / writable / private / static-nick / static-blurb)
45           The HTTP protocol version to use
46
47       'is-top-level-navigation' (boolean : default false : readable /
48       writable)
49           If the current messsage is navigating between top-levels
50
51       'method' (string : default "GET" : readable / writable / private /
52       static-nick / static-blurb)
53           The message's HTTP method
54
55       'priority' (HTTP::Soup::MessagePriority : default "normal" : readable /
56       writable / private / static-nick / static-blurb)
57           The priority of the message
58
59       'reason-phrase' (string : default undef : readable / writable / private
60       / static-nick / static-blurb)
61           The HTTP response reason phrase
62
63       'request-body' (HTTP::Soup::MessageBody : default undef : readable /
64       private / static-nick / static-blurb)
65           The HTTP request content
66
67       'request-body-data' (Glib::Bytes : default undef : readable / private /
68       static-nick / static-blurb)
69           The HTTP request body
70
71       'request-headers' (HTTP::Soup::MessageHeaders : default undef :
72       readable / private / static-nick / static-blurb)
73           The HTTP request headers
74
75       'response-body' (HTTP::Soup::MessageBody : default undef : readable /
76       private / static-nick / static-blurb)
77           The HTTP response content
78
79       'response-body-data' (Glib::Bytes : default undef : readable / private
80       / static-nick / static-blurb)
81           The HTTP response body
82
83       'response-headers' (HTTP::Soup::MessageHeaders : default undef :
84       readable / private / static-nick / static-blurb)
85           The HTTP response headers
86
87       'server-side' (boolean : default false : readable / writable /
88       construct-only / private / static-nick / static-blurb)
89           Whether or not the message is server-side rather than client-side
90
91       'site-for-cookies' (HTTP::Soup::URI : default undef : readable /
92       writable)
93           The URI for the site to compare cookies against
94
95       'status-code' (Glib::UInt : default 0 : readable / writable / private /
96       static-nick / static-blurb)
97           The HTTP response status code
98
99       'tls-certificate' (Glib::Object::_Unregistered::GTlsCertificate :
100       default undef : readable / writable / private / static-nick / static-
101       blurb)
102           The TLS certificate associated with the message
103
104       'tls-errors' (GTlsCertificateFlags : default ["no-flags"] : readable /
105       writable / private / static-nick / static-blurb)
106           The verification errors on the message's TLS certificate
107
108       'uri' (HTTP::Soup::URI : default undef : readable / writable / private
109       / static-nick / static-blurb)
110           The message's Request-URI
111

SIGNALS

113       content-sniffed (HTTP::Soup::Message, string, GHashTable)
114       finished (HTTP::Soup::Message)
115       got-body (HTTP::Soup::Message)
116       got-chunk (HTTP::Soup::Message, HTTP::Soup::Buffer)
117       got-headers (HTTP::Soup::Message)
118       got-informational (HTTP::Soup::Message)
119       network-event (HTTP::Soup::Message, GSocketClientEvent,
120       Glib::Object::_Unregistered::GIOStream)
121       restarted (HTTP::Soup::Message)
122       starting (HTTP::Soup::Message)
123       wrote-body (HTTP::Soup::Message)
124       wrote-body-data (HTTP::Soup::Message, HTTP::Soup::Buffer)
125       wrote-chunk (HTTP::Soup::Message)
126       wrote-headers (HTTP::Soup::Message)
127       wrote-informational (HTTP::Soup::Message)
128

ENUMS AND FLAGS

130   enum GSocketClientEvent
131       •   'resolving' / 'G_SOCKET_CLIENT_RESOLVING'
132
133       •   'resolved' / 'G_SOCKET_CLIENT_RESOLVED'
134
135       •   'connecting' / 'G_SOCKET_CLIENT_CONNECTING'
136
137       •   'connected' / 'G_SOCKET_CLIENT_CONNECTED'
138
139       •   'proxy-negotiating' / 'G_SOCKET_CLIENT_PROXY_NEGOTIATING'
140
141       •   'proxy-negotiated' / 'G_SOCKET_CLIENT_PROXY_NEGOTIATED'
142
143       •   'tls-handshaking' / 'G_SOCKET_CLIENT_TLS_HANDSHAKING'
144
145       •   'tls-handshaked' / 'G_SOCKET_CLIENT_TLS_HANDSHAKED'
146
147       •   'complete' / 'G_SOCKET_CLIENT_COMPLETE'
148
149   enum GTlsCertificateFlags
150       •   'no-flags' / 'G_TLS_CERTIFICATE_NO_FLAGS'
151
152       •   'unknown-ca' / 'G_TLS_CERTIFICATE_UNKNOWN_CA'
153
154       •   'bad-identity' / 'G_TLS_CERTIFICATE_BAD_IDENTITY'
155
156       •   'not-activated' / 'G_TLS_CERTIFICATE_NOT_ACTIVATED'
157
158       •   'expired' / 'G_TLS_CERTIFICATE_EXPIRED'
159
160       •   'revoked' / 'G_TLS_CERTIFICATE_REVOKED'
161
162       •   'insecure' / 'G_TLS_CERTIFICATE_INSECURE'
163
164       •   'generic-error' / 'G_TLS_CERTIFICATE_GENERIC_ERROR'
165
166       •   'validate-all' / 'G_TLS_CERTIFICATE_VALIDATE_ALL'
167
168   enum HTTP::Soup::HTTPVersion
169       •   'http-1-0' / 'SOUP_HTTP_1_0'
170
171       •   'http-1-1' / 'SOUP_HTTP_1_1'
172
173   flags HTTP::Soup::MessageFlags
174       •   'no-redirect' / 'SOUP_MESSAGE_NO_REDIRECT'
175
176       •   'can-rebuild' / 'SOUP_MESSAGE_CAN_REBUILD'
177
178       •   'overwrite-chunks' / 'SOUP_MESSAGE_OVERWRITE_CHUNKS'
179
180       •   'content-decoded' / 'SOUP_MESSAGE_CONTENT_DECODED'
181
182       •   'certificate-trusted' / 'SOUP_MESSAGE_CERTIFICATE_TRUSTED'
183
184       •   'new-connection' / 'SOUP_MESSAGE_NEW_CONNECTION'
185
186       •   'idempotent' / 'SOUP_MESSAGE_IDEMPOTENT'
187
188       •   'ignore-connection-limits' /
189           'SOUP_MESSAGE_IGNORE_CONNECTION_LIMITS'
190
191       •   'do-not-use-auth-cache' / 'SOUP_MESSAGE_DO_NOT_USE_AUTH_CACHE'
192
193   enum HTTP::Soup::MessagePriority
194       •   'very-low' / 'SOUP_MESSAGE_PRIORITY_VERY_LOW'
195
196       •   'low' / 'SOUP_MESSAGE_PRIORITY_LOW'
197
198       •   'normal' / 'SOUP_MESSAGE_PRIORITY_NORMAL'
199
200       •   'high' / 'SOUP_MESSAGE_PRIORITY_HIGH'
201
202       •   'very-high' / 'SOUP_MESSAGE_PRIORITY_VERY_HIGH'
203

COPYRIGHT

208       Copyright (C) 2011 by Emmanuel Rodriguez
209
210
211
212perl v5.36.0                      2023-01-20            HTTP::Soup::Message(3)