Matthew Sims / mbed_tictactoe

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   TicTacToe

Fork of mbed by -deleted-

Embed: (wiki syntax)

« Back to documentation index

FileSystemLike Class Reference
Public Member Functions | Static Public Member Functions

FileSystemLike Class Reference

A filesystem-like object is one that can be used to open files though it by fopen("/name/filename", mode) More...

#include <FileSystemLike.h>

Inherits mbed::Base.

Inherited by LocalFileSystem.

Public Member Functions

 FileSystemLike (const char *name)
 FileSystemLike constructor.
virtual FileHandle * open (const char *filename, int flags)=0
 Opens a file from the filesystem.
virtual int remove (const char *filename)
 Remove a file from the filesystem.
virtual int rename (const char *oldname, const char *newname)
 Rename a file in the filesystem.
virtual DirHandle * opendir (const char *name)
 Opens a directory in the filesystem and returns a DirHandle representing the directory stream.
virtual int mkdir (const char *name, mode_t mode)
 Creates a directory in the filesystem.
void register_object (const char *name)
 Registers this object with the given name, so that it can be looked up with lookup.
const char * name ()
 Returns the name of the object.
virtual bool rpc (const char *method, const char *arguments, char *result)
 Call the given method with the given arguments, and write the result into the string pointed to by result.
virtual struct rpc_method * get_rpc_methods ()
 Returns a pointer to an array describing the rpc methods supported by this object, terminated by either RPC_METHOD_END or RPC_METHOD_SUPER(Superclass).

Static Public Member Functions

static bool rpc (const char *name, const char *method, const char *arguments, char *result)
 Use the lookup function to lookup an object and, if successful, call its rpc method.
static Base * lookup (const char *name, unsigned int len)
 Lookup and return the object that has the given name.
template<class C >
static void add_rpc_class ()
 Add the class to the list of classes which can have static methods called via rpc (the static methods which can be called are defined by that class' get_rpc_class() static method).

Detailed Description

A filesystem-like object is one that can be used to open files though it by fopen("/name/filename", mode)

Implementations must define at least open (the default definitions of the rest of the functions just return error values).

Definition at line 31 of file FileSystemLike.h.

Constructor & Destructor Documentation

FileSystemLike ( const char *  name )

FileSystemLike constructor.

Parameters:
nameThe name to use for the filesystem.

Definition at line 39 of file FileSystemLike.h.

Member Function Documentation

static void add_rpc_class (  ) [static, inherited]

Add the class to the list of classes which can have static methods called via rpc (the static methods which can be called are defined by that class' get_rpc_class() static method).

Definition at line 143 of file Base.h.

virtual struct rpc_method* get_rpc_methods (  ) [read, virtual, inherited]

Returns a pointer to an array describing the rpc methods supported by this object, terminated by either RPC_METHOD_END or RPC_METHOD_SUPER(Superclass).

Example 

 class Example : public Base {
     int foo(int a, int b) { return a + b; }
     virtual const struct rpc_method *get_rpc_methods() {
         static const rpc_method rpc_methods[] = {
             { "foo", generic_caller<int, Example, int, int, &Example::foo> },
             RPC_METHOD_SUPER(Base)
         };
         return rpc_methods;
     }
 };

Reimplemented in AnalogIn, AnalogOut, BusIn, BusInOut, BusOut, DigitalIn, DigitalInOut, DigitalOut, PwmOut, Serial, SPI, and Timer.

static Base* lookup ( const char *  name,
unsigned int  len 
) [static, inherited]

Lookup and return the object that has the given name.

Parameters:
namethe name to lookup.
lenthe length of name.
virtual int mkdir ( const char *  name,
mode_t  mode 
) [virtual]

Creates a directory in the filesystem.

Parameters:
nameThe name of the directory to create.
modeThe permissions to create the directory with.
Returns:
0 on success, -1 on failure.

Definition at line 91 of file FileSystemLike.h.

const char* name (  ) [inherited]

Returns the name of the object.

Returns:
The name of the object, or NULL if it has no name.
virtual FileHandle* open ( const char *  filename,
int  flags 
) [pure virtual]

Opens a file from the filesystem.

Parameters:
filenameThe name of the file to open.
flagsOne of O_RDONLY, O_WRONLY, or O_RDWR, OR'd with zero or more of O_CREAT, O_TRUNC, or O_APPEND.
Returns:
A pointer to a FileHandle object representing the file on success, or NULL on failure.

Implemented in LocalFileSystem.

virtual DirHandle* opendir ( const char *  name ) [virtual]

Opens a directory in the filesystem and returns a DirHandle representing the directory stream.

Parameters:
nameThe name of the directory to open.
Returns:
A DirHandle representing the directory stream, or NULL on failure.

Reimplemented in LocalFileSystem.

Definition at line 80 of file FileSystemLike.h.

void register_object ( const char *  name ) [inherited]

Registers this object with the given name, so that it can be looked up with lookup.

If this object has already been registered, then this just changes the name.

Parameters:
nameThe name to give the object. If NULL we do nothing.
virtual int remove ( const char *  filename ) [virtual]

Remove a file from the filesystem.

Parameters:
filenamethe name of the file to remove.
returns0 on success, -1 on failure.

Reimplemented in LocalFileSystem.

Definition at line 58 of file FileSystemLike.h.

virtual int rename ( const char *  oldname,
const char *  newname 
) [virtual]

Rename a file in the filesystem.

Parameters:
oldnamethe name of the file to rename.
newnamethe name to rename it to.
Returns:
0 on success, -1 on failure.

Definition at line 69 of file FileSystemLike.h.

virtual bool rpc ( const char *  method,
const char *  arguments,
char *  result 
) [virtual, inherited]

Call the given method with the given arguments, and write the result into the string pointed to by result.

The default implementation calls rpc_methods to determine the supported methods.

Parameters:
methodThe name of the method to call.
argumentsA list of arguments separated by spaces.
resultA pointer to a string to write the result into. May be NULL, in which case nothing is written.
Returns:
true if method corresponds to a valid rpc method, or false otherwise.
static bool rpc ( const char *  name,
const char *  method,
const char *  arguments,
char *  result 
) [static, inherited]

Use the lookup function to lookup an object and, if successful, call its rpc method.

Returns:
false if name does not correspond to an object, otherwise the return value of the call to the object's rpc method.
Generated on Wed Jul 13 2022 03:42:27 by  doxygen 1.7.2