WiConnect | Mbed

ACKme » Code » Documentation

Host library for controlling a WiConnect enabled Wi-Fi module.

Dependents: wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more

Embed: (wiki syntax)

FileInterface Class Reference

The provides an interface for creating TCP/UDP/TLS/HTTP client sockets. More...

Inherited by Wiconnect.

Public Member Functions
WiconnectResult	createFile (const ReaderFunc &reader, void user, const char name, uint32_t size, uint32_t version=0, FileType type=FILE_TYPE_ANY, bool isEssential=false, int32_t checksum=-1)
	Create a file on the Wiconnect WiFi module filesystem.
WiconnectResult	openFile (WiconnectFile &file, const char *name)
	Open a file on the Wiconnect WiFi module filesystem for reading.
WiconnectResult	deleteFile (const char *name)
	Delete a file for the Wiconnect WiFi module filesystem.
WiconnectResult	deleteFile (const WiconnectFile &file)
	Delete a file for the Wiconnect WiFi module filesystem.
WiconnectResult	listFiles (FileList &list, const char *name=NULL, FileType type=FILE_TYPE_ANY, uint32_t version=0)
	List the files on the Wiconnect WiFi module filesystem.
Static Public Member Functions
static const char *	fileVersionIntToStr (uint32_t version, bool verbose=true, char *buffer=NULL)
	Convert file version uint32 to string.
static bool	fileVersionStrToInt (const char versionStr, uint32_t versionIntPtr)
	Convert string to file version uint32.
static const char *	fileTypeToStr (FileType type)
	Convert FileType to string.
static const char *	fileFlagsToStr (FileFlags flags, char *buffer=NULL)
	Convert FileFlags to string.

Detailed Description

The provides an interface for creating TCP/UDP/TLS/HTTP client sockets.

A client socket connects to a remote server.

Note:: This class is an interface to the Wiconnect class. It should never be independently instantiated or the parent of another class.

Definition at line 68 of file FileInterface.h.