#include <src/publishers/S3PresignedPublisher.h>

S3PresignedPublisher class

Base classes

class dataPublisher

The dataPublisher class is a virtual class used by other publishers to distribute data online.

Constructors, destructors, conversion operators

S3PresignedPublisher()

Construct a new S3 Publisher object with no members set.

S3PresignedPublisher(Logger& baseLogger, const char* caCertName, String(*)(String) getUrlFxn = nullptr, String(*)(void) getFileNameFxn = nullptr, int sendEveryX = 1)

Construct a new S3 Publisher object.

S3PresignedPublisher(Logger& baseLogger, Client* inClient, String(*)(String) getUrlFxn = nullptr, String(*)(void) getFileNameFxn = nullptr, int sendEveryX = 1)

Construct a new S3 Publisher object.

~S3PresignedPublisher() virtual

Destroy the S3 Publisher object.

Public functions

void setHost(const char* host)

Set the S3 host name.

void setPort(int port)

Set the S3 port.

String getEndpoint(void) -> String override

Get the destination for published data - generally the host name of the data receiver.

void setURLUpdateFunction(String(*)(String) getUrlFxn)

Set function to use to get the new URL.

void setPreSignedURL(String s3Url)

Set the pre-signed S3 url.

void setFileName(String filename)

Set the filename to upload. If the filename is set, this exact filename will be used for the upload.

void setFileParams(const char* extension, const char* filePrefix = nullptr)

Set the filename parameters to use to auto-generate the filename before every post based on the file extension, prefix, and the current date and time.

void setFileUpdateFunction(String(*)(void) getFileNameFxn)

Set function to use to get the new URL.

void setCACertName(const char* caCertName)

Set the name of your certificate authority certificate file.

void begin(Logger& baseLogger, Client* inClient, String(*)(String) getUrlFxn)

Begin the publisher - linking it to the client and logger.

void begin(Logger& baseLogger, String(*)(String) getUrlFxn, const char* caCertName = nullptr)

Begin the publisher - linking it to the logger but not attaching a client.

int16_t publishData(Client* outClient, bool forceFlush = false) -> int16_t override

Utilizes an attached modem to make a TCP connection to the S3 URL and then stream out a get request over that connection.

Protected functions

Client* createClient() -> Client* override

Use the connected base logger's logger modem and underlying TinyGSM instance to create a new client for the publisher.

void deleteClient(Client* client) override

Delete a created client. We need to pass this through to avoid a memory leak because we cannot delete from the pointer because the destructor for a client in the Arduino core isn't virtual.

bool validateS3URL(String& s3url, char* s3host, char* s3resource, char* content_type) -> bool

Parses the S3 URL to validate that it is an un-expired S3 URL and fills the provided buffers with the parsed host, resource name, and content type from the URL.

Protected static variables

static const char* contentLengthHeader

The content length header text.

static const char* contentTypeHeader

The content type header text.

Protected variables

const char* s3_parent_host

The host name.

int s3Port

The host port.

String(* _getUrlFxn

Private reference to function used fetch a new S3 URL.

String _PreSignedURL

A pointer to the current S3 pre-signed URL.

String _filename

The name of the file you want to upload to S3.

const char* _filePrefix

The prefix to add to files, if generating a filename based on the date/time.

const char* _fileExtension

The extension to add to files, if generating a filename based on the date/time.

String(* _getFileNameFxn

Private reference to function used fetch a new file name.

const char* _caCertName

The name of your certificate authority certificate file.

File putFile

An internal reference to an SdFat file instance.

Function documentation

Variable documentation