KARadioProtocolServer Class Reference

KA-Radio Protocol Server which provides the KARadioProtocol over http to control the audio player provided by the audiotools. More...

#include <KARadioProtocolServer.h>

Inheritance diagram for KARadioProtocolServer:

Public Member Functions
	KARadioProtocolServer ()=default
	Empty constructor: call setPlayer to define the player.
	KARadioProtocolServer (AudioPlayer &player, int port=80, const char *ssid=nullptr, const char *pwd=nullptr)
	Default constructor.
bool	begin ()
void	copy ()
void	loop ()
void	setBufferSize (int size)
	Defines the buffer size that is made available for the http reply.
void	setPassword (const char *password)
void	setPlayer (AudioPlayer &player)
	Defines the player.
void	setPort (int port)
void	setProtocol (AudioPlayerProtocol &protocol)
void	setSSID (const char *ssid)
void	setSSID (const char *ssid, const char *password)

Static Protected Member Functions
static void	parse (HttpServer *server, const char *requestPath, HttpRequestHandlerLine *hl)

Protected Attributes
int	buffer_size = 512
Vector< void * >	context {1}
AudioPlayerProtocol *	p_protocol
const char *	password = nullptr
int	port = 80
KARadioProtocol	protocol
QueueStream< uint8_t >	queueStream {ringBuffer}
RingBuffer< uint8_t >	ringBuffer {0}
HttpServer	server {wifi}
const char *	ssid = nullptr
WiFiServer	wifi

Detailed Description

KA-Radio Protocol Server which provides the KARadioProtocol over http to control the audio player provided by the audiotools.

Author

Phil Schatzmann

Constructor & Destructor Documentation

KARadioProtocolServer() [1/2]

KARadioProtocolServer ( AudioPlayer &  player, int  port = 80, const char *  ssid = nullptr, const char *  pwd = nullptr  )

inline

Default constructor.

KARadioProtocolServer() [2/2]

KARadioProtocolServer ( )

default

Empty constructor: call setPlayer to define the player.

Member Function Documentation

begin()

bool begin ( )

inlineinherited

copy()

void copy ( )

inlineinherited

loop()

void loop ( )

inlineinherited

parse()

static void parse ( HttpServer *  server, const char *  requestPath, HttpRequestHandlerLine *  hl  )

inlinestaticprotectedinherited

setBufferSize()

void setBufferSize ( int  size )

inlineinherited

Defines the buffer size that is made available for the http reply.

setPassword()

void setPassword ( const char *  password )

inlineinherited

setPlayer()

void setPlayer ( AudioPlayer &  player )

inlineinherited

Defines the player.

setPort()

void setPort ( int  port )

inlineinherited

setProtocol()

void setProtocol ( AudioPlayerProtocol &  protocol )

inlineinherited

setSSID() [1/2]

void setSSID ( const char *  ssid )

inlineinherited

setSSID() [2/2]

void setSSID ( const char *  ssid, const char *  password  )

inlineinherited

Member Data Documentation

buffer_size

int buffer_size = 512

protectedinherited

context

Vector<void*> context {1}

protectedinherited

p_protocol

AudioPlayerProtocol* p_protocol

protectedinherited

password

const char* password = nullptr

protectedinherited

port

int port = 80

protectedinherited

protocol

KARadioProtocol protocol

protected

queueStream

QueueStream<uint8_t> queueStream {ringBuffer}

protectedinherited

ringBuffer

RingBuffer<uint8_t> ringBuffer {0}

protectedinherited

server

HttpServer server {wifi}

protectedinherited

ssid

const char* ssid = nullptr

protectedinherited

wifi

WiFiServer wifi

protectedinherited

---

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

• src/AudioTools/Communication/AudioPlayer/KARadioProtocolServer.h