Sane C++ Libraries
C++ Platform Abstraction Libraries
Loading...
Searching...
No Matches
SC::HttpAsyncClientResponse Struct Reference

Incoming HTTP response received by the client. More...

#include <HttpConnection.h>

Inheritance diagram for SC::HttpAsyncClientResponse:
SC::HttpIncomingMessage

Friends

struct HttpAsyncClient
 

Additional Inherited Members

- Public Member Functions inherited from SC::HttpIncomingMessage
const HttpParsergetParser () const
 Gets the associated HttpParser.
 
bool getKeepAlive () const
 Gets whether the other party requested the connection to stay alive.
 
HttpBodyFramingKind getBodyFramingKind () const
 Returns the effective framing mode for the incoming body.
 
uint64_t getBodyBytesRemaining () const
 Returns how many body bytes are still expected for this message.
 
bool isBodyComplete () const
 Returns true once the full body has been received according to its framing.
 
bool isMultipart () const
 Checks if the request is a multipart/form-data request.
 
StringSpan getBoundary () const
 Gets the multipart boundary string (if isMultipart() returns true)
 
bool getHeader (StringSpan headerName, StringSpan &value) const
 Gets the value of a specific header (case-insensitive name matching)
 
AsyncReadableStreamgetReadableStream ()
 Obtains the readable stream for the message body.
 
const AsyncReadableStreamgetReadableStream () const
 Obtains the readable stream for the message body.
 
Result consumeBodyBytes (size_t bytes)
 Decrements the remaining body bytes after consuming data.
 
- Protected Types inherited from SC::HttpIncomingMessage
enum class  ChunkedState : uint8_t {
  Size ,
  SizeExtension ,
  SizeLF ,
  Data ,
  DataCR ,
  DataLF ,
  TrailerLineStart ,
  TrailerEndLF ,
  Finished
}
 
- Protected Member Functions inherited from SC::HttpIncomingMessage
void resetIncoming (HttpParser::Type type, Span< char > memory)
 
bool hasReceivedHeaders () const
 
Span< char > getUnusedHeaderMemory () const
 
Result initBodyStream (AsyncBuffersPool &buffersPool, Function< Result()> &&onReadRequest)
 
Result startBodyStream ()
 
bool pushBodyData (AsyncBufferView::ID bufferID, size_t sizeInBytes)
 
void finishBodyStream ()
 
void failBodyStream (Result result)
 
void abortBodyStream ()
 
Result prepareBodyStream (AsyncBuffersPool &buffersPool, Function< Result()> &&onReadRequest, bool allowCloseDelimited)
 
Result processBodyData (AsyncReadableStream &sourceStream, AsyncBufferView::ID bufferID, Span< const char > readData, bool allowTrailingData)
 
void setBodyBytesRemaining (uint64_t value)
 
void setBodyFramingKind (HttpBodyFramingKind value)
 
void setBodyComplete (bool value)
 
void attachReadableStream (AsyncReadableStream &stream)
 
bool findParserToken (HttpParser::Token token, StringSpan &res) const
 Finds a specific HttpParser::Result in the list of parsed header.
 
Result writeHeaders (const uint32_t maxHeaderSize, Span< const char > readData, AsyncReadableStream &stream, AsyncBufferView::ID bufferID, const char *outOfSpaceError, const char *sizeExceededError, bool stopAtHeadersEnd, bool unshiftPendingBodyToStream=true)
 Parses an incoming slice of data eventually copying it to the availableHeader.
 
size_t getHeadersLength () const
 Gets the length of the headers in bytes.
 
- Protected Attributes inherited from SC::HttpIncomingMessage
HttpParsedHeaders parsedHeaders
 
Span< char > headerMemory
 
AsyncReadableStreamreadableStream = nullptr
 
uint64_t bodyBytesRemaining = 0
 
HttpBodyFramingKind bodyFramingKind = HttpBodyFramingKind::None
 
bool bodyComplete = true
 
bool bodyStreamStarted = false
 
BodyStream bodyStream
 
ChunkedState chunkedState = ChunkedState::Size
 
uint64_t chunkedChunkSize = 0
 
uint64_t chunkedBytesRemaining = 0
 
bool chunkedSizeHasDigits = false
 

Detailed Description

Incoming HTTP response received by the client.


The documentation for this struct was generated from the following file: