Class (GI Struct)

Soup-3.0SoupMessageBody

MessageBody represents the request or response body of a Message.

Note that while length always reflects the full length of the message body, data is normally null, and will only be filled in after MessageBody.flatten is called. For client-side messages, this automatically happens for the response body after it has been fully read. Likewise, for server-side messages, the request body is automatically filled in after being read.

As an added bonus, when data is filled in, it is always terminated with a \0 byte (which is not reflected in length).

Index

Constructors

Properties

data: Uint8Array
length: number

Methods

  • Appends length bytes from data to body according to use.

    Parameters

    • use: Soup.MemoryUse

      how to use data

    • data: string | Uint8Array<ArrayBufferLike>

      data to append

    Returns void

  • Appends length bytes from data to body.

    This function is exactly equivalent to MessageBody.append with Soup.MemoryUse.TAKE as second argument; it exists mainly for convenience and simplifying language bindings.

    Parameters

    • data: string | Uint8Array<ArrayBufferLike>

      data to append

    Returns void

  • Tags body as being complete.

    Call this when using chunked encoding after you have appended the last chunk.

    Returns void

  • Gets the accumulate flag on body.

    See [method@MessageBody.set_accumulate. for details.

    Returns boolean

    the accumulate flag for body.

  • Gets a GLib.Bytes containing data from body starting at offset.

    The size of the returned chunk is unspecified. You can iterate through the entire body by first calling MessageBody.get_chunk with an offset of 0, and then on each successive call, increment the offset by the length of the previously-returned chunk.

    If offset is greater than or equal to the total length of body, then the return value depends on whether or not MessageBody.complete has been called or not; if it has, then MessageBody.get_chunk will return a 0-length chunk (indicating the end of body). If it has not, then MessageBody.get_chunk will return null (indicating that body may still potentially have more data, but that data is not currently available).

    Parameters

    • offset: number

      an offset

    Returns GLib.Bytes

    a GLib.Bytes

  • Handles the MessageBody part of receiving a chunk of data from the network.

    Normally this means appending chunk to body, exactly as with MessageBody.append_bytes, but if you have set body's accumulate flag to false, then that will not happen.

    This is a low-level method which you should not normally need to use.

    Parameters

    Returns void

  • Sets or clears the accumulate flag on body.

    (The default value is true.) If set to false, body's data field will not be filled in after the body is fully sent/received, and the chunks that make up body may be discarded when they are no longer needed.

    If you set the flag to false on the Message request_body of a client-side message, it will block the accumulation of chunks into body's data field, but it will not normally cause the chunks to be discarded after being written like in the server-side Message response_body case, because the request body needs to be kept around in case the request needs to be sent a second time due to redirection or authentication.

    Parameters

    • accumulate: boolean

      whether or not to accumulate body chunks in body

    Returns void

  • Atomically decrements the reference count of body by one.

    When the reference count reaches zero, the resources allocated by body are freed

    Returns void

  • Handles the MessageBody part of writing a chunk of data to the network.

    Normally this is a no-op, but if you have set body's accumulate flag to false, then this will cause chunk to be discarded to free up memory.

    This is a low-level method which you should not need to use, and there are further restrictions on its proper use which are not documented here.

    Parameters

    Returns void