ImageDownloadDDTunnel Class Reference

Image download tool "tunnel" created with DumbDisplay::createImageDownloadTunnel() More...

#include <dumbdisplay.h>

Inheritance diagram for ImageDownloadDDTunnel:

Public Member Functions
	ImageDownloadDDTunnel (int8_t tunnelId, const String &params, const String &endPoint, int bufferSize)
void	reconnectTo (const String &endPoint, const String &cropUIConfig="")
Public Member Functions inherited from SimpleToolDDTunnel
	SimpleToolDDTunnel (const String &type, int8_t tunnelId, const String &params, const String &endPoint, int bufferSize)
int	checkResult ()
Public Member Functions inherited from DDBufferedTunnel
	DDBufferedTunnel (const String &type, int8_t tunnelId, const String &params, const String &endPoint, int8_t bufferSize)
	for internal use only
virtual void	release () override
void	reconnect ()
virtual void	handleInput (const String &data, uint8_t *fbBytes, bool final) override
bool	pending ()
int	count ()
	count buffer ready read
bool	eof (long timeoutMillis=DD_DEF_TUNNEL_TIMEOUT)
bool	timedOut ()
	check whether EOF caused by timeout or not; note that timeout is only due to check of EOF with DDBufferedTunnel::eof() with timeoutMillis set
String	readLine ()
	read a line from buffer
bool	readLine (String &buffer)
	read a line from buffer, in to the buffer passed in
void	writeLine (const String &data)
	write a line
bool	read (String &fieldId, String &fieldValue)
	read a piece of JSON data
Public Member Functions inherited from DDTunnel
	DDTunnel (const String &type, int8_t tunnelId, const String &params, const String &endPoint)
	for internal use only
void	afterConstruct (bool connectNow)
const String &	getEndpoint ()
virtual void	release ()
const String &	getTunnelId () const
void	reconnectTo (const String &endPoint)
void	reconnectToEndpoint (const DDTunnelEndpoint endpoint)
	reconnect to specified endpoint. See DDTunnelEndpoint.
virtual void	handleInput (const String &data, uint8_t *fbBytes, bool final)

Additional Inherited Members
Public Attributes inherited from DDObject
int8_t	objectType
	object type – DD_OBJECT_TYPE_LAYER or DD_OBJECT_TYPE_TUNNEL
String	customData
	custom data
Protected Member Functions inherited from SimpleToolDDTunnel
virtual void	_reconnect (const String &extraParams="") override
Protected Member Functions inherited from DDBufferedTunnel
virtual void	_reconnect (const String &extraParams="") override
int	_count ()
virtual bool	_eof (long timeoutMillis) override
bool	_readLine (String &buffer, uint8_t **pFBBytes=NULL)
Protected Member Functions inherited from DDTunnel
virtual void	_reconnect (const String &extraParams="")
void	_reconnectTo (const String &endPoint, const String &extraParams="")
bool	_pending ()
bool	_timedOut ()
virtual bool	_eof (long timeoutMillis)
void	_writeLine (const String &data)
void	_writeSound (const String &soundName)
void	doneHandleInput (bool final)
Protected Attributes inherited from DDTunnel
String	type
String	tunnelId
String	endPoint
String	headers
String	attachmentId
String	params
unsigned long	connectMillis

Detailed Description

Image download tool "tunnel" created with DumbDisplay::createImageDownloadTunnel()

Constructor & Destructor Documentation

ImageDownloadDDTunnel()

ImageDownloadDDTunnel::ImageDownloadDDTunnel ( int8_t  tunnelId, const String &  params, const String &  endPoint, int  bufferSize  )

inline

Attention

constructed via DumbDisplay object

Member Function Documentation

reconnectTo()

void ImageDownloadDDTunnel::reconnectTo	(	const String &	endPoint,
		const String &	cropUIConfig = ""
	)

Parameters

cropUIConfig

if not empty, enable crop UI after the download, and the config can be like "120x240"