arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
HttpRequest Class Reference
Arduino Audio Tools » Communications » Http

Simple API to process get, put, post, del http requests I tried to use Arduino HttpClient, but I did not manage to extract the mime type from streaming get requests. More...

#include <HttpRequest.h>

Inheritance diagram for HttpRequest:
BaseStream Stream Print

Public Member Functions

 HttpRequest ()=default
 
 HttpRequest (Client &client)
 
 ~HttpRequest ()
 
void addRequestHeader (const char *key, const char *value)
 Adds/Updates a request header.
 
int available () override
 
virtual int availableForWrite () override
 
virtual bool begin ()
 
Client & client ()
 
virtual bool connected ()
 
size_t contentLength ()
 
virtual int del (Url &url, const char *mime=nullptr, const char *data=nullptr, int len=-1)
 http del
 
void end () override
 same as end()
 
virtual void flush () override
 
virtual int get (Url &url, const char *acceptMime=nullptr, const char *data=nullptr, int len=-1)
 http get
 
const char * getReplyHeader (const char *key)
 
virtual int head (Url &url, const char *acceptMime=nullptr, const char *data=nullptr, int len=-1)
 http head
 
virtual HttpRequestHeader & header ()
 provides access to the request header
 
bool isChunked ()
 we are sending the data chunked
 
bool isReady ()
 
 operator bool ()
 
virtual int post (Url &url, const char *mime, const char *data, int len=-1)
 http post
 
virtual int post (Url &url, const char *mime, Stream &data, int len=-1)
 http post
 
virtual int process (MethodID action, Url &url, const char *mime, const char *data, int lenData=-1)
 
virtual int process (MethodID action, Url &url, const char *mime, Stream &stream, int len=-1)
 
virtual bool processBegin (MethodID action, Url &url, const char *mime, int lenData=-1)
 starts http request processing
 
virtual int processEnd ()
 Ends the http request processing and returns the status code or -1 on error.
 
virtual void processWrite (Stream &stream)
 Writes (Posts) the data of the indicated stream after calling processBegin.
 
virtual int put (Url &url, const char *mime, const char *data, int len=-1)
 http put
 
virtual int put (Url &url, const char *mime, Stream &data, int len=-1)
 http put
 
virtual int read (uint8_t *str, int len)
 
size_t readBytes (uint8_t *str, size_t len) override
 
size_t readBytesUntil (char terminator, char *buffer, size_t length)
 
virtual int readln (uint8_t *str, int len, bool incl_nl=true)
 
virtual HttpReplyHeader & reply ()
 
virtual void setAcceptMime (const char *mime)
 
virtual void setAcceptsEncoding (const char *enc)
 
virtual void setAgent (const char *agent)
 Defines the agent.
 
void setClient (Client &client)
 
virtual void setConnection (const char *connection)
 
void setHost (const char *host)
 
void setOnConnectCallback (void(*callback)(HttpRequest &request, Url &url, HttpRequestHeader &request_header))
 Callback which allows you to add additional paramters dynamically.
 
void setTimeout (size_t timeoutMs)
 Defines the client timeout in ms.
 
void setWriteBufferSize (int size)
 
virtual void stop ()
 
size_t write (const uint8_t *data, size_t len) override
 
virtual size_t write (uint8_t ch) override
 

Protected Member Functions

virtual int connect (const char *ip, uint16_t port, int32_t timeout)
 
void refillReadBuffer ()
 Refill small read buffer (e.g. 8 bytes) to avoid single byte reads when calling read()
 

Protected Attributes

int _timeout = 10
 
const char * accept = ACCEPT_ALL
 
const char * accept_encoding = IDENTITY
 
const char * agent = nullptr
 
HttpChunkReader chunk_reader = HttpChunkReader(reply_header)
 
Client * client_ptr = nullptr
 
int client_timeout = URL_CLIENT_TIMEOUT
 
const char * connection = CON_KEEP_ALIVE
 
const char * host_name = nullptr
 
void(* http_connect_callback )(HttpRequest &request, Url &url, HttpRequestHeader &request_header) = nullptr
 
bool is_chunked_output_active = false
 
bool is_ready = false
 
HttpReplyHeader reply_header
 
HttpRequestHeader request_header
 
RingBuffer< uint8_t > tmp_in {0}
 
RingBuffer< uint8_t > tmp_out {0}
 
Url url
 
int write_buffer_size = MAX_SINGLE_CHARS
 

Detailed Description

Simple API to process get, put, post, del http requests I tried to use Arduino HttpClient, but I did not manage to extract the mime type from streaming get requests.

The functionality is based on the Arduino Client class.

Author
Phil Schatzmann
Copyright
GPLv3

Constructor & Destructor Documentation

◆ HttpRequest() [1/2]

HttpRequest ( )
default

◆ ~HttpRequest()

~HttpRequest ( )
inline

◆ HttpRequest() [2/2]

HttpRequest ( Client &  client)
inline

Member Function Documentation

◆ addRequestHeader()

void addRequestHeader ( const char *  key,
const char *  value 
)
inline

Adds/Updates a request header.

◆ available()

int available ( )
inlineoverridevirtual

Reimplemented from BaseStream.

◆ availableForWrite()

virtual int availableForWrite ( )
inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in AudioLoRa, UDPStream, VBANStream, AudioStreamWrapper, ConverterStream< T >, EncodedAudioStream, FaustStream< DSP >, I2SCodecStream, MiniAudioStream, StdioStream, A2DPStream, ESPNowStream, HammingFEC< bytecount, block_t >, AbstractURLStream, URLStreamESP32, NRF24Stream, ReedSolomonFEC< bytecount, additional_bytes >, SPIAudioSlave, USBAudioDeviceBase, AnalogAudioStream, AudioEffectStreamT< T >, AudioEffectStream, Equalizer3Bands, Equalizer3BandsPerChannel, I2SStream, ReformatBaseStream, TimedStream, MemoryStream, RingBufferStream, MeasuringStream, ProgressStream, Throttle, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, QueueStream< T >, QueueStream< uint8_t >, DynamicMemoryStream, FadeStream, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, Pipeline, QualityAnalysisStream, VolumeStream, AudioFFTBase, AudioBLEClient, AudioBLEClient, AudioBLEServer, and AudioBLEServer.

◆ begin()

virtual bool begin ( )
inlinevirtualinherited

Reimplemented in AudioOutputWithCallback, AudioMP34DT05, I2SCodecStream, MozziStream, PureDataStream, SPDIFOutput, VS1053Stream, WM8960Stream, AdaptiveResamplingStream, AudioLoRa, ESPNowStream, USBAudioDeviceBase, VBANStream, AudioEffectStreamT< T >, AudioEffectStream, Equalizer3Bands, Equalizer3BandsPerChannel, I2SStream, AudioStreamWrapper, TimerCallbackAudioStream, FrequencyDetectorAutoCorrelation, GoertzelStream, ResampleStreamT< TInterpolator >, FileLoopT< FileType >, FileLoopT< File >, EncodedAudioStream, AudioBoardStream, AudioKitStream, MiniAudioStream, PortAudioStream, StdioStream, HLSStreamT< URLStream >, NRF24Stream, AnalogAudioStream, AdapterAudioOutputToAudioStream, TimedStream, MemoryStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, MeasuringStream, ProgressStream, Throttle, InputMerge< T >, CallbackStream, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, VolumeMeter, AudioInputMonitor, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, CatStream, QueueStream< T >, QueueStream< uint8_t >, DynamicMemoryStream, Pipeline, Pipeline::ModifyingStreamAdapter, QualityAnalysisStream, ResampleStream, VolumeStream, AudioFFTBase, and EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >.

◆ client()

Client & client ( )
inline

◆ connect()

virtual int connect ( const char *  ip,
uint16_t  port,
int32_t  timeout 
)
inlineprotectedvirtual

◆ connected()

virtual bool connected ( )
inlinevirtual

◆ contentLength()

size_t contentLength ( )
inline

◆ del()

virtual int del ( Url &  url,
const char *  mime = nullptr,
const char *  data = nullptr,
int  len = -1 
)
inlinevirtual

http del

◆ end()

void end ( )
inlineoverridevirtual

same as end()

Reimplemented from BaseStream.

◆ flush()

virtual void flush ( )
inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in PureDataStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, ReformatBaseStream, AudioStreamWrapper, ResampleStream, EncodedAudioStream, URLStream, BufferedTaskStream, I2SStream, MemoryStream, RingBufferStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, and BufferedStream.

◆ get()

virtual int get ( Url &  url,
const char *  acceptMime = nullptr,
const char *  data = nullptr,
int  len = -1 
)
inlinevirtual

http get

◆ getReplyHeader()

const char * getReplyHeader ( const char *  key)
inline

◆ head()

virtual int head ( Url &  url,
const char *  acceptMime = nullptr,
const char *  data = nullptr,
int  len = -1 
)
inlinevirtual

http head

◆ header()

virtual HttpRequestHeader & header ( )
inlinevirtual

provides access to the request header

◆ isChunked()

bool isChunked ( )
inline

we are sending the data chunked

◆ isReady()

bool isReady ( )
inline

returns true when the request has completed and ready for the data to be requested

◆ operator bool()

operator bool ( )
inline

◆ post() [1/2]

virtual int post ( Url &  url,
const char *  mime,
const char *  data,
int  len = -1 
)
inlinevirtual

http post

◆ post() [2/2]

virtual int post ( Url &  url,
const char *  mime,
Stream &  data,
int  len = -1 
)
inlinevirtual

http post

◆ process() [1/2]

virtual int process ( MethodID  action,
Url &  url,
const char *  mime,
const char *  data,
int  lenData = -1 
)
inlinevirtual

◆ process() [2/2]

virtual int process ( MethodID  action,
Url &  url,
const char *  mime,
Stream &  stream,
int  len = -1 
)
inlinevirtual

◆ processBegin()

virtual bool processBegin ( MethodID  action,
Url &  url,
const char *  mime,
int  lenData = -1 
)
inlinevirtual

starts http request processing

◆ processEnd()

virtual int processEnd ( )
inlinevirtual

Ends the http request processing and returns the status code or -1 on error.

◆ processWrite()

virtual void processWrite ( Stream &  stream)
inlinevirtual

Writes (Posts) the data of the indicated stream after calling processBegin.

◆ put() [1/2]

virtual int put ( Url &  url,
const char *  mime,
const char *  data,
int  len = -1 
)
inlinevirtual

http put

◆ put() [2/2]

virtual int put ( Url &  url,
const char *  mime,
Stream &  data,
int  len = -1 
)
inlinevirtual

http put

◆ read()

virtual int read ( uint8_t *  str,
int  len 
)
inlinevirtual

◆ readBytes()

size_t readBytes ( uint8_t *  str,
size_t  len 
)
inlineoverridevirtual

Implements BaseStream.

◆ readBytesUntil()

size_t readBytesUntil ( char  terminator,
char *  buffer,
size_t  length 
)
inline

◆ readln()

virtual int readln ( uint8_t *  str,
int  len,
bool  incl_nl = true 
)
inlinevirtual

◆ refillReadBuffer()

void refillReadBuffer ( )
inlineprotectedinherited

Refill small read buffer (e.g. 8 bytes) to avoid single byte reads when calling read()

◆ reply()

virtual HttpReplyHeader & reply ( )
inlinevirtual

◆ setAcceptMime()

virtual void setAcceptMime ( const char *  mime)
inlinevirtual

◆ setAcceptsEncoding()

virtual void setAcceptsEncoding ( const char *  enc)
inlinevirtual

◆ setAgent()

virtual void setAgent ( const char *  agent)
inlinevirtual

Defines the agent.

◆ setClient()

void setClient ( Client &  client)
inline

◆ setConnection()

virtual void setConnection ( const char *  connection)
inlinevirtual

◆ setHost()

void setHost ( const char *  host)
inline

◆ setOnConnectCallback()

void setOnConnectCallback ( void(*)(HttpRequest &request, Url &url, HttpRequestHeader &request_header)  callback)
inline

Callback which allows you to add additional paramters dynamically.

◆ setTimeout()

void setTimeout ( size_t  timeoutMs)
inline

Defines the client timeout in ms.

◆ setWriteBufferSize()

void setWriteBufferSize ( int  size)
inlineinherited

◆ stop()

virtual void stop ( )
inlinevirtual

◆ write() [1/2]

size_t write ( const uint8_t *  data,
size_t  len 
)
inlineoverridevirtual

Write data to the client: can be used to post data after calling processBegin

Implements BaseStream.

◆ write() [2/2]

virtual size_t write ( uint8_t  ch)
inlineoverridevirtualinherited

Reimplemented in MemoryStream, AudioStreamWrapper, BufferedTaskStream, RingBufferStream, BufferedStream, and URLStream.

Member Data Documentation

◆ _timeout

int _timeout = 10
protectedinherited

◆ accept

const char* accept = ACCEPT_ALL
protected

◆ accept_encoding

const char* accept_encoding = IDENTITY
protected

◆ agent

const char* agent = nullptr
protected

◆ chunk_reader

HttpChunkReader chunk_reader = HttpChunkReader(reply_header)
protected

◆ client_ptr

Client* client_ptr = nullptr
protected

◆ client_timeout

int client_timeout = URL_CLIENT_TIMEOUT
protected

◆ connection

const char* connection = CON_KEEP_ALIVE
protected

◆ host_name

const char* host_name = nullptr
protected

◆ http_connect_callback

void(* http_connect_callback) (HttpRequest &request, Url &url, HttpRequestHeader &request_header) = nullptr
protected

◆ is_chunked_output_active

bool is_chunked_output_active = false
protected

◆ is_ready

bool is_ready = false
protected

◆ reply_header

HttpReplyHeader reply_header
protected

◆ request_header

HttpRequestHeader request_header
protected

◆ tmp_in

RingBuffer<uint8_t> tmp_in {0}
protectedinherited

◆ tmp_out

RingBuffer<uint8_t> tmp_out {0}
protectedinherited

◆ url

Url url
protected

◆ write_buffer_size

int write_buffer_size = MAX_SINGLE_CHARS
protectedinherited
The documentation for this class was generated from the following file:
Generated by doxygen 1.9.8