ServerMessage

An HTTP server request and response pair.

A SoupServerMessage represents an HTTP message that is being sent or received on a class@Server.

class@Server will create soup.server_message.ServerMessages automatically for incoming requests, which your application will receive via handlers.

Note that libsoup's terminology here does not quite match the HTTP specification: in RFC 2616, an "HTTP-message" is *either* a Request, *or* a Response. In libsoup, a #SoupServerMessage combines both the request and the response.

class ServerMessage : ObjectG {

soup.types.HTTPVersion getHttpVersion();

gio.socket_address.SocketAddress getLocalAddress();

string getMethod();

string getReasonPhrase();

gio.socket_address.SocketAddress getRemoteAddress();

string getRemoteHost();

soup.message_body.MessageBody getRequestBody();

soup.message_headers.MessageHeaders getRequestHeaders();

soup.message_body.MessageBody getResponseBody();

soup.message_headers.MessageHeaders getResponseHeaders();

gio.socket.Socket getSocket();

uint getStatus();

gio.tls_certificate.TlsCertificate getTlsPeerCertificate();

gio.types.TlsCertificateFlags getTlsPeerCertificateErrors();

glib.uri.Uri getUri();

bool isOptionsPing();

void pause();

void setHttpVersion(soup.types.HTTPVersion version_);

void setRedirect(uint statusCode, string redirectUri);

void setResponse(string contentType, soup.types.MemoryUse respUse, ubyte[] respBody);

void setStatus(uint statusCode, string reasonPhrase);

gio.iostream.IOStream stealConnection();

void unpause();

ulong connectAcceptCertificate(T callback, Flag!"After" after);

ulong connectConnected(T callback, Flag!"After" after);

ulong connectDisconnected(T callback, Flag!"After" after);

ulong connectFinished(T callback, Flag!"After" after);

ulong connectGotBody(T callback, Flag!"After" after);

ulong connectGotChunk(T callback, Flag!"After" after);

ulong connectGotHeaders(T callback, Flag!"After" after);

ulong connectWroteBody(T callback, Flag!"After" after);

ulong connectWroteBodyData(T callback, Flag!"After" after);

ulong connectWroteChunk(T callback, Flag!"After" after);

ulong connectWroteHeaders(T callback, Flag!"After" after);

ulong connectWroteInformational(T callback, Flag!"After" after);

}

Members

Functions

connectAcceptCertificate ulong connectAcceptCertificate(T callback, Flag!"After" after): Connect to AcceptCertificate signal.
connectConnected ulong connectConnected(T callback, Flag!"After" after): Connect to Connected signal.
connectDisconnected ulong connectDisconnected(T callback, Flag!"After" after): Connect to Disconnected signal.
connectFinished ulong connectFinished(T callback, Flag!"After" after): Connect to Finished signal.
connectGotBody ulong connectGotBody(T callback, Flag!"After" after): Connect to GotBody signal.
connectGotChunk ulong connectGotChunk(T callback, Flag!"After" after): Connect to GotChunk signal.
connectGotHeaders ulong connectGotHeaders(T callback, Flag!"After" after): Connect to GotHeaders signal.
connectWroteBody ulong connectWroteBody(T callback, Flag!"After" after): Connect to WroteBody signal.
connectWroteBodyData ulong connectWroteBodyData(T callback, Flag!"After" after): Connect to WroteBodyData signal.
connectWroteChunk ulong connectWroteChunk(T callback, Flag!"After" after): Connect to WroteChunk signal.
connectWroteHeaders ulong connectWroteHeaders(T callback, Flag!"After" after): Connect to WroteHeaders signal.
connectWroteInformational ulong connectWroteInformational(T callback, Flag!"After" after): Connect to WroteInformational signal.
getHttpVersion soup.types.HTTPVersion getHttpVersion(): Get the HTTP version of msg.
getLocalAddress gio.socket_address.SocketAddress getLocalAddress(): Retrieves the gio.socket_address.SocketAddress associated with the local end of a connection.
getMethod string getMethod(): Get the HTTP method of msg.
getReasonPhrase string getReasonPhrase(): Get the HTTP reason phrase of msg.
getRemoteAddress gio.socket_address.SocketAddress getRemoteAddress(): Retrieves the gio.socket_address.SocketAddress associated with the remote end of a connection.
getRemoteHost string getRemoteHost(): Retrieves the IP address associated with the remote end of a connection.
getRequestBody soup.message_body.MessageBody getRequestBody(): Get the request body of msg.
getRequestHeaders soup.message_headers.MessageHeaders getRequestHeaders(): Get the request headers of msg.
getResponseBody soup.message_body.MessageBody getResponseBody(): Get the response body of msg.
getResponseHeaders soup.message_headers.MessageHeaders getResponseHeaders(): Get the response headers of msg.
getSocket gio.socket.Socket getSocket(): Retrieves the gio.socket.Socket that msg is associated with.
getStatus uint getStatus(): Get the HTTP status code of msg.
getTlsPeerCertificate gio.tls_certificate.TlsCertificate getTlsPeerCertificate(): Gets the peer's #GTlsCertificate associated with msg's connection. Note that this is not set yet during the emission of SoupServerMessage::accept-certificate signal.
getTlsPeerCertificateErrors gio.types.TlsCertificateFlags getTlsPeerCertificateErrors(): Gets the errors associated with validating msg's TLS peer certificate. Note that this is not set yet during the emission of SoupServerMessage::accept-certificate signal.
getUri glib.uri.Uri getUri(): Get msg's URI.
isOptionsPing bool isOptionsPing(): Gets if msg represents an OPTIONS message with the path *.
pause void pause(): Pauses I/O on msg.
setHttpVersion void setHttpVersion(soup.types.HTTPVersion version_): Set the HTTP version of msg.
setRedirect void setRedirect(uint statusCode, string redirectUri): Sets msg's status_code to status_code and adds a Location header pointing to redirect_uri. Use this from a classServer when you want to redirect the client to another URI.
setResponse void setResponse(string contentType, soup.types.MemoryUse respUse, ubyte[] respBody): Convenience function to set the response body of a #SoupServerMessage. If content_type is null, the response body must be empty as well.
setStatus void setStatus(uint statusCode, string reasonPhrase): Sets msg's status code to status_code.
stealConnection gio.iostream.IOStream stealConnection(): "Steals" the HTTP connection associated with msg from its #SoupServer. This happens immediately, regardless of the current state of the connection; if the response to msg has not yet finished being sent, then it will be discarded; you can steal the connection from a signalServerMessage::wrote-informational or signalServerMessage::wrote-body signal handler if you need to wait for part or all of the response to be sent.
unpause void unpause(): Resumes I/O on msg.

Inherited Members

From ObjectG

setGObject void setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectG wrapper.
cPtr void* cPtr(Flag!"Dup" dup): Get a pointer to the underlying C object.
ref_ void* ref_(void* gObj): Calls g_object_ref() on a GObject.
unref unref(void* gObj): Calls g_object_unref() on a GObject.
getType GType getType(): Get the GType of an object.
gType GType gType [@property getter]: GObject GType property.
self ObjectG self(): Convenience method to return this cast to a type. For use in D with statements.
getDObject T getDObject(void* cptr, Flag!"Take" take): Template to get the D object from a C GObject and cast it to the given D object type.
connectSignalClosure ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after): Connect a D closure to an object signal.
setProperty void setProperty(string propertyName, T val): Template for setting a GObject property.
getProperty T getProperty(string propertyName): Template for getting a GObject property.
compatControl size_t compatControl(size_t what, void* data)
bindProperty gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags): Creates a binding between source_property on source and target_property on target.
bindPropertyFull gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom): Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.
forceFloating void forceFloating(): This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectG.refSink.
freezeNotify void freezeNotify(): Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.
getData void* getData(string key): Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).
getProperty void getProperty(string propertyName, gobject.value.Value value): Gets a property of an object.
getQdata void* getQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.
getv void getv(string[] names, gobject.value.Value[] values): Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
isFloating bool isFloating(): Checks whether object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property property_name on object.
notifyByPspec void notifyByPspec(gobject.param_spec.ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
refSink gobject.object.ObjectG refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setProperty void setProperty(string propertyName, gobject.value.Value value): Sets a property on an object.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:
thawNotify void thawNotify(): Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
watchClosure void watchClosure(gobject.closure.Closure closure): This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.
connectNotify ulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

soup server_message classes

ServerMessage