#include "httpd_opts.h"
#include "lwip/err.h"

Include dependency graph for fs.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	fs_file

struct	fsdata_file

Macros
#define	FS_READ_EOF -1

#define	FS_READ_DELAYED -2

#define	FS_FILE_FLAGS_HEADER_INCLUDED 0x01

#define	FS_FILE_FLAGS_HEADER_PERSISTENT 0x02

#define	FS_FILE_FLAGS_HEADER_HTTPVER_1_1 0x04

#define	FS_FILE_FLAGS_SSI 0x08

#define	FS_FILE_FLAGS_CUSTOM 0x10

Typedefs
typedef void	fs_file_extension

Functions
err_t	fs_open (struct fs_file file, const char name)

void	fs_close (struct fs_file *file)

int	fs_bytes_left (struct fs_file *file)

Macro Definition Documentation

◆ FS_FILE_FLAGS_CUSTOM

#define FS_FILE_FLAGS_CUSTOM 0x10

Definition at line 57 of file fs.h.

◆ FS_FILE_FLAGS_HEADER_HTTPVER_1_1

#define FS_FILE_FLAGS_HEADER_HTTPVER_1_1 0x04

Definition at line 55 of file fs.h.

◆ FS_FILE_FLAGS_HEADER_INCLUDED

#define FS_FILE_FLAGS_HEADER_INCLUDED 0x01

Definition at line 53 of file fs.h.

◆ FS_FILE_FLAGS_HEADER_PERSISTENT

#define FS_FILE_FLAGS_HEADER_PERSISTENT 0x02

Definition at line 54 of file fs.h.

◆ FS_FILE_FLAGS_SSI

#define FS_FILE_FLAGS_SSI 0x08

Definition at line 56 of file fs.h.

◆ FS_READ_DELAYED

#define FS_READ_DELAYED -2

Definition at line 43 of file fs.h.

◆ FS_READ_EOF

#define FS_READ_EOF -1

Definition at line 42 of file fs.h.

Typedef Documentation

◆ fs_file_extension

typedef void fs_file_extension

Define FS_FILE_EXTENSION_T_DEFINED if you have typedef'ed to your private pointer type (defaults to 'void' so the default usage is 'void*')

Definition at line 63 of file fs.h.

Function Documentation

◆ fs_bytes_left()

int fs_bytes_left ( struct fs_file * file )

Definition at line 158 of file fs.c.

{
  return file->len - file->index;
}

◆ fs_close()

void fs_close ( struct fs_file * file )

Definition at line 83 of file fs.c.

{
#if LWIP_HTTPD_CUSTOM_FILES
  if ((file->flags & FS_FILE_FLAGS_CUSTOM) != 0) {
    fs_close_custom(file);
  }
#endif /* LWIP_HTTPD_CUSTOM_FILES */
#if LWIP_HTTPD_FILE_STATE
  fs_state_free(file, file->state);
#endif /* #if LWIP_HTTPD_FILE_STATE */
  LWIP_UNUSED_ARG(file);
}

Referenced by VfatChkdsk().

◆ fs_open()

err_t fs_open	(	struct fs_file *	file,
		const char *	name
	)

Definition at line 43 of file fs.c.

{
  const struct fsdata_file *f;
 
  if ((file == NULL) || (name == NULL)) {
    return ERR_ARG;
  }
 
#if LWIP_HTTPD_CUSTOM_FILES
  if (fs_open_custom(file, name)) {
    file->flags |= FS_FILE_FLAGS_CUSTOM;
    return ERR_OK;
  }
#endif /* LWIP_HTTPD_CUSTOM_FILES */
 
  for (f = FS_ROOT; f != NULL; f = f->next) {
    if (!strcmp(name, (const char *)f->name)) {
      file->data = (const char *)f->data;
      file->len = f->len;
      file->index = f->len;
      file->flags = f->flags;
#if HTTPD_PRECALCULATED_CHECKSUM
      file->chksum_count = f->chksum_count;
      file->chksum = f->chksum;
#endif /* HTTPD_PRECALCULATED_CHECKSUM */
#if LWIP_HTTPD_FILE_EXTENSION
      file->pextension = NULL;
#endif /* LWIP_HTTPD_FILE_EXTENSION */
#if LWIP_HTTPD_FILE_STATE
      file->state = fs_state_init(file, name);
#endif /* #if LWIP_HTTPD_FILE_STATE */
      return ERR_OK;
    }
  }
  /* file not found */
  return ERR_VAL;
}